diff --git a/bin/sandbox-dotnet b/bin/sandbox-dotnet index 6ccea44b3..c74759887 100755 --- a/bin/sandbox-dotnet +++ b/bin/sandbox-dotnet @@ -10,8 +10,9 @@ TARGET_DIR="${DIR}/../sandbox/dotnet" ARTIFACTS_DIR="${DIR}/../sandbox/dotnet/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.nupkg" +rm -f "${TARGET_DIR}/src/Dropbox.SignSandbox/*.cs" +cp "${SDK_DIR}/templates/Entry.cs" "${TARGET_DIR}/src/Dropbox.SignSandbox/Entry.cs" docker run --rm -it \ -v "${SDK_DIR}:${WORKING_DIR}" \ @@ -19,10 +20,10 @@ docker run --rm -it \ -v "${TARGET_DIR}:/target" \ -w "${WORKING_DIR}" \ -u root:root \ - mcr.microsoft.com/dotnet/sdk:6.0 dotnet pack -o /artifacts + mcr.microsoft.com/dotnet/sdk:9.0 dotnet pack -o /artifacts docker run --rm -it \ -v "${TARGET_DIR}:${WORKING_DIR}" \ -w "${WORKING_DIR}" \ -u root:root \ - mcr.microsoft.com/dotnet/sdk:6.0 dotnet build + mcr.microsoft.com/dotnet/sdk:9.0 dotnet build diff --git a/bin/sandbox-java b/bin/sandbox-java new file mode 100755 index 000000000..6f86eb5ac --- /dev/null +++ b/bin/sandbox-java @@ -0,0 +1,26 @@ +#!/usr/bin/env bash + +set -e + +DIR=$(cd `dirname $0` && pwd) + +WORKING_DIR="/app/openapi" +SDK_DIR="${DIR}/../sdks/java-v2" +TARGET_DIR="${DIR}/../sandbox/java" +ARTIFACTS_DIR="${DIR}/../sandbox/java/artifacts" + +mkdir -p "${ARTIFACTS_DIR}" +rm -f "${ARTIFACTS_DIR}/*.jar" +rm -f "${TARGET_DIR}/src/main/java/com/dropbox/sign_sandbox/*.java" +cp "${SDK_DIR}/templates/Main.java" "${TARGET_DIR}/src/main/java/com/dropbox/sign_sandbox/Main.java" + +docker run --rm -it \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-gradle-cache:/home/gradle/.gradle" \ + -v "dropbox-sign-sdk-maven-cache:/root/.m2" \ + -w "${WORKING_DIR}" \ + -e GEN_DIR=/app \ + gradle:7.6.1-jdk11 ./gradlew clean fatJar + +cp "${SDK_DIR}/build/libs/"dropbox-sign-*-all.jar "${ARTIFACTS_DIR}/dropbox-sign.jar" diff --git a/bin/sandbox-java-v1 b/bin/sandbox-java-v1 deleted file mode 100755 index 15bd9ad06..000000000 --- a/bin/sandbox-java-v1 +++ /dev/null @@ -1,25 +0,0 @@ -#!/usr/bin/env bash - -set -e - -DIR=$(cd `dirname $0` && pwd) - -WORKING_DIR="/app/openapi" -SDK_DIR="${DIR}/../sdks/java-v1" -TARGET_DIR="${DIR}/../sandbox/java-v1" -ARTIFACTS_DIR="${DIR}/../sandbox/java-v1/artifacts" - -mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* - -docker run --rm -it \ - -v "${SDK_DIR}:${WORKING_DIR}" \ - -v "${ARTIFACTS_DIR}:/artifacts" \ - -v "dropbox-sign-sdk-gradle-cache:/home/gradle/.gradle" \ - -v "dropbox-sign-sdk-maven-cache:/root/.m2" \ - -w "${WORKING_DIR}" \ - -e GEN_DIR=/app \ - gradle:7.6.1-jdk11 ./gradlew clean fatJar - -cp "${SDK_DIR}/build/libs/"dropbox-sign-*-all.jar "${ARTIFACTS_DIR}/dropbox-sign.jar" diff --git a/bin/sandbox-java-v2 b/bin/sandbox-java-v2 deleted file mode 100755 index 9349f5d0c..000000000 --- a/bin/sandbox-java-v2 +++ /dev/null @@ -1,25 +0,0 @@ -#!/usr/bin/env bash - -set -e - -DIR=$(cd `dirname $0` && pwd) - -WORKING_DIR="/app/openapi" -SDK_DIR="${DIR}/../sdks/java-v2" -TARGET_DIR="${DIR}/../sandbox/java-v2" -ARTIFACTS_DIR="${DIR}/../sandbox/java-v2/artifacts" - -mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* - -docker run --rm -it \ - -v "${SDK_DIR}:${WORKING_DIR}" \ - -v "${ARTIFACTS_DIR}:/artifacts" \ - -v "dropbox-sign-sdk-gradle-cache:/home/gradle/.gradle" \ - -v "dropbox-sign-sdk-maven-cache:/root/.m2" \ - -w "${WORKING_DIR}" \ - -e GEN_DIR=/app \ - gradle:7.6.1-jdk11 ./gradlew clean fatJar - -cp "${SDK_DIR}/build/libs/"dropbox-sign-*-all.jar "${ARTIFACTS_DIR}/dropbox-sign.jar" diff --git a/bin/sandbox-node b/bin/sandbox-node index d8d68d366..60da86c08 100755 --- a/bin/sandbox-node +++ b/bin/sandbox-node @@ -10,8 +10,9 @@ TARGET_DIR="${DIR}/../sandbox/node" ARTIFACTS_DIR="${DIR}/../sandbox/node/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -f "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.tgz" +rm -f "${TARGET_DIR}/src/*.ts" +rm -f "${TARGET_DIR}/src/*.js" rm -f "${TARGET_DIR}/package-lock.json" rm -rf "${TARGET_DIR}/node_modules" @@ -20,15 +21,20 @@ docker run -it --rm \ -v "${ARTIFACTS_DIR}:/artifacts" \ -v "dropbox-sign-sdk-npm-cache:/root/.npm" \ -w "${WORKING_DIR}" \ - node:17 npm pack --pack-destination /artifacts + node:22 npm install -mv "${ARTIFACTS_DIR}/"*.tgz "${ARTIFACTS_DIR}/dropbox-sign-sdk.tgz" +docker run -it --rm \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-npm-cache:/root/.npm" \ + -w "${WORKING_DIR}" \ + node:22 npm run build docker run -it --rm \ - -v "${TARGET_DIR}:${WORKING_DIR}" \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ -v "dropbox-sign-sdk-npm-cache:/root/.npm" \ -w "${WORKING_DIR}" \ - node:17 npm install + node:22 npm pack --pack-destination /artifacts -printf "\nDONE! Run with:\n\n" -printf "\tnpx ts-node Example.ts" +mv "${ARTIFACTS_DIR}/"*.tgz "${ARTIFACTS_DIR}/dropbox-sign-sdk.tgz" diff --git a/bin/sandbox-php b/bin/sandbox-php index 1479a674f..261f767b9 100755 --- a/bin/sandbox-php +++ b/bin/sandbox-php @@ -10,10 +10,9 @@ TARGET_DIR="${DIR}/../sandbox/php" ARTIFACTS_DIR="${DIR}/../sandbox/php/artifacts" mkdir -p "${ARTIFACTS_DIR}" - -rm -rf "${ARTIFACTS_DIR}/"* +rm -f "${ARTIFACTS_DIR}/*.zip" rm -f "${TARGET_DIR}/composer.lock" -rm -rf "${TARGET_DIR}/vendor/hellosign" +rm -rf "${TARGET_DIR}/vendor" cp -r "${SDK_DIR}" "${ARTIFACTS_DIR}/package" cd "${ARTIFACTS_DIR}/package" @@ -41,13 +40,6 @@ zip -9 -r "${ARTIFACTS_DIR}/dropbox-sign.zip" \ "./test/*" \ "./vendor/*" -docker run -it --rm \ - -v "${TARGET_DIR}:${WORKING_DIR}" \ - -v "dropbox-sign-sdk-composer-cache:/.composer" \ - -w "${WORKING_DIR}" \ - -u root:root \ - jtreminio/php-cli:7.4 composer install - cd "${ARTIFACTS_DIR}" rm -rf "${ARTIFACTS_DIR}/package" diff --git a/bin/sandbox-ruby b/bin/sandbox-ruby new file mode 100755 index 000000000..8abb45aa6 --- /dev/null +++ b/bin/sandbox-ruby @@ -0,0 +1,32 @@ +#!/usr/bin/env bash + +set -e + +DIR=$(cd `dirname $0` && pwd) + +WORKING_DIR="/app/openapi" +SDK_DIR="${DIR}/../sdks/ruby" +TARGET_DIR="${DIR}/../sandbox/ruby" +ARTIFACTS_DIR="${DIR}/../sandbox/ruby/artifacts" + +rm -rf "${ARTIFACTS_DIR}" +mkdir -p "${ARTIFACTS_DIR}/gems" + +docker run --rm \ + -e GEM_HOME="/.gem-cache" \ + -e BUNDLE_PATH="/.bundle-cache" \ + -v "${SDK_DIR}:${WORKING_DIR}" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-gem-cache:/.gem-cache" \ + -v "dropbox-sign-sdk-bundle-cache:/.bundle-cache" \ + -w "${WORKING_DIR}" \ + ruby:3.4 gem build dropbox-sign.gemspec -o /artifacts/gems/dropbox-sign.gem + +docker run --rm \ + -e GEM_HOME="/.gem-cache" \ + -e BUNDLE_PATH="/.bundle-cache" \ + -v "${ARTIFACTS_DIR}:/artifacts" \ + -v "dropbox-sign-sdk-gem-cache:/.gem-cache" \ + -v "dropbox-sign-sdk-bundle-cache:/.bundle-cache" \ + -w "/artifacts" \ + ruby:3.4 gem generate_index diff --git a/build b/build index 2ef773ff6..f706758a2 100755 --- a/build +++ b/build @@ -14,4 +14,11 @@ printf "\n" bash "${DIR}/bin/php" ./bin/generate-oas.php +cp "${DIR}/examples/"*.cs "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox/" +cp "${DIR}/examples/"*.java "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox/" +cp "${DIR}/examples/"*.php "${DIR}/sandbox/php/src/" +cp "${DIR}/examples/"*.py "${DIR}/sandbox/python/src/" +cp "${DIR}/examples/"*.rb "${DIR}/sandbox/ruby/src/" +cp "${DIR}/examples/"*.ts "${DIR}/sandbox/node/src/" + printf "Success!\n" diff --git a/examples/AccountCreate.cs b/examples/AccountCreate.cs deleted file mode 100644 index 360f7751f..000000000 --- a/examples/AccountCreate.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountCreateRequest( - emailAddress: "newuser@dropboxsign.com" - ); - - try - { - var result = accountApi.AccountCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/AccountCreate.java b/examples/AccountCreate.java deleted file mode 100644 index 6063411c0..000000000 --- a/examples/AccountCreate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountCreate.js b/examples/AccountCreate.js deleted file mode 100644 index 3aed64809..000000000 --- a/examples/AccountCreate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountCreate.php b/examples/AccountCreate.php deleted file mode 100644 index 73176d1e2..000000000 --- a/examples/AccountCreate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); - -try { - $result = $accountApi->accountCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountCreate.py b/examples/AccountCreate.py deleted file mode 100644 index 6bdaebb21..000000000 --- a/examples/AccountCreate.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( - email_address="newuser@dropboxsign.com", - ) - - try: - response = account_api.account_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/AccountCreate.rb b/examples/AccountCreate.rb deleted file mode 100644 index b572ae10c..000000000 --- a/examples/AccountCreate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" - -begin - result = account_api.account_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountCreate.ts b/examples/AccountCreate.ts deleted file mode 100644 index 2819e3db8..000000000 --- a/examples/AccountCreate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountCreateRequest = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountCreateExample.cs b/examples/AccountCreateExample.cs new file mode 100644 index 000000000..373d6a20f --- /dev/null +++ b/examples/AccountCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountCreateExample.java b/examples/AccountCreateExample.java new file mode 100644 index 000000000..a9b8c52d2 --- /dev/null +++ b/examples/AccountCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountCreateExample.php b/examples/AccountCreateExample.php new file mode 100644 index 000000000..736fb3cc6 --- /dev/null +++ b/examples/AccountCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/examples/AccountCreateExample.py b/examples/AccountCreateExample.py new file mode 100644 index 000000000..f911a898b --- /dev/null +++ b/examples/AccountCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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) diff --git a/examples/AccountCreateExample.rb b/examples/AccountCreateExample.rb new file mode 100644 index 000000000..6ce6db264 --- /dev/null +++ b/examples/AccountCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" + +begin + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_create: #{e}" +end diff --git a/examples/AccountCreate.sh b/examples/AccountCreateExample.sh similarity index 100% rename from examples/AccountCreate.sh rename to examples/AccountCreateExample.sh diff --git a/examples/AccountCreateExample.ts b/examples/AccountCreateExample.ts new file mode 100644 index 000000000..f5b490085 --- /dev/null +++ b/examples/AccountCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/examples/AccountCreateOauthExample.cs b/examples/AccountCreateOauthExample.cs new file mode 100644 index 000000000..1976cb18e --- /dev/null +++ b/examples/AccountCreateOauthExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateOauthExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com", + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountCreateOauthExample.java b/examples/AccountCreateOauthExample.java new file mode 100644 index 000000000..5cfc13531 --- /dev/null +++ b/examples/AccountCreateOauthExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateOauthExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + accountCreateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + accountCreateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountCreateOauthExample.php b/examples/AccountCreateOauthExample.php new file mode 100644 index 000000000..0c4898be2 --- /dev/null +++ b/examples/AccountCreateOauthExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com") + ->setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/examples/AccountCreateOauthExample.py b/examples/AccountCreateOauthExample.py new file mode 100644 index 000000000..8930f04d6 --- /dev/null +++ b/examples/AccountCreateOauthExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + account_create_request = models.AccountCreateRequest( + email_address="newuser@dropboxsign.com", + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + ) + + try: + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_create: %s\n" % e) diff --git a/examples/AccountCreateOauthExample.rb b/examples/AccountCreateOauthExample.rb new file mode 100644 index 000000000..26ebdc768 --- /dev/null +++ b/examples/AccountCreateOauthExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" +account_create_request.client_id = "cc91c61d00f8bb2ece1428035716b" +account_create_request.client_secret = "1d14434088507ffa390e6f5528465" + +begin + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_create: #{e}" +end diff --git a/examples/AccountCreateOauthExample.ts b/examples/AccountCreateOauthExample.ts new file mode 100644 index 000000000..0554d4d79 --- /dev/null +++ b/examples/AccountCreateOauthExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; +accountCreateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +accountCreateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/examples/AccountGet.cs b/examples/AccountGet.cs deleted file mode 100644 index e6e35af25..000000000 --- a/examples/AccountGet.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - try - { - var result = accountApi.AccountGet(null, "jack@example.com"); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/AccountGet.java b/examples/AccountGet.java deleted file mode 100644 index e05f3ff12..000000000 --- a/examples/AccountGet.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - try { - AccountGetResponse result = accountApi.accountGet(null, "jack@example.com"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountGet.js b/examples/AccountGet.js deleted file mode 100644 index 00d03af5c..000000000 --- a/examples/AccountGet.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = accountApi.accountGet(undefined, "jack@example.com"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountGet.php b/examples/AccountGet.php deleted file mode 100644 index 25ac7fb65..000000000 --- a/examples/AccountGet.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -try { - $result = $accountApi->accountGet(null, 'jack@example.com'); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountGet.py b/examples/AccountGet.py deleted file mode 100644 index 659cb62bf..000000000 --- a/examples/AccountGet.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - try: - response = account_api.account_get(email_address="jack@example.com") - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/AccountGet.rb b/examples/AccountGet.rb deleted file mode 100644 index 426fcb67e..000000000 --- a/examples/AccountGet.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -begin - result = account_api.account_get({ email_address: "jack@example.com" }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountGet.ts b/examples/AccountGet.ts deleted file mode 100644 index 00d03af5c..000000000 --- a/examples/AccountGet.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = accountApi.accountGet(undefined, "jack@example.com"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountGetExample.cs b/examples/AccountGetExample.cs new file mode 100644 index 000000000..83d94716e --- /dev/null +++ b/examples/AccountGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new AccountApi(config).AccountGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountGetExample.java b/examples/AccountGetExample.java new file mode 100644 index 000000000..3a90b0375 --- /dev/null +++ b/examples/AccountGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountGetExample.php b/examples/AccountGetExample.php new file mode 100644 index 000000000..96b594d7e --- /dev/null +++ b/examples/AccountGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}"; +} diff --git a/examples/AccountGetExample.py b/examples/AccountGetExample.py new file mode 100644 index 000000000..d7e910dd6 --- /dev/null +++ b/examples/AccountGetExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.AccountApi(api_client).account_get() + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_get: %s\n" % e) diff --git a/examples/AccountGetExample.rb b/examples/AccountGetExample.rb new file mode 100644 index 000000000..3b8fb5d9e --- /dev/null +++ b/examples/AccountGetExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::AccountApi.new.account_get + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_get: #{e}" +end diff --git a/examples/AccountGet.sh b/examples/AccountGetExample.sh similarity index 100% rename from examples/AccountGet.sh rename to examples/AccountGetExample.sh diff --git a/examples/AccountGetExample.ts b/examples/AccountGetExample.ts new file mode 100644 index 000000000..6bc7ae2de --- /dev/null +++ b/examples/AccountGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.accountGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountGet:"); + console.log(error.body); +}); diff --git a/examples/AccountUpdate.cs b/examples/AccountUpdate.cs deleted file mode 100644 index 2261b47f2..000000000 --- a/examples/AccountUpdate.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountUpdateRequest( - callbackUrl: "https://www.example.com/callback" - ); - - try - { - var result = accountApi.AccountUpdate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/AccountUpdate.java b/examples/AccountUpdate.java deleted file mode 100644 index 9b8d374c1..000000000 --- a/examples/AccountUpdate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountUpdateRequest() - .callbackUrl("https://www.example.com/callback"); - - try { - AccountGetResponse result = accountApi.accountUpdate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountUpdate.js b/examples/AccountUpdate.js deleted file mode 100644 index 0d48a5917..000000000 --- a/examples/AccountUpdate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - callbackUrl: "https://www.example.com/callback", -}; - -const result = accountApi.accountUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountUpdate.php b/examples/AccountUpdate.php deleted file mode 100644 index b94dae236..000000000 --- a/examples/AccountUpdate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountUpdateRequest(); -$data->setCallbackUrl("https://www.example.com/callback"); - -try { - $result = $accountApi->accountUpdate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountUpdate.py b/examples/AccountUpdate.py deleted file mode 100644 index d1cf4a496..000000000 --- a/examples/AccountUpdate.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountUpdateRequest( - callback_url="https://www.example.com/callback", - ) - - try: - response = account_api.account_update(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/AccountUpdate.rb b/examples/AccountUpdate.rb deleted file mode 100644 index 55b127bcb..000000000 --- a/examples/AccountUpdate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountUpdateRequest.new -data.callback_url = "https://www.example.com/callback" - -begin - result = account_api.account_update(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountUpdate.ts b/examples/AccountUpdate.ts deleted file mode 100644 index c76ac1d21..000000000 --- a/examples/AccountUpdate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountUpdateRequest = { - callbackUrl: "https://www.example.com/callback", -}; - -const result = accountApi.accountUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountUpdateExample.cs b/examples/AccountUpdateExample.cs new file mode 100644 index 000000000..f62bb1125 --- /dev/null +++ b/examples/AccountUpdateExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountUpdateRequest = new AccountUpdateRequest( + callbackUrl: "https://www.example.com/callback", + locale: "en-US" + ); + + try + { + var response = new AccountApi(config).AccountUpdate( + accountUpdateRequest: accountUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountUpdateExample.java b/examples/AccountUpdateExample.java new file mode 100644 index 000000000..ac9c0d227 --- /dev/null +++ b/examples/AccountUpdateExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountUpdateExample.php b/examples/AccountUpdateExample.php new file mode 100644 index 000000000..64a1ad38d --- /dev/null +++ b/examples/AccountUpdateExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest()) + ->setCallbackUrl("https://www.example.com/callback") + ->setLocale("en-US"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate( + account_update_request: $account_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}"; +} diff --git a/examples/AccountUpdateExample.py b/examples/AccountUpdateExample.py new file mode 100644 index 000000000..5ef5466ea --- /dev/null +++ b/examples/AccountUpdateExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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) diff --git a/examples/AccountUpdateExample.rb b/examples/AccountUpdateExample.rb new file mode 100644 index 000000000..f8d7f1b2d --- /dev/null +++ b/examples/AccountUpdateExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_update_request = Dropbox::Sign::AccountUpdateRequest.new +account_update_request.callback_url = "https://www.example.com/callback" +account_update_request.locale = "en-US" + +begin + response = Dropbox::Sign::AccountApi.new.account_update( + account_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_update: #{e}" +end diff --git a/examples/AccountUpdate.sh b/examples/AccountUpdateExample.sh similarity index 100% rename from examples/AccountUpdate.sh rename to examples/AccountUpdateExample.sh diff --git a/examples/AccountUpdateExample.ts b/examples/AccountUpdateExample.ts new file mode 100644 index 000000000..8a546ee0e --- /dev/null +++ b/examples/AccountUpdateExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountUpdateRequest = new models.AccountUpdateRequest(); +accountUpdateRequest.callbackUrl = "https://www.example.com/callback"; +accountUpdateRequest.locale = "en-US"; + +apiCaller.accountUpdate( + accountUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountUpdate:"); + console.log(error.body); +}); diff --git a/examples/AccountVerify.cs b/examples/AccountVerify.cs deleted file mode 100644 index 36aacd066..000000000 --- a/examples/AccountVerify.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountVerifyRequest( - emailAddress: "some_user@dropboxsign.com" - ); - - try - { - var result = accountApi.AccountVerify(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/AccountVerify.java b/examples/AccountVerify.java deleted file mode 100644 index 36a96660d..000000000 --- a/examples/AccountVerify.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountVerifyRequest() - .emailAddress("some_user@dropboxsign.com"); - - try { - AccountVerifyResponse result = accountApi.accountVerify(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/AccountVerify.js b/examples/AccountVerify.js deleted file mode 100644 index 689286eed..000000000 --- a/examples/AccountVerify.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "some_user@dropboxsign.com", -}; - -const result = accountApi.accountVerify(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountVerify.php b/examples/AccountVerify.php deleted file mode 100644 index 12a037173..000000000 --- a/examples/AccountVerify.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountVerifyRequest(); -$data->setEmailAddress("some_user@dropboxsign.com"); - -try { - $result = $accountApi->accountVerify($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/AccountVerify.py b/examples/AccountVerify.py deleted file mode 100644 index 0e95fa2e4..000000000 --- a/examples/AccountVerify.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountVerifyRequest( - email_address="some_user@dropboxsign.com", - ) - - try: - response = account_api.account_verify(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/AccountVerify.rb b/examples/AccountVerify.rb deleted file mode 100644 index 20295f3d2..000000000 --- a/examples/AccountVerify.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountVerifyRequest.new -data.email_address = "some_user@dropboxsign.com" - -begin - result = account_api.account_verify(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/AccountVerify.ts b/examples/AccountVerify.ts deleted file mode 100644 index d2a75488b..000000000 --- a/examples/AccountVerify.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountVerifyRequest = { - emailAddress: "some_user@dropboxsign.com", -}; - -const result = accountApi.accountVerify(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/AccountVerifyExample.cs b/examples/AccountVerifyExample.cs new file mode 100644 index 000000000..cba51330d --- /dev/null +++ b/examples/AccountVerifyExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountVerifyExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountVerifyRequest = new AccountVerifyRequest( + emailAddress: "some_user@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountVerify( + accountVerifyRequest: accountVerifyRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountVerify: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/AccountVerifyExample.java b/examples/AccountVerifyExample.java new file mode 100644 index 000000000..6d6f22f72 --- /dev/null +++ b/examples/AccountVerifyExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountVerifyExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountVerify"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/AccountVerifyExample.php b/examples/AccountVerifyExample.php new file mode 100644 index 000000000..acdee34e7 --- /dev/null +++ b/examples/AccountVerifyExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest()) + ->setEmailAddress("some_user@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify( + account_verify_request: $account_verify_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}"; +} diff --git a/examples/AccountVerifyExample.py b/examples/AccountVerifyExample.py new file mode 100644 index 000000000..65bdb8018 --- /dev/null +++ b/examples/AccountVerifyExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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) diff --git a/examples/AccountVerifyExample.rb b/examples/AccountVerifyExample.rb new file mode 100644 index 000000000..8e57affce --- /dev/null +++ b/examples/AccountVerifyExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_verify_request = Dropbox::Sign::AccountVerifyRequest.new +account_verify_request.email_address = "some_user@dropboxsign.com" + +begin + response = Dropbox::Sign::AccountApi.new.account_verify( + account_verify_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_verify: #{e}" +end diff --git a/examples/AccountVerify.sh b/examples/AccountVerifyExample.sh similarity index 100% rename from examples/AccountVerify.sh rename to examples/AccountVerifyExample.sh diff --git a/examples/AccountVerifyExample.ts b/examples/AccountVerifyExample.ts new file mode 100644 index 000000000..417ffce6d --- /dev/null +++ b/examples/AccountVerifyExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountVerifyRequest = new models.AccountVerifyRequest(); +accountVerifyRequest.emailAddress = "some_user@dropboxsign.com"; + +apiCaller.accountVerify( + accountVerifyRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountVerify:"); + console.log(error.body); +}); diff --git a/examples/ApiAppCreate.cs b/examples/ApiAppCreate.cs deleted file mode 100644 index bc78c6428..000000000 --- a/examples/ApiAppCreate.cs +++ /dev/null @@ -1,59 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var oauth = new SubOAuth( - callbackUrl: "https://example.com/oauth", - scopes: new List() { - SubOAuth.ScopesEnum.BasicAccountInfo, - SubOAuth.ScopesEnum.RequestSignature - } - ); - - var whiteLabelingOptions = new SubWhiteLabelingOptions( - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff" - ); - - var customLogoFile = new FileStream( - "CustomLogoFile.png", - FileMode.Open - ); - - var data = new ApiAppCreateRequest( - name: "My Production App", - domains: new List(){"example.com"}, - oauth: oauth, - whiteLabelingOptions: whiteLabelingOptions, - customLogoFile: customLogoFile - ); - - try - { - var result = apiAppApi.ApiAppCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/ApiAppCreate.java b/examples/ApiAppCreate.java deleted file mode 100644 index 2d3c80fcf..000000000 --- a/examples/ApiAppCreate.java +++ /dev/null @@ -1,51 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of((SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppCreateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - try { - ApiAppGetResponse result = apiAppApi.apiAppCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppCreate.js b/examples/ApiAppCreate.js deleted file mode 100644 index 09d14e50a..000000000 --- a/examples/ApiAppCreate.js +++ /dev/null @@ -1,39 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const oauth = { - callbackUrl: "https://example.com/oauth", - scopes: [ - "basic_account_info", - "request_signature", - ], -}; - -const whiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data = { - name: "My Production App", - domains: ["example.com"], - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - oauth, - whiteLabelingOptions, -}; - -const result = apiAppApi.apiAppCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppCreate.php b/examples/ApiAppCreate.php deleted file mode 100644 index 8686c98fb..000000000 --- a/examples/ApiAppCreate.php +++ /dev/null @@ -1,42 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$oauth = new Dropbox\Sign\Model\SubOAuth(); -$oauth->setCallbackUrl("https://example.com/oauth") - ->setScopes([ - Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, - Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, - ]); - -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") - ->setPrimaryButtonTextColor("#ffffff"); - -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppCreateRequest(); -$data->setName("My Production App") - ->setDomains(["example.com"]) - ->setOauth($oauth) - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -try { - $result = $apiAppApi->apiAppCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppCreate.py b/examples/ApiAppCreate.py deleted file mode 100644 index 634057b35..000000000 --- a/examples/ApiAppCreate.py +++ /dev/null @@ -1,39 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - 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", - ) - - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppCreateRequest( - name="My Production App", - domains=["example.com"], - oauth=oauth, - white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, - ) - - try: - response = api_app_api.api_app_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppCreate.rb b/examples/ApiAppCreate.rb deleted file mode 100644 index 6b1ca23bf..000000000 --- a/examples/ApiAppCreate.rb +++ /dev/null @@ -1,35 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -oauth = Dropbox::Sign::SubOAuth.new -oauth.callback_url = "https://example.com/oauth" -oauth.scopes = %w[basic_account_info request_signature] - -white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new -white_labeling_options.primary_button_color = "#00b3e6" -white_labeling_options.primary_button_text_color = "#ffffff" - -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppCreateRequest.new -data.name = "My Production App" -data.domains = ["example.com"] -data.oauth = oauth -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -begin - result = api_app_api.api_app_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppCreate.ts b/examples/ApiAppCreate.ts deleted file mode 100644 index bcbec4d99..000000000 --- a/examples/ApiAppCreate.ts +++ /dev/null @@ -1,39 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const oauth: DropboxSign.SubOAuth = { - callbackUrl: "https://example.com/oauth", - scopes: [ - DropboxSign.SubOAuth.ScopesEnum.BasicAccountInfo, - DropboxSign.SubOAuth.ScopesEnum.RequestSignature, - ], -}; - -const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data: DropboxSign.ApiAppCreateRequest = { - name: "My Production App", - domains: ["example.com"], - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - oauth, - whiteLabelingOptions, -}; - -const result = apiAppApi.apiAppCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppCreateExample.cs b/examples/ApiAppCreateExample.cs new file mode 100644 index 000000000..277e40121 --- /dev/null +++ b/examples/ApiAppCreateExample.cs @@ -0,0 +1,61 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppCreateRequest = new ApiAppCreateRequest( + name: "My Production App", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppCreate( + apiAppCreateRequest: apiAppCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppCreateExample.java b/examples/ApiAppCreateExample.java new file mode 100644 index 000000000..9422376ae --- /dev/null +++ b/examples/ApiAppCreateExample.java @@ -0,0 +1,60 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppCreateExample.php b/examples/ApiAppCreateExample.php new file mode 100644 index 000000000..7ec68a6f5 --- /dev/null +++ b/examples/ApiAppCreateExample.php @@ -0,0 +1,42 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_create_request = (new Dropbox\Sign\Model\ApiAppCreateRequest()) + ->setName("My Production App") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppCreate( + api_app_create_request: $api_app_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppCreate: {$e->getMessage()}"; +} diff --git a/examples/ApiAppCreateExample.py b/examples/ApiAppCreateExample.py new file mode 100644 index 000000000..345edd053 --- /dev/null +++ b/examples/ApiAppCreateExample.py @@ -0,0 +1,43 @@ +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) diff --git a/examples/ApiAppCreateExample.rb b/examples/ApiAppCreateExample.rb new file mode 100644 index 000000000..d2b959780 --- /dev/null +++ b/examples/ApiAppCreateExample.rb @@ -0,0 +1,37 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] + +white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new +white_labeling_options.primary_button_color = "#00b3e6" +white_labeling_options.primary_button_text_color = "#ffffff" + +api_app_create_request = Dropbox::Sign::ApiAppCreateRequest.new +api_app_create_request.name = "My Production App" +api_app_create_request.domains = [ + "example.com", +] +api_app_create_request.custom_logo_file = File.new("CustomLogoFile.png", "r") +api_app_create_request.oauth = oauth +api_app_create_request.white_labeling_options = white_labeling_options + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_create( + api_app_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_create: #{e}" +end diff --git a/examples/ApiAppCreate.sh b/examples/ApiAppCreateExample.sh similarity index 100% rename from examples/ApiAppCreate.sh rename to examples/ApiAppCreateExample.sh diff --git a/examples/ApiAppCreateExample.ts b/examples/ApiAppCreateExample.ts new file mode 100644 index 000000000..be9234816 --- /dev/null +++ b/examples/ApiAppCreateExample.ts @@ -0,0 +1,36 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppCreateRequest = new models.ApiAppCreateRequest(); +apiAppCreateRequest.name = "My Production App"; +apiAppCreateRequest.domains = [ + "example.com", +]; +apiAppCreateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppCreateRequest.oauth = oauth; +apiAppCreateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppCreate( + apiAppCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppCreate:"); + console.log(error.body); +}); diff --git a/examples/ApiAppDelete.cs b/examples/ApiAppDelete.cs deleted file mode 100644 index 540adfe0d..000000000 --- a/examples/ApiAppDelete.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try - { - apiAppApi.ApiAppDelete(clientId); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/ApiAppDelete.java b/examples/ApiAppDelete.java deleted file mode 100644 index fe443187e..000000000 --- a/examples/ApiAppDelete.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - apiAppApi.apiAppDelete(clientId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppDelete.js b/examples/ApiAppDelete.js deleted file mode 100644 index 37f7b0e26..000000000 --- a/examples/ApiAppDelete.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppDelete(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppDelete.php b/examples/ApiAppDelete.php deleted file mode 100644 index d53477ba4..000000000 --- a/examples/ApiAppDelete.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $apiAppApi->apiAppDelete($clientId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppDelete.py b/examples/ApiAppDelete.py deleted file mode 100644 index 3733306cf..000000000 --- a/examples/ApiAppDelete.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - api_app_api.api_app_delete(client_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppDelete.rb b/examples/ApiAppDelete.rb deleted file mode 100644 index 6e69462bb..000000000 --- a/examples/ApiAppDelete.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_delete(client_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppDelete.ts b/examples/ApiAppDelete.ts deleted file mode 100644 index 37f7b0e26..000000000 --- a/examples/ApiAppDelete.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppDelete(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppDeleteExample.cs b/examples/ApiAppDeleteExample.cs new file mode 100644 index 000000000..87235a6a3 --- /dev/null +++ b/examples/ApiAppDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new ApiAppApi(config).ApiAppDelete( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppDeleteExample.java b/examples/ApiAppDeleteExample.java new file mode 100644 index 000000000..f9f7c5c9f --- /dev/null +++ b/examples/ApiAppDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppDeleteExample.php b/examples/ApiAppDeleteExample.php new file mode 100644 index 000000000..0734efaf9 --- /dev/null +++ b/examples/ApiAppDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppDelete( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppDelete: {$e->getMessage()}"; +} diff --git a/examples/ApiAppDeleteExample.py b/examples/ApiAppDeleteExample.py new file mode 100644 index 000000000..bcfe5d65b --- /dev/null +++ b/examples/ApiAppDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.ApiAppApi(api_client).api_app_delete( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_delete: %s\n" % e) diff --git a/examples/ApiAppDeleteExample.rb b/examples/ApiAppDeleteExample.rb new file mode 100644 index 000000000..def7fb657 --- /dev/null +++ b/examples/ApiAppDeleteExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::ApiAppApi.new.api_app_delete( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_delete: #{e}" +end diff --git a/examples/ApiAppDelete.sh b/examples/ApiAppDeleteExample.sh similarity index 100% rename from examples/ApiAppDelete.sh rename to examples/ApiAppDeleteExample.sh diff --git a/examples/ApiAppDeleteExample.ts b/examples/ApiAppDeleteExample.ts new file mode 100644 index 000000000..1ffefb975 --- /dev/null +++ b/examples/ApiAppDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppDelete:"); + console.log(error.body); +}); diff --git a/examples/ApiAppGet.cs b/examples/ApiAppGet.cs deleted file mode 100644 index 260e5072e..000000000 --- a/examples/ApiAppGet.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try - { - var result = apiAppApi.ApiAppGet(clientId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/ApiAppGet.java b/examples/ApiAppGet.java deleted file mode 100644 index 5d3a4bbd9..000000000 --- a/examples/ApiAppGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppGet(clientId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppGet.js b/examples/ApiAppGet.js deleted file mode 100644 index e300219e7..000000000 --- a/examples/ApiAppGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppGet(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppGet.php b/examples/ApiAppGet.php deleted file mode 100644 index 4372cd629..000000000 --- a/examples/ApiAppGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $result = $apiAppApi->apiAppGet($clientId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppGet.py b/examples/ApiAppGet.py deleted file mode 100644 index 07330bf35..000000000 --- a/examples/ApiAppGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - response = api_app_api.api_app_get(client_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppGet.rb b/examples/ApiAppGet.rb deleted file mode 100644 index 37011b33b..000000000 --- a/examples/ApiAppGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_get(client_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppGet.ts b/examples/ApiAppGet.ts deleted file mode 100644 index e300219e7..000000000 --- a/examples/ApiAppGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppGet(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppGetExample.cs b/examples/ApiAppGetExample.cs new file mode 100644 index 000000000..8bbf80af4 --- /dev/null +++ b/examples/ApiAppGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppGet( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppGetExample.java b/examples/ApiAppGetExample.java new file mode 100644 index 000000000..6a8330449 --- /dev/null +++ b/examples/ApiAppGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppGetExample.php b/examples/ApiAppGetExample.php new file mode 100644 index 000000000..f4dcc571b --- /dev/null +++ b/examples/ApiAppGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppGet( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppGet: {$e->getMessage()}"; +} diff --git a/examples/ApiAppGetExample.py b/examples/ApiAppGetExample.py new file mode 100644 index 000000000..0eee76c6a --- /dev/null +++ b/examples/ApiAppGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.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) diff --git a/examples/ApiAppGetExample.rb b/examples/ApiAppGetExample.rb new file mode 100644 index 000000000..f40c92b55 --- /dev/null +++ b/examples/ApiAppGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_get( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_get: #{e}" +end diff --git a/examples/ApiAppGet.sh b/examples/ApiAppGetExample.sh similarity index 100% rename from examples/ApiAppGet.sh rename to examples/ApiAppGetExample.sh diff --git a/examples/ApiAppGetExample.ts b/examples/ApiAppGetExample.ts new file mode 100644 index 000000000..4899769af --- /dev/null +++ b/examples/ApiAppGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppGet:"); + console.log(error.body); +}); diff --git a/examples/ApiAppList.cs b/examples/ApiAppList.cs deleted file mode 100644 index 094fb3b96..000000000 --- a/examples/ApiAppList.cs +++ /dev/null @@ -1,35 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var page = 1; - var pageSize = 2; - - try - { - var result = apiAppApi.ApiAppList(page, pageSize); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/ApiAppList.java b/examples/ApiAppList.java deleted file mode 100644 index e16df1a70..000000000 --- a/examples/ApiAppList.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - ApiAppListResponse result = apiAppApi.apiAppList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppList.js b/examples/ApiAppList.js deleted file mode 100644 index 46638ebe7..000000000 --- a/examples/ApiAppList.js +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 2; - -const result = apiAppApi.apiAppList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppList.php b/examples/ApiAppList.php deleted file mode 100644 index 9fb6cca9e..000000000 --- a/examples/ApiAppList.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$page = 1; -$pageSize = 2; - -try { - $result = $apiAppApi->apiAppList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppList.py b/examples/ApiAppList.py deleted file mode 100644 index 6c6ada0c8..000000000 --- a/examples/ApiAppList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - page = 1 - page_size = 2 - - try: - response = api_app_api.api_app_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppList.rb b/examples/ApiAppList.rb deleted file mode 100644 index fa0d767f5..000000000 --- a/examples/ApiAppList.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -page = 1 -page_size = 2 - -begin - result = api_app_api.api_app_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppList.ts b/examples/ApiAppList.ts deleted file mode 100644 index 46638ebe7..000000000 --- a/examples/ApiAppList.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 2; - -const result = apiAppApi.apiAppList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppListExample.cs b/examples/ApiAppListExample.cs new file mode 100644 index 000000000..be9060253 --- /dev/null +++ b/examples/ApiAppListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppListExample.java b/examples/ApiAppListExample.java new file mode 100644 index 000000000..5f023c890 --- /dev/null +++ b/examples/ApiAppListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppListExample.php b/examples/ApiAppListExample.php new file mode 100644 index 000000000..6e9a8e5cb --- /dev/null +++ b/examples/ApiAppListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppList: {$e->getMessage()}"; +} diff --git a/examples/ApiAppListExample.py b/examples/ApiAppListExample.py new file mode 100644 index 000000000..c0bca67da --- /dev/null +++ b/examples/ApiAppListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.ApiAppApi(api_client).api_app_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_list: %s\n" % e) diff --git a/examples/ApiAppListExample.rb b/examples/ApiAppListExample.rb new file mode 100644 index 000000000..3e776c659 --- /dev/null +++ b/examples/ApiAppListExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_list: #{e}" +end diff --git a/examples/ApiAppList.sh b/examples/ApiAppListExample.sh similarity index 100% rename from examples/ApiAppList.sh rename to examples/ApiAppListExample.sh diff --git a/examples/ApiAppListExample.ts b/examples/ApiAppListExample.ts new file mode 100644 index 000000000..7304a9d1c --- /dev/null +++ b/examples/ApiAppListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppList:"); + console.log(error.body); +}); diff --git a/examples/ApiAppUpdate.cs b/examples/ApiAppUpdate.cs deleted file mode 100644 index 4bca7ccc4..000000000 --- a/examples/ApiAppUpdate.cs +++ /dev/null @@ -1,61 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var oauth = new SubOAuth( - callbackUrl: "https://example.com/oauth", - scopes: new List() { - SubOAuth.ScopesEnum.BasicAccountInfo, - SubOAuth.ScopesEnum.RequestSignature - } - ); - - var whiteLabelingOptions = new SubWhiteLabelingOptions( - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff" - ); - - var customLogoFile = new FileStream( - "CustomLogoFile.png", - FileMode.Open - ); - - var data = new ApiAppUpdateRequest( - name: "My Production App", - domains: new List(){"example.com"}, - oauth: oauth, - whiteLabelingOptions: whiteLabelingOptions, - customLogoFile: customLogoFile - ); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try - { - var result = apiAppApi.ApiAppUpdate(clientId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/ApiAppUpdate.java b/examples/ApiAppUpdate.java deleted file mode 100644 index a65617313..000000000 --- a/examples/ApiAppUpdate.java +++ /dev/null @@ -1,53 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of(SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppUpdateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppUpdate(clientId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ApiAppUpdate.js b/examples/ApiAppUpdate.js deleted file mode 100644 index 940878909..000000000 --- a/examples/ApiAppUpdate.js +++ /dev/null @@ -1,32 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const whiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data = { - name: "New Name", - callbackUrl: "http://example.com/dropboxsign", - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - whiteLabelingOptions, -}; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppUpdate(clientId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppUpdate.php b/examples/ApiAppUpdate.php deleted file mode 100644 index 60520cccc..000000000 --- a/examples/ApiAppUpdate.php +++ /dev/null @@ -1,36 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") - ->setPrimaryButtonTextColor("#ffffff"); - -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); -$data->setName("New Name") - ->setCallbackUrl("https://example.com/dropboxsign") - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -try { - $result = $apiAppApi->apiAppUpdate($clientId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ApiAppUpdate.py b/examples/ApiAppUpdate.py deleted file mode 100644 index 38f812095..000000000 --- a/examples/ApiAppUpdate.py +++ /dev/null @@ -1,35 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - white_labeling_options = models.SubWhiteLabelingOptions( - primary_button_color="#00b3e6", - primary_button_text_color="#ffffff", - ) - - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppUpdateRequest( - name="New Name", - callback_url="https://example.com/dropboxsign", - white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, - ) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - - try: - response = api_app_api.api_app_update(client_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ApiAppUpdate.rb b/examples/ApiAppUpdate.rb deleted file mode 100644 index 940f70c78..000000000 --- a/examples/ApiAppUpdate.rb +++ /dev/null @@ -1,32 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api_app_api = Dropbox::Sign::ApiAppApi.new - -white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new -white_labeling_options.primary_button_color = "#00b3e6" -white_labeling_options.primary_button_text_color = "#ffffff" - -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppUpdateRequest.new -data.name = "New Name" -data.callback_url = "https://example.com/dropboxsign" -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - -begin - result = api_app_api.api_app_update(client_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ApiAppUpdate.ts b/examples/ApiAppUpdate.ts deleted file mode 100644 index a53f3f1c0..000000000 --- a/examples/ApiAppUpdate.ts +++ /dev/null @@ -1,32 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data: DropboxSign.ApiAppUpdateRequest = { - name: "New Name", - callbackUrl: "https://example.com/dropboxsign", - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - whiteLabelingOptions, -}; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppUpdate(clientId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ApiAppUpdateExample.cs b/examples/ApiAppUpdateExample.cs new file mode 100644 index 000000000..3eb03a1bf --- /dev/null +++ b/examples/ApiAppUpdateExample.cs @@ -0,0 +1,63 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppUpdateRequest = new ApiAppUpdateRequest( + callbackUrl: "https://example.com/dropboxsign", + name: "New Name", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppUpdate( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9", + apiAppUpdateRequest: apiAppUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ApiAppUpdateExample.java b/examples/ApiAppUpdateExample.java new file mode 100644 index 000000000..19eb17192 --- /dev/null +++ b/examples/ApiAppUpdateExample.java @@ -0,0 +1,62 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ApiAppUpdateExample.php b/examples/ApiAppUpdateExample.php new file mode 100644 index 000000000..30c22c4eb --- /dev/null +++ b/examples/ApiAppUpdateExample.php @@ -0,0 +1,44 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_update_request = (new Dropbox\Sign\Model\ApiAppUpdateRequest()) + ->setCallbackUrl("https://example.com/dropboxsign") + ->setName("New Name") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppUpdate( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request: $api_app_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppUpdate: {$e->getMessage()}"; +} diff --git a/examples/ApiAppUpdateExample.py b/examples/ApiAppUpdateExample.py new file mode 100644 index 000000000..00212198f --- /dev/null +++ b/examples/ApiAppUpdateExample.py @@ -0,0 +1,45 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + oauth = models.SubOAuth( + callback_url="https://example.com/oauth", + scopes=[ + "basic_account_info", + "request_signature", + ], + ) + + white_labeling_options = models.SubWhiteLabelingOptions( + primary_button_color="#00b3e6", + primary_button_text_color="#ffffff", + ) + + api_app_update_request = models.ApiAppUpdateRequest( + callback_url="https://example.com/dropboxsign", + name="New Name", + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), + oauth=oauth, + white_labeling_options=white_labeling_options, + ) + + try: + response = api.ApiAppApi(api_client).api_app_update( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request=api_app_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_update: %s\n" % e) diff --git a/examples/ApiAppUpdateExample.rb b/examples/ApiAppUpdateExample.rb new file mode 100644 index 000000000..e973b3520 --- /dev/null +++ b/examples/ApiAppUpdateExample.rb @@ -0,0 +1,39 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] + +white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new +white_labeling_options.primary_button_color = "#00b3e6" +white_labeling_options.primary_button_text_color = "#ffffff" + +api_app_update_request = Dropbox::Sign::ApiAppUpdateRequest.new +api_app_update_request.callback_url = "https://example.com/dropboxsign" +api_app_update_request.name = "New Name" +api_app_update_request.domains = [ + "example.com", +] +api_app_update_request.custom_logo_file = File.new("CustomLogoFile.png", "r") +api_app_update_request.oauth = oauth +api_app_update_request.white_labeling_options = white_labeling_options + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_update( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + api_app_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_update: #{e}" +end diff --git a/examples/ApiAppUpdate.sh b/examples/ApiAppUpdateExample.sh similarity index 100% rename from examples/ApiAppUpdate.sh rename to examples/ApiAppUpdateExample.sh diff --git a/examples/ApiAppUpdateExample.ts b/examples/ApiAppUpdateExample.ts new file mode 100644 index 000000000..fa8937223 --- /dev/null +++ b/examples/ApiAppUpdateExample.ts @@ -0,0 +1,38 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppUpdateRequest = new models.ApiAppUpdateRequest(); +apiAppUpdateRequest.callbackUrl = "https://example.com/dropboxsign"; +apiAppUpdateRequest.name = "New Name"; +apiAppUpdateRequest.domains = [ + "example.com", +]; +apiAppUpdateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppUpdateRequest.oauth = oauth; +apiAppUpdateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppUpdate:"); + console.log(error.body); +}); diff --git a/examples/BulkSendJobGet.cs b/examples/BulkSendJobGet.cs deleted file mode 100644 index 42a805c58..000000000 --- a/examples/BulkSendJobGet.cs +++ /dev/null @@ -1,35 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var bulkSendJobApi = new BulkSendJobApi(config); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try - { - var result = bulkSendJobApi.BulkSendJobGet(bulkSendJobId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/BulkSendJobGet.java b/examples/BulkSendJobGet.java deleted file mode 100644 index d79a46164..000000000 --- a/examples/BulkSendJobGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try { - BulkSendJobGetResponse result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/BulkSendJobGet.js b/examples/BulkSendJobGet.js deleted file mode 100644 index 7a1f5e043..000000000 --- a/examples/BulkSendJobGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobGet.php b/examples/BulkSendJobGet.php deleted file mode 100644 index 3b93304ce..000000000 --- a/examples/BulkSendJobGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -try { - $result = $bulkSendJobApi->bulkSendJobGet($bulkSendJobId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/BulkSendJobGet.py b/examples/BulkSendJobGet.py deleted file mode 100644 index ed92e9751..000000000 --- a/examples/BulkSendJobGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - - try: - response = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/BulkSendJobGet.rb b/examples/BulkSendJobGet.rb deleted file mode 100644 index 8ef33b282..000000000 --- a/examples/BulkSendJobGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - -begin - result = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/BulkSendJobGet.ts b/examples/BulkSendJobGet.ts deleted file mode 100644 index 7a1f5e043..000000000 --- a/examples/BulkSendJobGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobGetExample.cs b/examples/BulkSendJobGetExample.cs new file mode 100644 index 000000000..baa383c93 --- /dev/null +++ b/examples/BulkSendJobGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobGet( + bulkSendJobId: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/BulkSendJobGetExample.java b/examples/BulkSendJobGetExample.java new file mode 100644 index 000000000..a90b43560 --- /dev/null +++ b/examples/BulkSendJobGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/BulkSendJobGetExample.php b/examples/BulkSendJobGetExample.php new file mode 100644 index 000000000..8b74043d9 --- /dev/null +++ b/examples/BulkSendJobGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobGet( + bulk_send_job_id: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobGet: {$e->getMessage()}"; +} diff --git a/examples/BulkSendJobGetExample.py b/examples/BulkSendJobGetExample.py new file mode 100644 index 000000000..58b865737 --- /dev/null +++ b/examples/BulkSendJobGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_get( + bulk_send_job_id="6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e) diff --git a/examples/BulkSendJobGetExample.rb b/examples/BulkSendJobGetExample.rb new file mode 100644 index 000000000..bf4b58570 --- /dev/null +++ b/examples/BulkSendJobGetExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_get( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", # bulk_send_job_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}" +end diff --git a/examples/BulkSendJobGet.sh b/examples/BulkSendJobGetExample.sh similarity index 100% rename from examples/BulkSendJobGet.sh rename to examples/BulkSendJobGetExample.sh diff --git a/examples/BulkSendJobGetExample.ts b/examples/BulkSendJobGetExample.ts new file mode 100644 index 000000000..9c3e43eb9 --- /dev/null +++ b/examples/BulkSendJobGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobGet:"); + console.log(error.body); +}); diff --git a/examples/BulkSendJobList.cs b/examples/BulkSendJobList.cs deleted file mode 100644 index 4bdbb0b59..000000000 --- a/examples/BulkSendJobList.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var bulkSendJobApi = new BulkSendJobApi(config); - - var page = 1; - var pageSize = 20; - - try - { - var result = bulkSendJobApi.BulkSendJobList(page, pageSize); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/BulkSendJobList.java b/examples/BulkSendJobList.java deleted file mode 100644 index 866f3352c..000000000 --- a/examples/BulkSendJobList.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var page = 1; - var pageSize = 20; - - try { - BulkSendJobListResponse result = bulkSendJobApi.bulkSendJobList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/BulkSendJobList.js b/examples/BulkSendJobList.js deleted file mode 100644 index ceb35707d..000000000 --- a/examples/BulkSendJobList.js +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 20; - -const result = bulkSendJobApi.bulkSendJobList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobList.php b/examples/BulkSendJobList.php deleted file mode 100644 index 9e6639af1..000000000 --- a/examples/BulkSendJobList.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$page = 1; -$pageSize = 20; - -try { - $result = $bulkSendJobApi->bulkSendJobList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/BulkSendJobList.py b/examples/BulkSendJobList.py deleted file mode 100644 index 61bf5117f..000000000 --- a/examples/BulkSendJobList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - page = 1 - page_size = 20 - - try: - response = bulk_send_job_api.bulk_send_job_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/BulkSendJobList.rb b/examples/BulkSendJobList.rb deleted file mode 100644 index cb64c5df5..000000000 --- a/examples/BulkSendJobList.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -page = 1 -page_size = 20 - -begin - result = bulk_send_job_api.bulk_send_job_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/BulkSendJobList.ts b/examples/BulkSendJobList.ts deleted file mode 100644 index ceb35707d..000000000 --- a/examples/BulkSendJobList.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 20; - -const result = bulkSendJobApi.bulkSendJobList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/BulkSendJobListExample.cs b/examples/BulkSendJobListExample.cs new file mode 100644 index 000000000..d84e42e04 --- /dev/null +++ b/examples/BulkSendJobListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/BulkSendJobListExample.java b/examples/BulkSendJobListExample.java new file mode 100644 index 000000000..fc5d223e3 --- /dev/null +++ b/examples/BulkSendJobListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/BulkSendJobListExample.php b/examples/BulkSendJobListExample.php new file mode 100644 index 000000000..9a566d561 --- /dev/null +++ b/examples/BulkSendJobListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobList: {$e->getMessage()}"; +} diff --git a/examples/BulkSendJobListExample.py b/examples/BulkSendJobListExample.py new file mode 100644 index 000000000..cb688f24d --- /dev/null +++ b/examples/BulkSendJobListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_list: %s\n" % e) diff --git a/examples/BulkSendJobListExample.rb b/examples/BulkSendJobListExample.rb new file mode 100644 index 000000000..60e8c1b50 --- /dev/null +++ b/examples/BulkSendJobListExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}" +end diff --git a/examples/BulkSendJobList.sh b/examples/BulkSendJobListExample.sh similarity index 100% rename from examples/BulkSendJobList.sh rename to examples/BulkSendJobListExample.sh diff --git a/examples/BulkSendJobListExample.ts b/examples/BulkSendJobListExample.ts new file mode 100644 index 000000000..4f8b1b33b --- /dev/null +++ b/examples/BulkSendJobListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobList:"); + console.log(error.body); +}); diff --git a/examples/EmbeddedEditUrl.cs b/examples/EmbeddedEditUrl.cs deleted file mode 100644 index 87479129f..000000000 --- a/examples/EmbeddedEditUrl.cs +++ /dev/null @@ -1,40 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var embeddedApi = new EmbeddedApi(config); - - var data = new EmbeddedEditUrlRequest( - ccRoles: new List(){""}, - mergeFields: new List() - ); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try - { - var result = embeddedApi.EmbeddedEditUrl(templateId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/EmbeddedEditUrl.java b/examples/EmbeddedEditUrl.java deleted file mode 100644 index 65a52a96a..000000000 --- a/examples/EmbeddedEditUrl.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var data = new EmbeddedEditUrlRequest() - .ccRoles(List.of("")) - .mergeFields(List.of()); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try { - EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/EmbeddedEditUrl.js b/examples/EmbeddedEditUrl.js deleted file mode 100644 index a3fab55d9..000000000 --- a/examples/EmbeddedEditUrl.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - ccRoles: [""], - mergeFields: [], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = embeddedApi.embeddedEditUrl(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedEditUrl.php b/examples/EmbeddedEditUrl.php deleted file mode 100644 index 452afd315..000000000 --- a/examples/EmbeddedEditUrl.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$data = new Dropbox\Sign\Model\EmbeddedEditUrlRequest(); -$data->setCcRoles([""]) - ->setMergeFields([]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $embeddedApi->embeddedEditUrl($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/EmbeddedEditUrl.py b/examples/EmbeddedEditUrl.py deleted file mode 100644 index dd657233d..000000000 --- a/examples/EmbeddedEditUrl.py +++ /dev/null @@ -1,26 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - data = models.EmbeddedEditUrlRequest( - cc_roles=[""], - merge_fields=[], - ) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = embedded_api.embedded_edit_url(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/EmbeddedEditUrl.rb b/examples/EmbeddedEditUrl.rb deleted file mode 100644 index 0eef4c2cf..000000000 --- a/examples/EmbeddedEditUrl.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api = Dropbox::Sign::EmbeddedApi.new - -data = Dropbox::Sign::EmbeddedEditUrlRequest.new -data.cc_roles = [""] -data.merge_fields = [] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = embedded_api.embedded_edit_url(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/EmbeddedEditUrl.ts b/examples/EmbeddedEditUrl.ts deleted file mode 100644 index c6c93c259..000000000 --- a/examples/EmbeddedEditUrl.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.EmbeddedEditUrlRequest = { - ccRoles: [""], - mergeFields: [], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = embeddedApi.embeddedEditUrl(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedEditUrlExample.cs b/examples/EmbeddedEditUrlExample.cs new file mode 100644 index 000000000..f951e1751 --- /dev/null +++ b/examples/EmbeddedEditUrlExample.cs @@ -0,0 +1,45 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedEditUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var mergeFields = new List(); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest( + ccRoles: [ + "", + ], + mergeFields: mergeFields + ); + + try + { + var response = new EmbeddedApi(config).EmbeddedEditUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + embeddedEditUrlRequest: embeddedEditUrlRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedEditUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/EmbeddedEditUrlExample.java b/examples/EmbeddedEditUrlExample.java new file mode 100644 index 000000000..81139263b --- /dev/null +++ b/examples/EmbeddedEditUrlExample.java @@ -0,0 +1,49 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedEditUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/EmbeddedEditUrlExample.php b/examples/EmbeddedEditUrlExample.php new file mode 100644 index 000000000..cae4929eb --- /dev/null +++ b/examples/EmbeddedEditUrlExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$merge_fields = [ +]; + +$embedded_edit_url_request = (new Dropbox\Sign\Model\EmbeddedEditUrlRequest()) + ->setCcRoles([ + "", + ]) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedEditUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request: $embedded_edit_url_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedEditUrl: {$e->getMessage()}"; +} diff --git a/examples/EmbeddedEditUrlExample.py b/examples/EmbeddedEditUrlExample.py new file mode 100644 index 000000000..0c8577780 --- /dev/null +++ b/examples/EmbeddedEditUrlExample.py @@ -0,0 +1,31 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + merge_fields = [ + ] + + embedded_edit_url_request = models.EmbeddedEditUrlRequest( + cc_roles=[ + "", + ], + merge_fields=merge_fields, + ) + + try: + response = api.EmbeddedApi(api_client).embedded_edit_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request=embedded_edit_url_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_edit_url: %s\n" % e) diff --git a/examples/EmbeddedEditUrlExample.rb b/examples/EmbeddedEditUrlExample.rb new file mode 100644 index 000000000..8c110f69d --- /dev/null +++ b/examples/EmbeddedEditUrlExample.rb @@ -0,0 +1,27 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +merge_fields = [ +] + +embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new +embedded_edit_url_request.cc_roles = [ + "", +] +embedded_edit_url_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::EmbeddedApi.new.embedded_edit_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + embedded_edit_url_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}" +end diff --git a/examples/EmbeddedEditUrl.sh b/examples/EmbeddedEditUrlExample.sh similarity index 100% rename from examples/EmbeddedEditUrl.sh rename to examples/EmbeddedEditUrlExample.sh diff --git a/examples/EmbeddedEditUrlExample.ts b/examples/EmbeddedEditUrlExample.ts new file mode 100644 index 000000000..bca3980cf --- /dev/null +++ b/examples/EmbeddedEditUrlExample.ts @@ -0,0 +1,26 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const mergeFields = [ +]; + +const embeddedEditUrlRequest = new models.EmbeddedEditUrlRequest(); +embeddedEditUrlRequest.ccRoles = [ + "", +]; +embeddedEditUrlRequest.mergeFields = mergeFields; + +apiCaller.embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedEditUrl:"); + console.log(error.body); +}); diff --git a/examples/EmbeddedSignUrl.cs b/examples/EmbeddedSignUrl.cs deleted file mode 100644 index d8197bfeb..000000000 --- a/examples/EmbeddedSignUrl.cs +++ /dev/null @@ -1,35 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var embeddedApi = new EmbeddedApi(config); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try - { - var result = embeddedApi.EmbeddedSignUrl(signatureId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/EmbeddedSignUrl.java b/examples/EmbeddedSignUrl.java deleted file mode 100644 index 2ab5869ea..000000000 --- a/examples/EmbeddedSignUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try { - EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/EmbeddedSignUrl.js b/examples/EmbeddedSignUrl.js deleted file mode 100644 index e69bca023..000000000 --- a/examples/EmbeddedSignUrl.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -const result = embeddedApi.embeddedSignUrl(signatureId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedSignUrl.php b/examples/EmbeddedSignUrl.php deleted file mode 100644 index 7b838a164..000000000 --- a/examples/EmbeddedSignUrl.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -try { - $result = $embeddedApi->embeddedSignUrl($signatureId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/EmbeddedSignUrl.py b/examples/EmbeddedSignUrl.py deleted file mode 100644 index 64d5c20e1..000000000 --- a/examples/EmbeddedSignUrl.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - - try: - response = embedded_api.embedded_sign_url(signature_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/EmbeddedSignUrl.rb b/examples/EmbeddedSignUrl.rb deleted file mode 100644 index e23571a5c..000000000 --- a/examples/EmbeddedSignUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -api = Dropbox::Sign::EmbeddedApi.new - -signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - -begin - result = embedded_api.embedded_sign_url(signature_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/EmbeddedSignUrl.ts b/examples/EmbeddedSignUrl.ts deleted file mode 100644 index e69bca023..000000000 --- a/examples/EmbeddedSignUrl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -const result = embeddedApi.embeddedSignUrl(signatureId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/EmbeddedSignUrlExample.cs b/examples/EmbeddedSignUrlExample.cs new file mode 100644 index 000000000..a800f0b04 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedSignUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new EmbeddedApi(config).EmbeddedSignUrl( + signatureId: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedSignUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/EmbeddedSignUrlExample.java b/examples/EmbeddedSignUrlExample.java new file mode 100644 index 000000000..8b58ba353 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedSignUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedSignUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/EmbeddedSignUrlExample.php b/examples/EmbeddedSignUrlExample.php new file mode 100644 index 000000000..b055ac6ed --- /dev/null +++ b/examples/EmbeddedSignUrlExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedSignUrl( + signature_id: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedSignUrl: {$e->getMessage()}"; +} diff --git a/examples/EmbeddedSignUrlExample.py b/examples/EmbeddedSignUrlExample.py new file mode 100644 index 000000000..903945d90 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.EmbeddedApi(api_client).embedded_sign_url( + signature_id="50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_sign_url: %s\n" % e) diff --git a/examples/EmbeddedSignUrlExample.rb b/examples/EmbeddedSignUrlExample.rb new file mode 100644 index 000000000..dd08e5a6f --- /dev/null +++ b/examples/EmbeddedSignUrlExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::EmbeddedApi.new.embedded_sign_url( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}" +end diff --git a/examples/EmbeddedSignUrl.sh b/examples/EmbeddedSignUrlExample.sh similarity index 100% rename from examples/EmbeddedSignUrl.sh rename to examples/EmbeddedSignUrlExample.sh diff --git a/examples/EmbeddedSignUrlExample.ts b/examples/EmbeddedSignUrlExample.ts new file mode 100644 index 000000000..ec7da0536 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", // signatureId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedSignUrl:"); + console.log(error.body); +}); diff --git a/examples/EventCallback.cs b/examples/EventCallback.cs deleted file mode 100644 index bc287ff43..000000000 --- a/examples/EventCallback.cs +++ /dev/null @@ -1,41 +0,0 @@ -using Newtonsoft.Json; -using Dropbox.Sign.Model; -using Dropbox.Sign; - -public class Example -{ - public static void Main() - { - // use your API key - var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; - - // callbackData represents data we send to you - var callbackData = new Dictionary() - { - ["event"] = new Dictionary() - { - ["event_type"] = "account_confirmed", - ["event_time"] = "1669926463", - ["event_hash"] = "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", - ["event_metadata"] = new Dictionary() - { - ["related_signature_id"] = null, - ["reported_for_account_id"] = "6421d70b9bd45059fa207d03ab8d1b96515b472c", - ["reported_for_app_id"] = null, - ["event_message"] = null, - } - } - }; - - var callbackEvent = EventCallbackRequest.Init(JsonConvert.SerializeObject(callbackData)); - - // verify that a callback came from HelloSign.com - if (EventCallbackHelper.IsValid(apiKey, callbackEvent)) - { - // one of "account_callback" or "api_app_callback" - var callbackType = EventCallbackHelper.GetCallbackType(callbackEvent); - - // do your magic below! - } - } -} diff --git a/examples/EventCallback.java b/examples/EventCallback.java deleted file mode 100644 index d712408f1..000000000 --- a/examples/EventCallback.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.EventCallbackHelper; -import com.dropbox.sign.model.EventCallbackRequest; -import com.fasterxml.jackson.databind.ObjectMapper; - -import java.util.HashMap; - -public class Example { - public static void main(String[] args) throws Exception { - // use your API key - var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; - - // callbackData represents data we send to you - var callbackData = new HashMap<>() {{ - put("event", new HashMap<>() {{ - put("event_type", "account_confirmed"); - put("event_time", "1669926463"); - put("event_hash", "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f"); - put("event_metadata", new HashMap<>() {{ - put("related_signature_id", null); - put("reported_for_account_id", "6421d70b9bd45059fa207d03ab8d1b96515b472c"); - put("reported_for_app_id", null); - put("event_message", null); - }}); - }}); - }}; - - var callbackEvent = EventCallbackRequest.init( - new ObjectMapper().writeValueAsString(callbackData) - ); - - // verify that a callback came from HelloSign.com - if (EventCallbackHelper.isValid(apiKey, callbackEvent)) { - // one of "account_callback" or "api_app_callback" - var callbackType = EventCallbackHelper.getCallbackType(callbackEvent); - - // do your magic below! - } - } -} diff --git a/examples/EventCallback.php b/examples/EventCallback.php deleted file mode 100644 index 68ce6540f..000000000 --- a/examples/EventCallback.php +++ /dev/null @@ -1,31 +0,0 @@ - [ - "event_type" => "account_confirmed", - "event_time" => "1669926463", - "event_hash" => "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", - "event_metadata" => [ - "related_signature_id" => null, - "reported_for_account_id" => "6421d70b9bd45059fa207d03ab8d1b96515b472c", - "reported_for_app_id" => null, - "event_message" => null, - ], - ], -]; - -$callback_event = Dropbox\Sign\Model\EventCallbackRequest::init($callback_data); - -// verify that a callback came from HelloSign.com -if (Dropbox\Sign\EventCallbackHelper::isValid($api_key, $callback_event)) { - // one of "account_callback" or "api_app_callback" - $callback_type = Dropbox\Sign\EventCallbackHelper::getCallbackType($callback_event); - - // do your magic below! -} diff --git a/examples/EventCallbackExample.cs b/examples/EventCallbackExample.cs new file mode 100644 index 000000000..c8610a8fe --- /dev/null +++ b/examples/EventCallbackExample.cs @@ -0,0 +1,44 @@ +using System.Collections.Generic; +using Newtonsoft.Json; +using Dropbox.Sign.Model; +using Dropbox.Sign; + +namespace Dropbox.SignSandbox; + +public class EventCallbackExample +{ + public static void Run() + { + // use your API key + var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; + + // callbackData represents data we send to you + var callbackData = new Dictionary() + { + ["event"] = new Dictionary() + { + ["event_type"] = "account_confirmed", + ["event_time"] = "1669926463", + ["event_hash"] = "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + ["event_metadata"] = new Dictionary() + { + ["related_signature_id"] = null, + ["reported_for_account_id"] = "6421d70b9bd45059fa207d03ab8d1b96515b472c", + ["reported_for_app_id"] = null, + ["event_message"] = null, + } + } + }; + + var callbackEvent = EventCallbackRequest.Init(JsonConvert.SerializeObject(callbackData)); + + // verify that a callback came from HelloSign.com + if (EventCallbackHelper.IsValid(apiKey, callbackEvent)) + { + // one of "account_callback" or "api_app_callback" + var callbackType = EventCallbackHelper.GetCallbackType(callbackEvent); + + // do your magic below! + } + } +} diff --git a/examples/EventCallbackExample.java b/examples/EventCallbackExample.java new file mode 100644 index 000000000..37d245133 --- /dev/null +++ b/examples/EventCallbackExample.java @@ -0,0 +1,39 @@ +import com.dropbox.sign.EventCallbackHelper; +import com.dropbox.sign.model.EventCallbackRequest; +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.util.HashMap; + +public class EventCallbackExample { + public static void main(String[] args) throws Exception { + // use your API key + var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; + + // callbackData represents data we send to you + var callbackData = new HashMap<>() {{ + put("event", new HashMap<>() {{ + put("event_type", "account_confirmed"); + put("event_time", "1669926463"); + put("event_hash", "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f"); + put("event_metadata", new HashMap<>() {{ + put("related_signature_id", null); + put("reported_for_account_id", "6421d70b9bd45059fa207d03ab8d1b96515b472c"); + put("reported_for_app_id", null); + put("event_message", null); + }}); + }}); + }}; + + var callbackEvent = EventCallbackRequest.init( + new ObjectMapper().writeValueAsString(callbackData) + ); + + // verify that a callback came from HelloSign.com + if (EventCallbackHelper.isValid(apiKey, callbackEvent)) { + // one of "account_callback" or "api_app_callback" + var callbackType = EventCallbackHelper.getCallbackType(callbackEvent); + + // do your magic below! + } + } +} diff --git a/examples/EventCallbackExample.php b/examples/EventCallbackExample.php new file mode 100644 index 000000000..4a21d5cbf --- /dev/null +++ b/examples/EventCallbackExample.php @@ -0,0 +1,35 @@ + [ + "event_type" => "account_confirmed", + "event_time" => "1669926463", + "event_hash" => "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + "event_metadata" => [ + "related_signature_id" => null, + "reported_for_account_id" => "6421d70b9bd45059fa207d03ab8d1b96515b472c", + "reported_for_app_id" => null, + "event_message" => null, + ], + ], +]; + +$callback_event = Dropbox\Sign\Model\EventCallbackRequest::init($callback_data); + +// verify that a callback came from HelloSign.com +if (Dropbox\Sign\EventCallbackHelper::isValid($api_key, $callback_event)) { + // one of "account_callback" or "api_app_callback" + $callback_type = Dropbox\Sign\EventCallbackHelper::getCallbackType($callback_event); + + // do your magic below! +} diff --git a/examples/EventCallback.py b/examples/EventCallbackExample.py similarity index 100% rename from examples/EventCallback.py rename to examples/EventCallbackExample.py diff --git a/examples/EventCallback.rb b/examples/EventCallbackExample.rb similarity index 100% rename from examples/EventCallback.rb rename to examples/EventCallbackExample.rb diff --git a/examples/EventCallback.js b/examples/EventCallbackExample.ts similarity index 100% rename from examples/EventCallback.js rename to examples/EventCallbackExample.ts diff --git a/examples/FaxDelete.cs b/examples/FaxDelete.cs deleted file mode 100644 index 88a6ed074..000000000 --- a/examples/FaxDelete.cs +++ /dev/null @@ -1,28 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxApi = new FaxApi(config); - - try - { - faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxDelete.java b/examples/FaxDelete.java deleted file mode 100644 index 794b74d94..000000000 --- a/examples/FaxDelete.java +++ /dev/null @@ -1,25 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - try { - faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxDelete.js b/examples/FaxDelete.js deleted file mode 100644 index 38492bd21..000000000 --- a/examples/FaxDelete.js +++ /dev/null @@ -1,13 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxDelete.php b/examples/FaxDelete.php deleted file mode 100644 index a5c62f5e9..000000000 --- a/examples/FaxDelete.php +++ /dev/null @@ -1,18 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -try { - $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxDelete.py b/examples/FaxDelete.py deleted file mode 100644 index adf2a5da8..000000000 --- a/examples/FaxDelete.py +++ /dev/null @@ -1,16 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - try: - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxDelete.rb b/examples/FaxDelete.rb deleted file mode 100644 index f68be3440..000000000 --- a/examples/FaxDelete.rb +++ /dev/null @@ -1,14 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -begin - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxDelete.ts b/examples/FaxDelete.ts deleted file mode 100644 index 38492bd21..000000000 --- a/examples/FaxDelete.ts +++ /dev/null @@ -1,13 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxDeleteExample.cs b/examples/FaxDeleteExample.cs new file mode 100644 index 000000000..aa39f496d --- /dev/null +++ b/examples/FaxDeleteExample.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class 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); + } + } +} diff --git a/examples/FaxDeleteExample.java b/examples/FaxDeleteExample.java new file mode 100644 index 000000000..ac5fc888d --- /dev/null +++ b/examples/FaxDeleteExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxDeleteExample.php b/examples/FaxDeleteExample.php new file mode 100644 index 000000000..96ba3c0d7 --- /dev/null +++ b/examples/FaxDeleteExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\FaxApi(config: $config))->faxDelete( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxDelete: {$e->getMessage()}"; +} diff --git a/examples/FaxDeleteExample.py b/examples/FaxDeleteExample.py new file mode 100644 index 000000000..76774d75b --- /dev/null +++ b/examples/FaxDeleteExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.FaxApi(api_client).fax_delete( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling FaxApi#fax_delete: %s\n" % e) diff --git a/examples/FaxDeleteExample.rb b/examples/FaxDeleteExample.rb new file mode 100644 index 000000000..6caa9d681 --- /dev/null +++ b/examples/FaxDeleteExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::FaxApi.new.fax_delete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_delete: #{e}" +end diff --git a/examples/FaxDelete.sh b/examples/FaxDeleteExample.sh similarity index 100% rename from examples/FaxDelete.sh rename to examples/FaxDeleteExample.sh diff --git a/examples/FaxDeleteExample.ts b/examples/FaxDeleteExample.ts new file mode 100644 index 000000000..3afd7a63b --- /dev/null +++ b/examples/FaxDeleteExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).catch(error => { + console.log("Exception when calling FaxApi#faxDelete:"); + console.log(error.body); +}); diff --git a/examples/FaxFiles.cs b/examples/FaxFiles.cs deleted file mode 100644 index fbaf4166e..000000000 --- a/examples/FaxFiles.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxApi = new FaxApi(config); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = faxApi.FaxFiles(faxId); - var fileStream = File.Create("file_response.pdf"); - result.Seek(0, SeekOrigin.Begin); - result.CopyTo(fileStream); - fileStream.Close(); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxFiles.java b/examples/FaxFiles.java deleted file mode 100644 index bd6dcc5df..000000000 --- a/examples/FaxFiles.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = faxApi.faxFiles(faxId); - result.renameTo(new File("file_response.pdf"));; - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxFiles.js b/examples/FaxFiles.js deleted file mode 100644 index d7390cf60..000000000 --- a/examples/FaxFiles.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = faxApi.faxFiles(faxId); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxFiles.php b/examples/FaxFiles.php deleted file mode 100644 index d543eea9c..000000000 --- a/examples/FaxFiles.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $faxApi->faxFiles($faxId); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxFiles.py b/examples/FaxFiles.py deleted file mode 100644 index 110a0f7b5..000000000 --- a/examples/FaxFiles.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = fax_api.fax_files(fax_id) - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxFiles.rb b/examples/FaxFiles.rb deleted file mode 100644 index 8f4955da8..000000000 --- a/examples/FaxFiles.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - file_bin = fax_api.fax_files(data) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxFiles.ts b/examples/FaxFiles.ts deleted file mode 100644 index d7390cf60..000000000 --- a/examples/FaxFiles.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = faxApi.faxFiles(faxId); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxFilesExample.cs b/examples/FaxFilesExample.cs new file mode 100644 index 000000000..278b90f8b --- /dev/null +++ b/examples/FaxFilesExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxFiles( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxFilesExample.java b/examples/FaxFilesExample.java new file mode 100644 index 000000000..1d2e62fac --- /dev/null +++ b/examples/FaxFilesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxFilesExample.php b/examples/FaxFilesExample.php new file mode 100644 index 000000000..01322d769 --- /dev/null +++ b/examples/FaxFilesExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxFiles( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxFiles: {$e->getMessage()}"; +} diff --git a/examples/FaxFilesExample.py b/examples/FaxFilesExample.py new file mode 100644 index 000000000..4bc18d604 --- /dev/null +++ b/examples/FaxFilesExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxApi(api_client).fax_files( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling FaxApi#fax_files: %s\n" % e) diff --git a/examples/FaxFilesExample.rb b/examples/FaxFilesExample.rb new file mode 100644 index 000000000..b44d604c4 --- /dev/null +++ b/examples/FaxFilesExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_files: #{e}" +end diff --git a/examples/FaxFiles.sh b/examples/FaxFilesExample.sh similarity index 100% rename from examples/FaxFiles.sh rename to examples/FaxFilesExample.sh diff --git a/examples/FaxFilesExample.ts b/examples/FaxFilesExample.ts new file mode 100644 index 000000000..d4360710d --- /dev/null +++ b/examples/FaxFilesExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxFiles:"); + console.log(error.body); +}); diff --git a/examples/FaxGet.cs b/examples/FaxGet.cs deleted file mode 100644 index 6396e0c34..000000000 --- a/examples/FaxGet.cs +++ /dev/null @@ -1,31 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - var faxApi = new FaxApi(config); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = faxApi.FaxGet(faxId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxGet.java b/examples/FaxGet.java deleted file mode 100644 index a9cc433df..000000000 --- a/examples/FaxGet.java +++ /dev/null @@ -1,27 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FaxGetResponse result = faxApi.faxGet(faxId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxGet.js b/examples/FaxGet.js deleted file mode 100644 index 8a1dbbfda..000000000 --- a/examples/FaxGet.js +++ /dev/null @@ -1,16 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -const result = faxApi.faxGet(faxId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxGet.php b/examples/FaxGet.php deleted file mode 100644 index 43b7a1f3e..000000000 --- a/examples/FaxGet.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $faxApi->faxGet($faxId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxGet.py b/examples/FaxGet.py deleted file mode 100644 index c56656833..000000000 --- a/examples/FaxGet.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = fax_api.fax_get(fax_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxGet.rb b/examples/FaxGet.rb deleted file mode 100644 index 64dc1c057..000000000 --- a/examples/FaxGet.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = fax_api.fax_get(fax_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxGet.ts b/examples/FaxGet.ts deleted file mode 100644 index 793f6e5d3..000000000 --- a/examples/FaxGet.ts +++ /dev/null @@ -1,16 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -const result = faxApi.faxGet(faxId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxGetExample.cs b/examples/FaxGetExample.cs new file mode 100644 index 000000000..8a15843d1 --- /dev/null +++ b/examples/FaxGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxGet( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxGetExample.java b/examples/FaxGetExample.java new file mode 100644 index 000000000..3db05bd4b --- /dev/null +++ b/examples/FaxGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxGetExample.php b/examples/FaxGetExample.php new file mode 100644 index 000000000..50bb7c865 --- /dev/null +++ b/examples/FaxGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxGet( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxGet: {$e->getMessage()}"; +} diff --git a/examples/FaxGetExample.py b/examples/FaxGetExample.py new file mode 100644 index 000000000..e1288e656 --- /dev/null +++ b/examples/FaxGetExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxApi(api_client).fax_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxApi#fax_get: %s\n" % e) diff --git a/examples/FaxGetExample.rb b/examples/FaxGetExample.rb new file mode 100644 index 000000000..692ae1c99 --- /dev/null +++ b/examples/FaxGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_get: #{e}" +end diff --git a/examples/FaxGet.sh b/examples/FaxGetExample.sh similarity index 100% rename from examples/FaxGet.sh rename to examples/FaxGetExample.sh diff --git a/examples/FaxGetExample.ts b/examples/FaxGetExample.ts new file mode 100644 index 000000000..56a87dbe7 --- /dev/null +++ b/examples/FaxGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxGet:"); + console.log(error.body); +}); diff --git a/examples/FaxLineAddUser.cs b/examples/FaxLineAddUser.cs deleted file mode 100644 index de22f454f..000000000 --- a/examples/FaxLineAddUser.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineAddUserRequest( - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com" - ); - - try - { - var result = faxLineApi.FaxLineAddUser(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineAddUser.java b/examples/FaxLineAddUser.java deleted file mode 100644 index 34e455d5a..000000000 --- a/examples/FaxLineAddUser.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineAddUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineAddUser(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineAddUser.js b/examples/FaxLineAddUser.js deleted file mode 100644 index 84e1e2c0e..000000000 --- a/examples/FaxLineAddUser.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineAddUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAddUser.php b/examples/FaxLineAddUser.php deleted file mode 100644 index 8fb6c0fef..000000000 --- a/examples/FaxLineAddUser.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineAddUserRequest(); -$data->setNumber("[FAX_NUMBER]") - ->setEmailAddress("member@dropboxsign.com"); - -try { - $result = $faxLineApi->faxLineAddUser($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineAddUser.py b/examples/FaxLineAddUser.py deleted file mode 100644 index cf5eceaab..000000000 --- a/examples/FaxLineAddUser.py +++ /dev/null @@ -1,22 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineAddUserRequest( - number="[FAX_NUMBER]", - email_address="member@dropboxsign.com", - ) - - try: - response = fax_line_api.fax_line_add_user(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineAddUser.rb b/examples/FaxLineAddUser.rb deleted file mode 100644 index 1ad855373..000000000 --- a/examples/FaxLineAddUser.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineAddUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" - -begin - result = fax_line_api.fax_line_add_user(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineAddUser.ts b/examples/FaxLineAddUser.ts deleted file mode 100644 index e5d705e94..000000000 --- a/examples/FaxLineAddUser.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineAddUserRequest = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineAddUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAddUserExample.cs b/examples/FaxLineAddUserExample.cs new file mode 100644 index 000000000..cb9c642f7 --- /dev/null +++ b/examples/FaxLineAddUserExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class 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); + } + } +} diff --git a/examples/FaxLineAddUserExample.java b/examples/FaxLineAddUserExample.java new file mode 100644 index 000000000..f3883223f --- /dev/null +++ b/examples/FaxLineAddUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineAddUserExample.php b/examples/FaxLineAddUserExample.php new file mode 100644 index 000000000..cca56e766 --- /dev/null +++ b/examples/FaxLineAddUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_add_user_request = (new Dropbox\Sign\Model\FaxLineAddUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAddUser( + fax_line_add_user_request: $fax_line_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAddUser: {$e->getMessage()}"; +} diff --git a/examples/FaxLineAddUserExample.py b/examples/FaxLineAddUserExample.py new file mode 100644 index 000000000..255ac248b --- /dev/null +++ b/examples/FaxLineAddUserExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_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) diff --git a/examples/FaxLineAddUserExample.rb b/examples/FaxLineAddUserExample.rb new file mode 100644 index 000000000..4d7f568bb --- /dev/null +++ b/examples/FaxLineAddUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_add_user_request = Dropbox::Sign::FaxLineAddUserRequest.new +fax_line_add_user_request.number = "[FAX_NUMBER]" +fax_line_add_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_add_user( + fax_line_add_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}" +end diff --git a/examples/FaxLineAddUser.sh b/examples/FaxLineAddUserExample.sh similarity index 100% rename from examples/FaxLineAddUser.sh rename to examples/FaxLineAddUserExample.sh diff --git a/examples/FaxLineAddUserExample.ts b/examples/FaxLineAddUserExample.ts new file mode 100644 index 000000000..468fe36a6 --- /dev/null +++ b/examples/FaxLineAddUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineAddUserRequest = new models.FaxLineAddUserRequest(); +faxLineAddUserRequest.number = "[FAX_NUMBER]"; +faxLineAddUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineAddUser( + faxLineAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAddUser:"); + console.log(error.body); +}); diff --git a/examples/FaxLineAreaCodeGet.cs b/examples/FaxLineAreaCodeGet.cs deleted file mode 100644 index 3beedfef1..000000000 --- a/examples/FaxLineAreaCodeGet.cs +++ /dev/null @@ -1,29 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - try - { - var result = faxLineApi.FaxLineAreaCodeGet("US", "CA"); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineAreaCodeGet.java b/examples/FaxLineAreaCodeGet.java deleted file mode 100644 index 1df071ab9..000000000 --- a/examples/FaxLineAreaCodeGet.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineAreaCodeGetResponse result = faxLineApi.faxLineAreaCodeGet("US", "CA"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineAreaCodeGet.js b/examples/FaxLineAreaCodeGet.js deleted file mode 100644 index bfc908f18..000000000 --- a/examples/FaxLineAreaCodeGet.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineAreaCodeGet("US", "CA"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAreaCodeGet.php b/examples/FaxLineAreaCodeGet.php deleted file mode 100644 index c19f9e187..000000000 --- a/examples/FaxLineAreaCodeGet.php +++ /dev/null @@ -1,19 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineAreaCodeGet("US", "CA"); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineAreaCodeGet.py b/examples/FaxLineAreaCodeGet.py deleted file mode 100644 index f001c0267..000000000 --- a/examples/FaxLineAreaCodeGet.py +++ /dev/null @@ -1,17 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - try: - response = fax_line_api.fax_line_area_code_get("US", "CA") - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineAreaCodeGet.rb b/examples/FaxLineAreaCodeGet.rb deleted file mode 100644 index 571fb4f58..000000000 --- a/examples/FaxLineAreaCodeGet.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_area_code_get("US", "CA") - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineAreaCodeGet.ts b/examples/FaxLineAreaCodeGet.ts deleted file mode 100644 index bfc908f18..000000000 --- a/examples/FaxLineAreaCodeGet.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineAreaCodeGet("US", "CA"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineAreaCodeGetExample.cs b/examples/FaxLineAreaCodeGetExample.cs new file mode 100644 index 000000000..b2b60876b --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineAreaCodeGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAreaCodeGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineAreaCodeGetExample.java b/examples/FaxLineAreaCodeGetExample.java new file mode 100644 index 000000000..0f2055863 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineAreaCodeGetExample.php b/examples/FaxLineAreaCodeGetExample.php new file mode 100644 index 000000000..dfd46d313 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAreaCodeGet: {$e->getMessage()}"; +} diff --git a/examples/FaxLineAreaCodeGetExample.py b/examples/FaxLineAreaCodeGetExample.py new file mode 100644 index 000000000..a2752d8d6 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_area_code_get( + country="US", + state=None, + province=None, + city=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) diff --git a/examples/FaxLineAreaCodeGetExample.rb b/examples/FaxLineAreaCodeGetExample.rb new file mode 100644 index 000000000..75c3a3c3e --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get( + "US", # country + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}" +end diff --git a/examples/FaxLineAreaCodeGet.sh b/examples/FaxLineAreaCodeGetExample.sh similarity index 100% rename from examples/FaxLineAreaCodeGet.sh rename to examples/FaxLineAreaCodeGetExample.sh diff --git a/examples/FaxLineAreaCodeGetExample.ts b/examples/FaxLineAreaCodeGetExample.ts new file mode 100644 index 000000000..0abb378b3 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineAreaCodeGet( + "US", // country + undefined, // state + undefined, // province + undefined, // city +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAreaCodeGet:"); + console.log(error.body); +}); diff --git a/examples/FaxLineCreate.cs b/examples/FaxLineCreate.cs deleted file mode 100644 index 4d96ae5b0..000000000 --- a/examples/FaxLineCreate.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineCreateRequest( - areaCode: 209, - country: "US" - ); - - try - { - var result = faxLineApi.FaxLineCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineCreate.java b/examples/FaxLineCreate.java deleted file mode 100644 index fca101895..000000000 --- a/examples/FaxLineCreate.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineCreateRequest() - .areaCode(209) - .country("US"); - - try { - FaxLineResponse result = faxLineApi.faxLineCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineCreate.js b/examples/FaxLineCreate.js deleted file mode 100644 index c4ee72c59..000000000 --- a/examples/FaxLineCreate.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - areaCode: 209, - country: "US", -}; - -const result = faxLineApi.faxLineCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineCreate.php b/examples/FaxLineCreate.php deleted file mode 100644 index 27a0d2b8a..000000000 --- a/examples/FaxLineCreate.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineCreateRequest(); -$data->setAreaCode(209) - ->setCountry("US"); - -try { - $result = $faxLineApi->faxLineCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineCreate.py b/examples/FaxLineCreate.py deleted file mode 100644 index bcbd585ea..000000000 --- a/examples/FaxLineCreate.py +++ /dev/null @@ -1,22 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineCreateRequest( - area_code=209, - country="US", - ) - - try: - response = fax_line_api.fax_line_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineCreate.rb b/examples/FaxLineCreate.rb deleted file mode 100644 index 2619678ae..000000000 --- a/examples/FaxLineCreate.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineCreateRequest.new -data.area_code = 209 -data.country = "US" - -begin - result = fax_line_api.fax_line_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineCreate.ts b/examples/FaxLineCreate.ts deleted file mode 100644 index 6ceeb71da..000000000 --- a/examples/FaxLineCreate.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineCreateRequest = { - areaCode: 209, - country: "US", -}; - -const result = faxLineApi.faxLineCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineCreateExample.cs b/examples/FaxLineCreateExample.cs new file mode 100644 index 000000000..802ea4045 --- /dev/null +++ b/examples/FaxLineCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineCreateRequest = new FaxLineCreateRequest( + areaCode: 209, + country: FaxLineCreateRequest.CountryEnum.US + ); + + try + { + var response = new FaxLineApi(config).FaxLineCreate( + faxLineCreateRequest: faxLineCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineCreateExample.java b/examples/FaxLineCreateExample.java new file mode 100644 index 000000000..d1a1fa689 --- /dev/null +++ b/examples/FaxLineCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineCreateExample.php b/examples/FaxLineCreateExample.php new file mode 100644 index 000000000..0a5ef5ec6 --- /dev/null +++ b/examples/FaxLineCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_create_request = (new Dropbox\Sign\Model\FaxLineCreateRequest()) + ->setAreaCode(209) + ->setCountry(Dropbox\Sign\Model\FaxLineCreateRequest::COUNTRY_US); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineCreate( + fax_line_create_request: $fax_line_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineCreate: {$e->getMessage()}"; +} diff --git a/examples/FaxLineCreateExample.py b/examples/FaxLineCreateExample.py new file mode 100644 index 000000000..3f7be1223 --- /dev/null +++ b/examples/FaxLineCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_create_request = models.FaxLineCreateRequest( + area_code=209, + country="US", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_create( + fax_line_create_request=fax_line_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_create: %s\n" % e) diff --git a/examples/FaxLineCreateExample.rb b/examples/FaxLineCreateExample.rb new file mode 100644 index 000000000..5342e5c31 --- /dev/null +++ b/examples/FaxLineCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new +fax_line_create_request.area_code = 209 +fax_line_create_request.country = "US" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_create( + fax_line_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_create: #{e}" +end diff --git a/examples/FaxLineCreate.sh b/examples/FaxLineCreateExample.sh similarity index 100% rename from examples/FaxLineCreate.sh rename to examples/FaxLineCreateExample.sh diff --git a/examples/FaxLineCreateExample.ts b/examples/FaxLineCreateExample.ts new file mode 100644 index 000000000..b9398b2fa --- /dev/null +++ b/examples/FaxLineCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineCreateRequest = new models.FaxLineCreateRequest(); +faxLineCreateRequest.areaCode = 209; +faxLineCreateRequest.country = models.FaxLineCreateRequest.CountryEnum.Us; + +apiCaller.faxLineCreate( + faxLineCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineCreate:"); + console.log(error.body); +}); diff --git a/examples/FaxLineDelete.cs b/examples/FaxLineDelete.cs deleted file mode 100644 index 810e268a3..000000000 --- a/examples/FaxLineDelete.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineDeleteRequest( - number: "[FAX_NUMBER]" - ); - - try - { - faxLineApi.FaxLineDelete(data); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineDelete.java b/examples/FaxLineDelete.java deleted file mode 100644 index 6b989d287..000000000 --- a/examples/FaxLineDelete.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineDeleteRequest() - .number("[FAX_NUMBER]"); - - try { - faxLineApi.faxLineDelete(data); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineDelete.js b/examples/FaxLineDelete.js deleted file mode 100644 index 1e8bdda7c..000000000 --- a/examples/FaxLineDelete.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", -}; - -const result = faxLineApi.faxLineDelete(data); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineDelete.php b/examples/FaxLineDelete.php deleted file mode 100644 index 8cc4ee01f..000000000 --- a/examples/FaxLineDelete.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineDeleteRequest(); -$data->setNumber("[FAX_NUMBER]"); - -try { - $faxLineApi->faxLineDelete($data); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineDelete.py b/examples/FaxLineDelete.py deleted file mode 100644 index 060303934..000000000 --- a/examples/FaxLineDelete.py +++ /dev/null @@ -1,20 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineDeleteRequest( - number="[FAX_NUMBER]", - ) - - try: - fax_line_api.fax_line_delete(data) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineDelete.rb b/examples/FaxLineDelete.rb deleted file mode 100644 index 001cf6275..000000000 --- a/examples/FaxLineDelete.rb +++ /dev/null @@ -1,17 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineDeleteRequest.new -data.number = "[FAX_NUMBER]" - -begin - fax_line_api.fax_line_delete(data) -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineDelete.ts b/examples/FaxLineDelete.ts deleted file mode 100644 index 14efef4dc..000000000 --- a/examples/FaxLineDelete.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineDeleteRequest = { - number: "[FAX_NUMBER]", -}; - -const result = faxLineApi.faxLineDelete(data); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineDeleteExample.cs b/examples/FaxLineDeleteExample.cs new file mode 100644 index 000000000..42faed216 --- /dev/null +++ b/examples/FaxLineDeleteExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineDeleteRequest = new FaxLineDeleteRequest( + number: "[FAX_NUMBER]" + ); + + try + { + new FaxLineApi(config).FaxLineDelete( + faxLineDeleteRequest: faxLineDeleteRequest + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineDeleteExample.java b/examples/FaxLineDeleteExample.java new file mode 100644 index 000000000..348833fba --- /dev/null +++ b/examples/FaxLineDeleteExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineDeleteExample.php b/examples/FaxLineDeleteExample.php new file mode 100644 index 000000000..080db2960 --- /dev/null +++ b/examples/FaxLineDeleteExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_delete_request = (new Dropbox\Sign\Model\FaxLineDeleteRequest()) + ->setNumber("[FAX_NUMBER]"); + +try { + (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineDelete( + fax_line_delete_request: $fax_line_delete_request, + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineDelete: {$e->getMessage()}"; +} diff --git a/examples/FaxLineDeleteExample.py b/examples/FaxLineDeleteExample.py new file mode 100644 index 000000000..e5e7c23ea --- /dev/null +++ b/examples/FaxLineDeleteExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_delete_request = models.FaxLineDeleteRequest( + number="[FAX_NUMBER]", + ) + + try: + api.FaxLineApi(api_client).fax_line_delete( + fax_line_delete_request=fax_line_delete_request, + ) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_delete: %s\n" % e) diff --git a/examples/FaxLineDeleteExample.rb b/examples/FaxLineDeleteExample.rb new file mode 100644 index 000000000..c54da52b1 --- /dev/null +++ b/examples/FaxLineDeleteExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new +fax_line_delete_request.number = "[FAX_NUMBER]" + +begin + Dropbox::Sign::FaxLineApi.new.fax_line_delete( + fax_line_delete_request, + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_delete: #{e}" +end diff --git a/examples/FaxLineDelete.sh b/examples/FaxLineDeleteExample.sh similarity index 100% rename from examples/FaxLineDelete.sh rename to examples/FaxLineDeleteExample.sh diff --git a/examples/FaxLineDeleteExample.ts b/examples/FaxLineDeleteExample.ts new file mode 100644 index 000000000..72b2279a3 --- /dev/null +++ b/examples/FaxLineDeleteExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineDeleteRequest = new models.FaxLineDeleteRequest(); +faxLineDeleteRequest.number = "[FAX_NUMBER]"; + +apiCaller.faxLineDelete( + faxLineDeleteRequest, +).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineDelete:"); + console.log(error.body); +}); diff --git a/examples/FaxLineGet.cs b/examples/FaxLineGet.cs deleted file mode 100644 index d18c82fab..000000000 --- a/examples/FaxLineGet.cs +++ /dev/null @@ -1,29 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - try - { - var result = faxLineApi.FaxLineGet("[FAX_NUMBER]"); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineGet.java b/examples/FaxLineGet.java deleted file mode 100644 index 69281b342..000000000 --- a/examples/FaxLineGet.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineResponse result = faxLineApi.faxLineGet("[FAX_NUMBER]"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineGet.js b/examples/FaxLineGet.js deleted file mode 100644 index e9643abe9..000000000 --- a/examples/FaxLineGet.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineGet("[FAX_NUMBER]"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineGet.php b/examples/FaxLineGet.php deleted file mode 100644 index 75dd77b5c..000000000 --- a/examples/FaxLineGet.php +++ /dev/null @@ -1,19 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineGet("[FAX_NUMBER]"); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineGet.py b/examples/FaxLineGet.py deleted file mode 100644 index f550474fa..000000000 --- a/examples/FaxLineGet.py +++ /dev/null @@ -1,17 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - try: - response = fax_line_api.fax_line_get("[FAX_NUMBER]") - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineGet.rb b/examples/FaxLineGet.rb deleted file mode 100644 index 090c2bdd8..000000000 --- a/examples/FaxLineGet.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_get("[NUMBER]") - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineGet.ts b/examples/FaxLineGet.ts deleted file mode 100644 index e9643abe9..000000000 --- a/examples/FaxLineGet.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineGet("[FAX_NUMBER]"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineGetExample.cs b/examples/FaxLineGetExample.cs new file mode 100644 index 000000000..690a65360 --- /dev/null +++ b/examples/FaxLineGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineGet( + number: "123-123-1234" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineGetExample.java b/examples/FaxLineGetExample.java new file mode 100644 index 000000000..8f9cd3169 --- /dev/null +++ b/examples/FaxLineGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineGetExample.php b/examples/FaxLineGetExample.php new file mode 100644 index 000000000..70004942a --- /dev/null +++ b/examples/FaxLineGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineGet( + number: "123-123-1234", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineGet: {$e->getMessage()}"; +} diff --git a/examples/FaxLineGetExample.py b/examples/FaxLineGetExample.py new file mode 100644 index 000000000..56d2a204d --- /dev/null +++ b/examples/FaxLineGetExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_get( + number="123-123-1234", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_get: %s\n" % e) diff --git a/examples/FaxLineGetExample.rb b/examples/FaxLineGetExample.rb new file mode 100644 index 000000000..d4a749bd8 --- /dev/null +++ b/examples/FaxLineGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_get( + "123-123-1234", # number + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_get: #{e}" +end diff --git a/examples/FaxLineGet.sh b/examples/FaxLineGetExample.sh similarity index 100% rename from examples/FaxLineGet.sh rename to examples/FaxLineGetExample.sh diff --git a/examples/FaxLineGetExample.ts b/examples/FaxLineGetExample.ts new file mode 100644 index 000000000..e5ee2fd0f --- /dev/null +++ b/examples/FaxLineGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineGet( + "123-123-1234", // number +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineGet:"); + console.log(error.body); +}); diff --git a/examples/FaxLineList.cs b/examples/FaxLineList.cs deleted file mode 100644 index 96d7f0c28..000000000 --- a/examples/FaxLineList.cs +++ /dev/null @@ -1,29 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - try - { - var result = faxLineApi.FaxLineList(); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineList.java b/examples/FaxLineList.java deleted file mode 100644 index df1d0bd13..000000000 --- a/examples/FaxLineList.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineListResponse result = faxLineApi.faxLineList(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineList.js b/examples/FaxLineList.js deleted file mode 100644 index f40c60dfa..000000000 --- a/examples/FaxLineList.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineList(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineList.php b/examples/FaxLineList.php deleted file mode 100644 index 6056a2427..000000000 --- a/examples/FaxLineList.php +++ /dev/null @@ -1,19 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -try { - $result = $faxLineApi->faxLineList(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineList.py b/examples/FaxLineList.py deleted file mode 100644 index f868cd43c..000000000 --- a/examples/FaxLineList.py +++ /dev/null @@ -1,17 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - try: - response = fax_line_api.fax_line_list() - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineList.rb b/examples/FaxLineList.rb deleted file mode 100644 index 23a0ec845..000000000 --- a/examples/FaxLineList.rb +++ /dev/null @@ -1,15 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -begin - result = fax_line_api.fax_line_list() - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineList.ts b/examples/FaxLineList.ts deleted file mode 100644 index f40c60dfa..000000000 --- a/examples/FaxLineList.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineList(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineListExample.cs b/examples/FaxLineListExample.cs new file mode 100644 index 000000000..cbd75903e --- /dev/null +++ b/examples/FaxLineListExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineList( + accountId: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + pageSize: 20, + showTeamLines: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineListExample.java b/examples/FaxLineListExample.java new file mode 100644 index 000000000..7ce8cf1cf --- /dev/null +++ b/examples/FaxLineListExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineListExample.php b/examples/FaxLineListExample.php new file mode 100644 index 000000000..995c0d949 --- /dev/null +++ b/examples/FaxLineListExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineList( + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineList: {$e->getMessage()}"; +} diff --git a/examples/FaxLineListExample.py b/examples/FaxLineListExample.py new file mode 100644 index 000000000..4af3f4a56 --- /dev/null +++ b/examples/FaxLineListExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_list( + account_id="ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page=1, + page_size=20, + show_team_lines=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) diff --git a/examples/FaxLineListExample.rb b/examples/FaxLineListExample.rb new file mode 100644 index 000000000..0da5a39e4 --- /dev/null +++ b/examples/FaxLineListExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_list( + { + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_list: #{e}" +end diff --git a/examples/FaxLineList.sh b/examples/FaxLineListExample.sh similarity index 100% rename from examples/FaxLineList.sh rename to examples/FaxLineListExample.sh diff --git a/examples/FaxLineListExample.ts b/examples/FaxLineListExample.ts new file mode 100644 index 000000000..aa547afce --- /dev/null +++ b/examples/FaxLineListExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + undefined, // showTeamLines +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineList:"); + console.log(error.body); +}); diff --git a/examples/FaxLineRemoveUser.cs b/examples/FaxLineRemoveUser.cs deleted file mode 100644 index 1dd562ed6..000000000 --- a/examples/FaxLineRemoveUser.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineRemoveUserRequest( - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com" - ); - - try - { - var result = faxLineApi.FaxLineRemoveUser(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxLineRemoveUser.java b/examples/FaxLineRemoveUser.java deleted file mode 100644 index 7864b05ab..000000000 --- a/examples/FaxLineRemoveUser.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineRemoveUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineRemoveUser(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxLineRemoveUser.js b/examples/FaxLineRemoveUser.js deleted file mode 100644 index 64f247924..000000000 --- a/examples/FaxLineRemoveUser.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineRemoveUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineRemoveUser.php b/examples/FaxLineRemoveUser.php deleted file mode 100644 index 60132fedc..000000000 --- a/examples/FaxLineRemoveUser.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); - -$data = new Dropbox\Sign\Model\FaxLineRemoveUserRequest(); -$data->setNumber("[FAX_NUMBER]") - ->setEmailAddress("member@dropboxsign.com"); - -try { - $result = $faxLineApi->faxLineRemoveUser($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxLineRemoveUser.py b/examples/FaxLineRemoveUser.py deleted file mode 100644 index d6929502b..000000000 --- a/examples/FaxLineRemoveUser.py +++ /dev/null @@ -1,22 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineRemoveUserRequest( - number="[FAX_NUMBER]", - email_address="member@dropboxsign.com", - ) - - try: - response = fax_line_api.fax_line_remove_user(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxLineRemoveUser.rb b/examples/FaxLineRemoveUser.rb deleted file mode 100644 index 98bb7a047..000000000 --- a/examples/FaxLineRemoveUser.rb +++ /dev/null @@ -1,19 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineRemoveUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" - -begin - result = fax_line_api.fax_line_remove_user(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxLineRemoveUser.ts b/examples/FaxLineRemoveUser.ts deleted file mode 100644 index 91dc3066b..000000000 --- a/examples/FaxLineRemoveUser.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineRemoveUserRequest = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineRemoveUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxLineRemoveUserExample.cs b/examples/FaxLineRemoveUserExample.cs new file mode 100644 index 000000000..809b89a4e --- /dev/null +++ b/examples/FaxLineRemoveUserExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest( + number: "[FAX_NUMBER]", + emailAddress: "member@dropboxsign.com" + ); + + try + { + var response = new FaxLineApi(config).FaxLineRemoveUser( + faxLineRemoveUserRequest: faxLineRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxLineRemoveUserExample.java b/examples/FaxLineRemoveUserExample.java new file mode 100644 index 000000000..568d08d5d --- /dev/null +++ b/examples/FaxLineRemoveUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxLineRemoveUserExample.php b/examples/FaxLineRemoveUserExample.php new file mode 100644 index 000000000..95d117971 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_remove_user_request = (new Dropbox\Sign\Model\FaxLineRemoveUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineRemoveUser( + fax_line_remove_user_request: $fax_line_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineRemoveUser: {$e->getMessage()}"; +} diff --git a/examples/FaxLineRemoveUserExample.py b/examples/FaxLineRemoveUserExample.py new file mode 100644 index 000000000..366957bac --- /dev/null +++ b/examples/FaxLineRemoveUserExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_remove_user_request = models.FaxLineRemoveUserRequest( + number="[FAX_NUMBER]", + email_address="member@dropboxsign.com", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_remove_user( + fax_line_remove_user_request=fax_line_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_remove_user: %s\n" % e) diff --git a/examples/FaxLineRemoveUserExample.rb b/examples/FaxLineRemoveUserExample.rb new file mode 100644 index 000000000..4f67f7e11 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new +fax_line_remove_user_request.number = "[FAX_NUMBER]" +fax_line_remove_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user( + fax_line_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}" +end diff --git a/examples/FaxLineRemoveUser.sh b/examples/FaxLineRemoveUserExample.sh similarity index 100% rename from examples/FaxLineRemoveUser.sh rename to examples/FaxLineRemoveUserExample.sh diff --git a/examples/FaxLineRemoveUserExample.ts b/examples/FaxLineRemoveUserExample.ts new file mode 100644 index 000000000..e73b8c7c5 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineRemoveUserRequest = new models.FaxLineRemoveUserRequest(); +faxLineRemoveUserRequest.number = "[FAX_NUMBER]"; +faxLineRemoveUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineRemoveUser( + faxLineRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineRemoveUser:"); + console.log(error.body); +}); diff --git a/examples/FaxList.cs b/examples/FaxList.cs deleted file mode 100644 index f87d9b8f2..000000000 --- a/examples/FaxList.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - var faxApi = new FaxApi(config); - - var page = 1; - var pageSize = 2; - - try - { - var result = faxApi.FaxList(page, pageSize); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxList.java b/examples/FaxList.java deleted file mode 100644 index 042bb7107..000000000 --- a/examples/FaxList.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - FaxListResponse result = faxApi.faxList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxList.js b/examples/FaxList.js deleted file mode 100644 index 385f44779..000000000 --- a/examples/FaxList.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const page = 1; -const pageSize = 2; - -const result = faxApi.faxList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxList.php b/examples/FaxList.php deleted file mode 100644 index d2a513c21..000000000 --- a/examples/FaxList.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$page = 1; -$pageSize = 2; - -try { - $result = $faxApi->faxList($page, $pageSize); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxList.py b/examples/FaxList.py deleted file mode 100644 index 6b71f79b6..000000000 --- a/examples/FaxList.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - page = 1 - page_size = 2 - - try: - response = fax_api.fax_list( - page=page, - page_size=page_size, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxList.rb b/examples/FaxList.rb deleted file mode 100644 index 3f37a71ea..000000000 --- a/examples/FaxList.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -page = 1 -page_size = 2 - -begin - result = fax_api.fax_list({ page: page, page_size: page_size }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxList.ts b/examples/FaxList.ts deleted file mode 100644 index 385f44779..000000000 --- a/examples/FaxList.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const page = 1; -const pageSize = 2; - -const result = faxApi.faxList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxListExample.cs b/examples/FaxListExample.cs new file mode 100644 index 000000000..64450619d --- /dev/null +++ b/examples/FaxListExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxListExample.java b/examples/FaxListExample.java new file mode 100644 index 000000000..1ca7c0a54 --- /dev/null +++ b/examples/FaxListExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxListExample.php b/examples/FaxListExample.php new file mode 100644 index 000000000..c0d432351 --- /dev/null +++ b/examples/FaxListExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxList: {$e->getMessage()}"; +} diff --git a/examples/FaxListExample.py b/examples/FaxListExample.py new file mode 100644 index 000000000..44f840a7f --- /dev/null +++ b/examples/FaxListExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +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) diff --git a/examples/FaxListExample.rb b/examples/FaxListExample.rb new file mode 100644 index 000000000..519e04dad --- /dev/null +++ b/examples/FaxListExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_list: #{e}" +end diff --git a/examples/FaxList.sh b/examples/FaxListExample.sh similarity index 100% rename from examples/FaxList.sh rename to examples/FaxListExample.sh diff --git a/examples/FaxListExample.ts b/examples/FaxListExample.ts new file mode 100644 index 000000000..70b904d6f --- /dev/null +++ b/examples/FaxListExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxList:"); + console.log(error.body); +}); diff --git a/examples/FaxSend.cs b/examples/FaxSend.cs deleted file mode 100644 index 8e72a4f93..000000000 --- a/examples/FaxSend.cs +++ /dev/null @@ -1,49 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - config.Username = "YOUR_API_KEY"; - - var faxApi = new FaxApi(config); - - var files = new List { - new FileStream( - "./example_fax.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new FaxSendRequest( - files: files, - testMode: true, - recipient: "16690000001", - sender: "16690000000", - coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", - coverPageFrom: "Faxer Faxerson", - title: "This is what the fax is about!", - ); - - try - { - var result = faxApi.FaxSend(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/FaxSend.java b/examples/FaxSend.java deleted file mode 100644 index 4e764da83..000000000 --- a/examples/FaxSend.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - - var data = new FaxSendRequest() - .addFilesItem(new File("example_fax.pdf")) - .testMode(true) - .recipient("16690000001") - .sender("16690000000") - .coverPageTo("Jill Fax") - .coverPageMessage("I'm sending you a fax!") - .coverPageFrom("Faxer Faxerson") - .title("This is what the fax is about!"); - - try { - FaxCreateResponse result = faxApi.faxSend(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/FaxSend.js b/examples/FaxSend.js deleted file mode 100644 index 4b0eef2da..000000000 --- a/examples/FaxSend.js +++ /dev/null @@ -1,47 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data = { - files: [ file, fileBuffer, fileBufferAlt ], - testMode: true, - recipient: "16690000001", - sender: "16690000000", - coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", - coverPageFrom: "Faxer Faxerson", - title: "This is what the fax is about!", -}; - -const result = faxApi.faxSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxSend.php b/examples/FaxSend.php deleted file mode 100644 index 2dd42d386..000000000 --- a/examples/FaxSend.php +++ /dev/null @@ -1,29 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$faxApi = new Dropbox\Sign\Api\FaxApi($config); - -$data = new Dropbox\Sign\Model\FaxSendRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTestMode(true) - ->setRecipient("16690000001") - ->setSender("16690000000") - ->setCoverPageTo("Jill Fax") - ->setCoverPageMessage("I'm sending you a fax!") - ->setCoverPageFrom("Faxer Faxerson") - ->setTitle("This is what the fax is about!"); - -try { - $result = $faxApi->faxSend($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/FaxSend.py b/examples/FaxSend.py deleted file mode 100644 index c24d6ada7..000000000 --- a/examples/FaxSend.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", -) - -with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - data = models.FaxSendRequest( - files=[open("example_signature_request.pdf", "rb")], - test_mode=True, - 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!", - ) - - try: - response = fax_api.fax_send(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/FaxSend.rb b/examples/FaxSend.rb deleted file mode 100644 index c37cbbd10..000000000 --- a/examples/FaxSend.rb +++ /dev/null @@ -1,25 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" -end - -fax_api = Dropbox::Sign::FaxApi.new - -data = Dropbox::Sign::FaxSendRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] -data.test_mode = true -data.recipient = "16690000001" -data.sender = "16690000000" -data.cover_page_to = "Jill Fax" -data.cover_page_message = "I'm sending you a fax!" -data.cover_page_from = "Faxer Faxerson" -data.title = "This is what the fax is about!" - -begin - result = fax_api.fax_send(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/FaxSend.ts b/examples/FaxSend.ts deleted file mode 100644 index 2f3f6e25d..000000000 --- a/examples/FaxSend.ts +++ /dev/null @@ -1,47 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.FaxSendRequest = { - files: [ file, fileBuffer, fileBufferAlt ], - testMode: true, - recipient: "16690000001", - sender: "16690000000", - coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", - coverPageFrom: "Faxer Faxerson", - title: "This is what the fax is about!", -}; - -const result = faxApi.faxSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/FaxSendExample.cs b/examples/FaxSendExample.cs new file mode 100644 index 000000000..e6a2270be --- /dev/null +++ b/examples/FaxSendExample.cs @@ -0,0 +1,51 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxSendRequest = new FaxSendRequest( + recipient: "16690000001", + sender: "16690000000", + testMode: true, + coverPageTo: "Jill Fax", + coverPageFrom: "Faxer Faxerson", + coverPageMessage: "I'm sending you a fax!", + title: "This is what the fax is about!", + files: new List + { + new FileStream( + path: "./example_fax.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new FaxApi(config).FaxSend( + faxSendRequest: faxSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/FaxSendExample.java b/examples/FaxSendExample.java new file mode 100644 index 000000000..62696b80d --- /dev/null +++ b/examples/FaxSendExample.java @@ -0,0 +1,51 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/FaxSendExample.php b/examples/FaxSendExample.php new file mode 100644 index 000000000..707e8ce25 --- /dev/null +++ b/examples/FaxSendExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); + +$fax_send_request = (new Dropbox\Sign\Model\FaxSendRequest()) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setTestMode(true) + ->setCoverPageTo("Jill Fax") + ->setCoverPageFrom("Faxer Faxerson") + ->setCoverPageMessage("I'm sending you a fax!") + ->setTitle("This is what the fax is about!") + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxSend( + fax_send_request: $fax_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxSend: {$e->getMessage()}"; +} diff --git a/examples/FaxSendExample.py b/examples/FaxSendExample.py new file mode 100644 index 000000000..77fbf8bbf --- /dev/null +++ b/examples/FaxSendExample.py @@ -0,0 +1,32 @@ +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) diff --git a/examples/FaxSendExample.rb b/examples/FaxSendExample.rb new file mode 100644 index 000000000..4faeaa725 --- /dev/null +++ b/examples/FaxSendExample.rb @@ -0,0 +1,28 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_send_request = Dropbox::Sign::FaxSendRequest.new +fax_send_request.recipient = "16690000001" +fax_send_request.sender = "16690000000" +fax_send_request.test_mode = true +fax_send_request.cover_page_to = "Jill Fax" +fax_send_request.cover_page_from = "Faxer Faxerson" +fax_send_request.cover_page_message = "I'm sending you a fax!" +fax_send_request.title = "This is what the fax is about!" +fax_send_request.files = [ + File.new("./example_fax.pdf", "r"), +] + +begin + response = Dropbox::Sign::FaxApi.new.fax_send( + fax_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_send: #{e}" +end diff --git a/examples/FaxSend.sh b/examples/FaxSendExample.sh similarity index 100% rename from examples/FaxSend.sh rename to examples/FaxSendExample.sh diff --git a/examples/FaxSendExample.ts b/examples/FaxSendExample.ts new file mode 100644 index 000000000..0b39faee5 --- /dev/null +++ b/examples/FaxSendExample.ts @@ -0,0 +1,27 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxSendRequest = new models.FaxSendRequest(); +faxSendRequest.recipient = "16690000001"; +faxSendRequest.sender = "16690000000"; +faxSendRequest.testMode = true; +faxSendRequest.coverPageTo = "Jill Fax"; +faxSendRequest.coverPageFrom = "Faxer Faxerson"; +faxSendRequest.coverPageMessage = "I'm sending you a fax!"; +faxSendRequest.title = "This is what the fax is about!"; +faxSendRequest.files = [ + fs.createReadStream("./example_fax.pdf"), +]; + +apiCaller.faxSend( + faxSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxSend:"); + console.log(error.body); +}); diff --git a/examples/OauthTokenGenerate.cs b/examples/OauthTokenGenerate.cs deleted file mode 100644 index f76153ba4..000000000 --- a/examples/OauthTokenGenerate.cs +++ /dev/null @@ -1,35 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - - var oAuthApi = new OAuthApi(config); - - var data = new OAuthTokenGenerateRequest( - state: "900e06e2", - code: "1b0d28d90c86c141", - clientId: "cc91c61d00f8bb2ece1428035716b", - clientSecret: "1d14434088507ffa390e6f5528465" - ); - - try - { - var result = oAuthApi.OauthTokenGenerate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/OauthTokenGenerate.java b/examples/OauthTokenGenerate.java deleted file mode 100644 index b8a5ebf30..000000000 --- a/examples/OauthTokenGenerate.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenGenerateRequest() - .state("900e06e2") - .code("1b0d28d90c86c141") - .clientId("cc91c61d00f8bb2ece1428035716b") - .clientSecret("1d14434088507ffa390e6f5528465"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenGenerate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/OauthTokenGenerate.js b/examples/OauthTokenGenerate.js deleted file mode 100644 index 20a34133c..000000000 --- a/examples/OauthTokenGenerate.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenGenerateRequest(); -data.state = "900e06e2"; -data.code = "1b0d28d90c86c141"; -data.clientId = "cc91c61d00f8bb2ece1428035716b"; -data.clientSecret = "1d14434088507ffa390e6f5528465"; - -const result = oAuthApi.oauthTokenGenerate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenGenerate.php b/examples/OauthTokenGenerate.php deleted file mode 100644 index d90201e92..000000000 --- a/examples/OauthTokenGenerate.php +++ /dev/null @@ -1,22 +0,0 @@ -setState("900e06e2") - ->setCode("1b0d28d90c86c141") - ->setClientId("cc91c61d00f8bb2ece1428035716b") - ->setClientSecret("1d14434088507ffa390e6f5528465"); - -try { - $result = $oauthApi->oauthTokenGenerate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/OauthTokenGenerate.py b/examples/OauthTokenGenerate.py deleted file mode 100644 index abe76c7e0..000000000 --- a/examples/OauthTokenGenerate.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration() - -with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenGenerateRequest( - state="900e06e2", - code="1b0d28d90c86c141", - client_id="cc91c61d00f8bb2ece1428035716b", - client_secret="1d14434088507ffa390e6f5528465", - ) - - try: - response = oauth_api.oauth_token_generate(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/OauthTokenGenerate.rb b/examples/OauthTokenGenerate.rb deleted file mode 100644 index b5b38c8fe..000000000 --- a/examples/OauthTokenGenerate.rb +++ /dev/null @@ -1,16 +0,0 @@ -require "dropbox-sign" - -oauth_api = Dropbox::Sign::OAuthApi.new - -data = Dropbox::Sign::OAuthTokenGenerateRequest.new -data.state = "900e06e2" -data.code = "1b0d28d90c86c141" -data.client_id = "cc91c61d00f8bb2ece1428035716b" -data.client_secret = "1d14434088507ffa390e6f5528465" - -begin - result = oauth_api.oauth_token_generate(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/OauthTokenGenerate.ts b/examples/OauthTokenGenerate.ts deleted file mode 100644 index 20a34133c..000000000 --- a/examples/OauthTokenGenerate.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenGenerateRequest(); -data.state = "900e06e2"; -data.code = "1b0d28d90c86c141"; -data.clientId = "cc91c61d00f8bb2ece1428035716b"; -data.clientSecret = "1d14434088507ffa390e6f5528465"; - -const result = oAuthApi.oauthTokenGenerate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenGenerateExample.cs b/examples/OauthTokenGenerateExample.cs new file mode 100644 index 000000000..7d8da2fca --- /dev/null +++ b/examples/OauthTokenGenerateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenGenerateExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest( + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465", + code: "1b0d28d90c86c141", + state: "900e06e2", + grantType: "authorization_code" + ); + + try + { + var response = new OAuthApi(config).OauthTokenGenerate( + oAuthTokenGenerateRequest: oAuthTokenGenerateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenGenerate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/OauthTokenGenerateExample.java b/examples/OauthTokenGenerateExample.java new file mode 100644 index 000000000..7c51af01f --- /dev/null +++ b/examples/OauthTokenGenerateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenGenerate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/OauthTokenGenerateExample.php b/examples/OauthTokenGenerateExample.php new file mode 100644 index 000000000..9b2df4a08 --- /dev/null +++ b/examples/OauthTokenGenerateExample.php @@ -0,0 +1,27 @@ +setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465") + ->setCode("1b0d28d90c86c141") + ->setState("900e06e2") + ->setGrantType("authorization_code"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenGenerate( + o_auth_token_generate_request: $o_auth_token_generate_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenGenerate: {$e->getMessage()}"; +} diff --git a/examples/OauthTokenGenerateExample.py b/examples/OauthTokenGenerateExample.py new file mode 100644 index 000000000..69cec3ffd --- /dev/null +++ b/examples/OauthTokenGenerateExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( +) + +with ApiClient(configuration) as api_client: + o_auth_token_generate_request = models.OAuthTokenGenerateRequest( + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + code="1b0d28d90c86c141", + state="900e06e2", + grant_type="authorization_code", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_generate( + o_auth_token_generate_request=o_auth_token_generate_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_generate: %s\n" % e) diff --git a/examples/OauthTokenGenerateExample.rb b/examples/OauthTokenGenerateExample.rb new file mode 100644 index 000000000..47553822e --- /dev/null +++ b/examples/OauthTokenGenerateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new +o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b" +o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465" +o_auth_token_generate_request.code = "1b0d28d90c86c141" +o_auth_token_generate_request.state = "900e06e2" +o_auth_token_generate_request.grant_type = "authorization_code" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_generate( + o_auth_token_generate_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_generate: #{e}" +end diff --git a/examples/OauthTokenGenerate.sh b/examples/OauthTokenGenerateExample.sh similarity index 100% rename from examples/OauthTokenGenerate.sh rename to examples/OauthTokenGenerateExample.sh diff --git a/examples/OauthTokenGenerateExample.ts b/examples/OauthTokenGenerateExample.ts new file mode 100644 index 000000000..ace0df01d --- /dev/null +++ b/examples/OauthTokenGenerateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenGenerateRequest = new models.OAuthTokenGenerateRequest(); +oAuthTokenGenerateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +oAuthTokenGenerateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; +oAuthTokenGenerateRequest.code = "1b0d28d90c86c141"; +oAuthTokenGenerateRequest.state = "900e06e2"; +oAuthTokenGenerateRequest.grantType = "authorization_code"; + +apiCaller.oauthTokenGenerate( + oAuthTokenGenerateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenGenerate:"); + console.log(error.body); +}); diff --git a/examples/OauthTokenRefresh.cs b/examples/OauthTokenRefresh.cs deleted file mode 100644 index 41f3235ee..000000000 --- a/examples/OauthTokenRefresh.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - - var oAuthApi = new OAuthApi(config); - - var data = new OAuthTokenRefreshRequest( - refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" - ); - - try - { - var result = oAuthApi.OauthTokenRefresh(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/OauthTokenRefresh.java b/examples/OauthTokenRefresh.java deleted file mode 100644 index 8add0c186..000000000 --- a/examples/OauthTokenRefresh.java +++ /dev/null @@ -1,27 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenRefreshRequest() - .refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenRefresh(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/OauthTokenRefresh.js b/examples/OauthTokenRefresh.js deleted file mode 100644 index da46f9f1e..000000000 --- a/examples/OauthTokenRefresh.js +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenRefreshRequest(); -data.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; - -const result = oAuthApi.oauthTokenRefresh(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenRefresh.php b/examples/OauthTokenRefresh.php deleted file mode 100644 index ad3e7ad26..000000000 --- a/examples/OauthTokenRefresh.php +++ /dev/null @@ -1,19 +0,0 @@ -setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - -try { - $result = $oauthApi->oauthTokenRefresh($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/OauthTokenRefresh.py b/examples/OauthTokenRefresh.py deleted file mode 100644 index fb6d5e36d..000000000 --- a/examples/OauthTokenRefresh.py +++ /dev/null @@ -1,18 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration() - -with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenRefreshRequest( - refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", - ) - - try: - response = oauth_api.oauth_token_refresh(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/OauthTokenRefresh.rb b/examples/OauthTokenRefresh.rb deleted file mode 100644 index bac7eb63c..000000000 --- a/examples/OauthTokenRefresh.rb +++ /dev/null @@ -1,13 +0,0 @@ -require "dropbox-sign" - -oauth_api = Dropbox::Sign::OAuthApi.new - -data = Dropbox::Sign::OAuthTokenRefreshRequest.new -data.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" - -begin - result = oauth_api.oauth_token_refresh(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/OauthTokenRefresh.ts b/examples/OauthTokenRefresh.ts deleted file mode 100644 index da46f9f1e..000000000 --- a/examples/OauthTokenRefresh.ts +++ /dev/null @@ -1,14 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenRefreshRequest(); -data.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; - -const result = oAuthApi.oauthTokenRefresh(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/OauthTokenRefreshExample.cs b/examples/OauthTokenRefreshExample.cs new file mode 100644 index 000000000..21c40d14c --- /dev/null +++ b/examples/OauthTokenRefreshExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenRefreshExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest( + grantType: "refresh_token", + refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + ); + + try + { + var response = new OAuthApi(config).OauthTokenRefresh( + oAuthTokenRefreshRequest: oAuthTokenRefreshRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenRefresh: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/OauthTokenRefreshExample.java b/examples/OauthTokenRefreshExample.java new file mode 100644 index 000000000..5b2133b0e --- /dev/null +++ b/examples/OauthTokenRefreshExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenRefresh"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/OauthTokenRefreshExample.php b/examples/OauthTokenRefreshExample.php new file mode 100644 index 000000000..519db72d1 --- /dev/null +++ b/examples/OauthTokenRefreshExample.php @@ -0,0 +1,24 @@ +setGrantType("refresh_token") + ->setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenRefresh( + o_auth_token_refresh_request: $o_auth_token_refresh_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenRefresh: {$e->getMessage()}"; +} diff --git a/examples/OauthTokenRefreshExample.py b/examples/OauthTokenRefreshExample.py new file mode 100644 index 000000000..7bd30fbf8 --- /dev/null +++ b/examples/OauthTokenRefreshExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( +) + +with ApiClient(configuration) as api_client: + o_auth_token_refresh_request = models.OAuthTokenRefreshRequest( + grant_type="refresh_token", + refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_refresh( + o_auth_token_refresh_request=o_auth_token_refresh_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_refresh: %s\n" % e) diff --git a/examples/OauthTokenRefreshExample.rb b/examples/OauthTokenRefreshExample.rb new file mode 100644 index 000000000..5068b44da --- /dev/null +++ b/examples/OauthTokenRefreshExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new +o_auth_token_refresh_request.grant_type = "refresh_token" +o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh( + o_auth_token_refresh_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}" +end diff --git a/examples/OauthTokenRefresh.sh b/examples/OauthTokenRefreshExample.sh similarity index 100% rename from examples/OauthTokenRefresh.sh rename to examples/OauthTokenRefreshExample.sh diff --git a/examples/OauthTokenRefreshExample.ts b/examples/OauthTokenRefreshExample.ts new file mode 100644 index 000000000..fa9973e6f --- /dev/null +++ b/examples/OauthTokenRefreshExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenRefreshRequest = new models.OAuthTokenRefreshRequest(); +oAuthTokenRefreshRequest.grantType = "refresh_token"; +oAuthTokenRefreshRequest.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; + +apiCaller.oauthTokenRefresh( + oAuthTokenRefreshRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenRefresh:"); + console.log(error.body); +}); diff --git a/examples/ReportCreate.cs b/examples/ReportCreate.cs deleted file mode 100644 index 994169a54..000000000 --- a/examples/ReportCreate.cs +++ /dev/null @@ -1,42 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var reportApi = new ReportApi(config); - - var data = new ReportCreateRequest( - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: new List() { - ReportCreateRequest.ReportTypeEnum.UserActivity, - ReportCreateRequest.ReportTypeEnum.DocumentStatus, - } - ); - - try - { - var result = reportApi.OauthCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/ReportCreate.java b/examples/ReportCreate.java deleted file mode 100644 index 038f03b9f..000000000 --- a/examples/ReportCreate.java +++ /dev/null @@ -1,41 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var reportApi = new ReportApi(apiClient); - - var data = new ReportCreateRequest() - .startDate("09/01/2020") - .endDate("09/01/2020") - .reportType(List.of( - ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, - ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS - )); - - try { - ReportCreateResponse result = reportApi.reportCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/ReportCreate.js b/examples/ReportCreate.js deleted file mode 100644 index 738b12ac3..000000000 --- a/examples/ReportCreate.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const reportApi = new DropboxSign.ReportApi(); - -// Configure HTTP basic authorization: api_key -reportApi.username = "YOUR_API_KEY"; - -const data = { - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: [ - "user_activity", - "document_status", - ] -}; - -const result = reportApi.reportCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ReportCreate.php b/examples/ReportCreate.php deleted file mode 100644 index 1f030f6e5..000000000 --- a/examples/ReportCreate.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$reportApi = new Dropbox\Sign\Api\ReportApi($config); - -$data = new Dropbox\Sign\Model\ReportCreateRequest(); -$data->setStartDate("09/01/2020") - ->setEndDate("09/01/2020") - ->setReportType([ - Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, - Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, - ]); - -try { - $result = $reportApi->reportCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/ReportCreate.py b/examples/ReportCreate.py deleted file mode 100644 index e736c4a77..000000000 --- a/examples/ReportCreate.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - report_api = apis.ReportApi(api_client) - - data = models.ReportCreateRequest( - start_date="09/01/2020", - end_date="09/01/2020", - report_type=["user_activity" "document_status"], - ) - - try: - response = report_api.report_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/ReportCreate.rb b/examples/ReportCreate.rb deleted file mode 100644 index 71da9d1f6..000000000 --- a/examples/ReportCreate.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -report_api = Dropbox::Sign::ReportApi.new - -data = Dropbox::Sign::ReportCreateRequest.new -data.start_date = "09/01/2020" -data.end_date = "09/01/2020" -data.report_type = %w[user_activity document_status] - -begin - result = report_api.report_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/ReportCreate.ts b/examples/ReportCreate.ts deleted file mode 100644 index 39da03ca6..000000000 --- a/examples/ReportCreate.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const reportApi = new DropboxSign.ReportApi(); - -// Configure HTTP basic authorization: api_key -reportApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.ReportCreateRequest = { - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: [ - DropboxSign.ReportCreateRequest.ReportTypeEnum.UserActivity, - DropboxSign.ReportCreateRequest.ReportTypeEnum.DocumentStatus, - ] -}; - -const result = reportApi.reportCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/ReportCreateExample.cs b/examples/ReportCreateExample.cs new file mode 100644 index 000000000..769bd3a18 --- /dev/null +++ b/examples/ReportCreateExample.cs @@ -0,0 +1,43 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ReportCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var reportCreateRequest = new ReportCreateRequest( + startDate: "09/01/2020", + endDate: "09/01/2020", + reportType: [ + ReportCreateRequest.ReportTypeEnum.UserActivity, + ReportCreateRequest.ReportTypeEnum.DocumentStatus, + ] + ); + + try + { + var response = new ReportApi(config).ReportCreate( + reportCreateRequest: reportCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ReportApi#ReportCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/ReportCreateExample.java b/examples/ReportCreateExample.java new file mode 100644 index 000000000..ecd726bcb --- /dev/null +++ b/examples/ReportCreateExample.java @@ -0,0 +1,47 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ReportApi#reportCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/ReportCreateExample.php b/examples/ReportCreateExample.php new file mode 100644 index 000000000..18d8d09ea --- /dev/null +++ b/examples/ReportCreateExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); + +$report_create_request = (new Dropbox\Sign\Model\ReportCreateRequest()) + ->setStartDate("09/01/2020") + ->setEndDate("09/01/2020") + ->setReportType([ + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, + ]); + +try { + $response = (new Dropbox\Sign\Api\ReportApi(config: $config))->reportCreate( + report_create_request: $report_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ReportApi#reportCreate: {$e->getMessage()}"; +} diff --git a/examples/ReportCreateExample.py b/examples/ReportCreateExample.py new file mode 100644 index 000000000..cfcc85d84 --- /dev/null +++ b/examples/ReportCreateExample.py @@ -0,0 +1,28 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + report_create_request = models.ReportCreateRequest( + start_date="09/01/2020", + end_date="09/01/2020", + report_type=[ + "user_activity", + "document_status", + ], + ) + + try: + response = api.ReportApi(api_client).report_create( + report_create_request=report_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ReportApi#report_create: %s\n" % e) diff --git a/examples/ReportCreateExample.rb b/examples/ReportCreateExample.rb new file mode 100644 index 000000000..d5169ca61 --- /dev/null +++ b/examples/ReportCreateExample.rb @@ -0,0 +1,24 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +report_create_request = Dropbox::Sign::ReportCreateRequest.new +report_create_request.start_date = "09/01/2020" +report_create_request.end_date = "09/01/2020" +report_create_request.report_type = [ + "user_activity", + "document_status", +] + +begin + response = Dropbox::Sign::ReportApi.new.report_create( + report_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ReportApi#report_create: #{e}" +end diff --git a/examples/ReportCreate.sh b/examples/ReportCreateExample.sh similarity index 100% rename from examples/ReportCreate.sh rename to examples/ReportCreateExample.sh diff --git a/examples/ReportCreateExample.ts b/examples/ReportCreateExample.ts new file mode 100644 index 000000000..57bf8127d --- /dev/null +++ b/examples/ReportCreateExample.ts @@ -0,0 +1,23 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ReportApi(); +apiCaller.username = "YOUR_API_KEY"; + +const reportCreateRequest = new models.ReportCreateRequest(); +reportCreateRequest.startDate = "09/01/2020"; +reportCreateRequest.endDate = "09/01/2020"; +reportCreateRequest.reportType = [ + models.ReportCreateRequest.ReportTypeEnum.UserActivity, + models.ReportCreateRequest.ReportTypeEnum.DocumentStatus, +]; + +apiCaller.reportCreate( + reportCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ReportApi#reportCreate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs deleted file mode 100644 index d87fd12fb..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs +++ /dev/null @@ -1,82 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signerList1Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td" - ); - - var signerList1CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "ABC Corp" - ); - - var signerList1 = new SubBulkSignerList( - signers: new List(){signerList1Signer}, - customFields: new List(){signerList1CustomFields} - ); - - var signerList2Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b" - ); - - var signerList2CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "123 Corp" - ); - - var signerList2 = new SubBulkSignerList( - signers: new List(){signerList2Signer}, - customFields: new List(){signerList2CustomFields} - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: new List(){signerList1, signerList2}, - ccs: new List(){cc1}, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestBulkCreateEmbeddedWithTemplate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java deleted file mode 100644 index babaca310..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,73 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC().role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js deleted file mode 100644 index 6a303bafd..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js +++ /dev/null @@ -1,66 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields = { - name: "company", - value: "ABC Corp", -}; - -const signerList1 = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields = { - name: "company", - value: "123 LLC", -}; - -const signerList2 = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data = { - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php deleted file mode 100644 index 6c3de5c16..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php +++ /dev/null @@ -1,60 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com") - ->setPin("d79a3td"); - -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); - -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); - -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$data = new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); -$data->setClientId("1a659d9ad95bccd307ecad78d72192f8") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestBulkCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py deleted file mode 100644 index 71bcd0bb5..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,72 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", - ) - - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="ABC Corp", - ) - - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) - - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", - ) - - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", - ) - - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - client_id="1a659d9ad95bccd307ecad78d72192f8", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = ( - signature_request_api.signature_request_bulk_create_embedded_with_template( - data - ) - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb deleted file mode 100644 index e20babf4c..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,59 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" - -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" - -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] - -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" - -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" - -signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new -data.client_id = "1a659d9ad95bccd307ecad78d72192f8" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = signature_request_api.signature_request_bulk_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts deleted file mode 100644 index acb3aa5ae..000000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts +++ /dev/null @@ -1,63 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -const signerList1Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "ABC Corp", -}; - -const signerList1: DropboxSign.SubBulkSignerList = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "123 LLC", -}; - -const signerList2: DropboxSign.SubBulkSignerList = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data: DropboxSign.SignatureRequestBulkCreateEmbeddedWithTemplateRequest = { - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..9fd344a94 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + clientId: "1a659d9ad95bccd307ecad78d72192f8", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest: signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..fcfbef591 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..1727df311 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest()) + ->setClientId("1a659d9ad95bccd307ecad78d72192f8") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkCreateEmbeddedWithTemplate( + signature_request_bulk_create_embedded_with_template_request: $signature_request_bulk_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..b2cb98a38 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_create_embedded_with_template_request = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + client_id="1a659d9ad95bccd307ecad78d72192f8", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request=signature_request_bulk_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: %s\n" % e) diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..e01b04f47 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new +signature_request_bulk_create_embedded_with_template_request.client_id = "1a659d9ad95bccd307ecad78d72192f8" +signature_request_bulk_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_bulk_create_embedded_with_template_request.test_mode = true +signature_request_bulk_create_embedded_with_template_request.signer_list = signer_list +signature_request_bulk_create_embedded_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh rename to examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh diff --git a/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..d8b5b2ef9 --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkCreateEmbeddedWithTemplateRequest = new models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); +signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId = "1a659d9ad95bccd307ecad78d72192f8"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList = signerList; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestBulkSendWithTemplate.cs b/examples/SignatureRequestBulkSendWithTemplate.cs deleted file mode 100644 index bf1851b5b..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.cs +++ /dev/null @@ -1,81 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signerList1Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td" - ); - - var signerList1CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "ABC Corp" - ); - - var signerList1 = new SubBulkSignerList( - signers: new List(){signerList1Signer}, - customFields: new List(){signerList1CustomFields} - ); - - var signerList2Signer = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b" - ); - - var signerList2CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "123 Corp" - ); - - var signerList2 = new SubBulkSignerList( - signers: new List(){signerList2Signer}, - customFields: new List(){signerList2CustomFields} - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); - - var data = new SignatureRequestBulkSendWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: new List(){signerList1, signerList2}, - ccs: new List(){cc1}, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestBulkSendWithTemplate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestBulkSendWithTemplate.java b/examples/SignatureRequestBulkSendWithTemplate.java deleted file mode 100644 index 960d1cbe8..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.java +++ /dev/null @@ -1,73 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestBulkSendWithTemplate.js b/examples/SignatureRequestBulkSendWithTemplate.js deleted file mode 100644 index 088d2e1cf..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.js +++ /dev/null @@ -1,65 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields = { - name: "company", - value: "ABC Corp", -}; - -const signerList1 = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields = { - name: "company", - value: "123 LLC", -}; - -const signerList2 = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkSendWithTemplate.php b/examples/SignatureRequestBulkSendWithTemplate.php deleted file mode 100644 index 0b147a75e..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.php +++ /dev/null @@ -1,62 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com") - ->setPin("d79a3td"); - -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); - -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); - -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$data = new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestBulkSendWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestBulkSendWithTemplate.py b/examples/SignatureRequestBulkSendWithTemplate.py deleted file mode 100644 index f1206792d..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.py +++ /dev/null @@ -1,67 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_list_1_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", - ) - - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="ABC Corp", - ) - - signer_list_1 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) - - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( - role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", - ) - - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", - ) - - signer_list_2 = models.SubBulkSignerList( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.SignatureRequestBulkSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_bulk_send_with_template(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestBulkSendWithTemplate.rb b/examples/SignatureRequestBulkSendWithTemplate.rb deleted file mode 100644 index 125bc06ea..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.rb +++ /dev/null @@ -1,58 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_list_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" - -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" - -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] - -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" - -signer_list_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" - -signer_list_2 = Dropbox::Sign::SubBulkSignerList.new -signer_list_2.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = signature_request_api.signature_request_bulk_send_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestBulkSendWithTemplate.ts b/examples/SignatureRequestBulkSendWithTemplate.ts deleted file mode 100644 index b2eb7a923..000000000 --- a/examples/SignatureRequestBulkSendWithTemplate.ts +++ /dev/null @@ -1,65 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "ABC Corp", -}; - -const signerList1: DropboxSign.SubBulkSignerList = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "123 LLC", -}; - -const signerList2: DropboxSign.SubBulkSignerList = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data: DropboxSign.SignatureRequestBulkSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.cs b/examples/SignatureRequestBulkSendWithTemplateExample.cs new file mode 100644 index 000000000..3c95fdb32 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest( + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest: signatureRequestBulkSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.java b/examples/SignatureRequestBulkSendWithTemplateExample.java new file mode 100644 index 000000000..fb9baba01 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.php b/examples/SignatureRequestBulkSendWithTemplateExample.php new file mode 100644 index 000000000..7574361ff --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest()) + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkSendWithTemplate( + signature_request_bulk_send_with_template_request: $signature_request_bulk_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.py b/examples/SignatureRequestBulkSendWithTemplateExample.py new file mode 100644 index 000000000..4a8fb41c5 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_send_with_template_request = models.SignatureRequestBulkSendWithTemplateRequest( + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request=signature_request_bulk_send_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: %s\n" % e) diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.rb b/examples/SignatureRequestBulkSendWithTemplateExample.rb new file mode 100644 index 000000000..27f2d66d5 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_send_with_template_request = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new +signature_request_bulk_send_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_send_with_template_request.subject = "Purchase Order" +signature_request_bulk_send_with_template_request.test_mode = true +signature_request_bulk_send_with_template_request.signer_list = signer_list +signature_request_bulk_send_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}" +end diff --git a/examples/SignatureRequestBulkSendWithTemplate.sh b/examples/SignatureRequestBulkSendWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestBulkSendWithTemplate.sh rename to examples/SignatureRequestBulkSendWithTemplateExample.sh diff --git a/examples/SignatureRequestBulkSendWithTemplateExample.ts b/examples/SignatureRequestBulkSendWithTemplateExample.ts new file mode 100644 index 000000000..f2fff90b1 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkSendWithTemplateRequest = new models.SignatureRequestBulkSendWithTemplateRequest(); +signatureRequestBulkSendWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkSendWithTemplateRequest.testMode = true; +signatureRequestBulkSendWithTemplateRequest.signerList = signerList; +signatureRequestBulkSendWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCancel.cs b/examples/SignatureRequestCancel.cs deleted file mode 100644 index cb9549f8f..000000000 --- a/examples/SignatureRequestCancel.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - signatureRequestApi.SignatureRequestCancel(signatureRequestId); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestCancel.java b/examples/SignatureRequestCancel.java deleted file mode 100644 index 20c165993..000000000 --- a/examples/SignatureRequestCancel.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - signatureRequestApi.signatureRequestCancel(signatureRequestId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestCancel.js b/examples/SignatureRequestCancel.js deleted file mode 100644 index ba378c467..000000000 --- a/examples/SignatureRequestCancel.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestCancel(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCancel.php b/examples/SignatureRequestCancel.php deleted file mode 100644 index 154dbab93..000000000 --- a/examples/SignatureRequestCancel.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $signatureRequestApi->signatureRequestCancel($signatureRequestId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestCancel.py b/examples/SignatureRequestCancel.py deleted file mode 100644 index 5330623b6..000000000 --- a/examples/SignatureRequestCancel.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - signature_request_api.signature_request_cancel(signature_request_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCancel.rb b/examples/SignatureRequestCancel.rb deleted file mode 100644 index aab12770d..000000000 --- a/examples/SignatureRequestCancel.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_cancel(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCancel.ts b/examples/SignatureRequestCancel.ts deleted file mode 100644 index ba378c467..000000000 --- a/examples/SignatureRequestCancel.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestCancel(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCancelExample.cs b/examples/SignatureRequestCancelExample.cs new file mode 100644 index 000000000..4d18209eb --- /dev/null +++ b/examples/SignatureRequestCancelExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCancelExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new SignatureRequestApi(config).SignatureRequestCancel( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCancel: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCancelExample.java b/examples/SignatureRequestCancelExample.java new file mode 100644 index 000000000..a1e436802 --- /dev/null +++ b/examples/SignatureRequestCancelExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCancelExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCancel"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCancelExample.php b/examples/SignatureRequestCancelExample.php new file mode 100644 index 000000000..969a67683 --- /dev/null +++ b/examples/SignatureRequestCancelExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCancel( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCancel: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCancelExample.py b/examples/SignatureRequestCancelExample.py new file mode 100644 index 000000000..6a0e62bc1 --- /dev/null +++ b/examples/SignatureRequestCancelExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_cancel( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_cancel: %s\n" % e) diff --git a/examples/SignatureRequestCancelExample.rb b/examples/SignatureRequestCancelExample.rb new file mode 100644 index 000000000..9f3ff955e --- /dev/null +++ b/examples/SignatureRequestCancelExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_cancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}" +end diff --git a/examples/SignatureRequestCancel.sh b/examples/SignatureRequestCancelExample.sh similarity index 100% rename from examples/SignatureRequestCancel.sh rename to examples/SignatureRequestCancelExample.sh diff --git a/examples/SignatureRequestCancelExample.ts b/examples/SignatureRequestCancelExample.ts new file mode 100644 index 000000000..d6207b3bd --- /dev/null +++ b/examples/SignatureRequestCancelExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCancel:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCreateEmbedded.cs b/examples/SignatureRequestCreateEmbedded.cs deleted file mode 100644 index 1f587c951..000000000 --- a/examples/SignatureRequestCreateEmbedded.cs +++ /dev/null @@ -1,74 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestCreateEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - signingOptions: signingOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestCreateEmbedded(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestCreateEmbedded.java b/examples/SignatureRequestCreateEmbedded.java deleted file mode 100644 index 3697f2167..000000000 --- a/examples/SignatureRequestCreateEmbedded.java +++ /dev/null @@ -1,62 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbedded(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestCreateEmbedded.js b/examples/SignatureRequestCreateEmbedded.js deleted file mode 100644 index 14dca9a26..000000000 --- a/examples/SignatureRequestCreateEmbedded.js +++ /dev/null @@ -1,53 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbedded.php b/examples/SignatureRequestCreateEmbedded.php deleted file mode 100644 index 9b416917c..000000000 --- a/examples/SignatureRequestCreateEmbedded.php +++ /dev/null @@ -1,53 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestCreateEmbedded($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestCreateEmbedded.py b/examples/SignatureRequestCreateEmbedded.py deleted file mode 100644 index d35615c96..000000000 --- a/examples/SignatureRequestCreateEmbedded.py +++ /dev/null @@ -1,51 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_create_embedded(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbedded.rb b/examples/SignatureRequestCreateEmbedded.rb deleted file mode 100644 index 4cec8fa11..000000000 --- a/examples/SignatureRequestCreateEmbedded.rb +++ /dev/null @@ -1,46 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_create_embedded(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCreateEmbedded.ts b/examples/SignatureRequestCreateEmbedded.ts deleted file mode 100644 index cad168590..000000000 --- a/examples/SignatureRequestCreateEmbedded.ts +++ /dev/null @@ -1,53 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestCreateEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbeddedExample.cs b/examples/SignatureRequestCreateEmbeddedExample.cs new file mode 100644 index 000000000..7f9786caf --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.cs @@ -0,0 +1,82 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedExample.java b/examples/SignatureRequestCreateEmbeddedExample.java new file mode 100644 index 000000000..ee5f5bb2a --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.java @@ -0,0 +1,78 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedExample.php b/examples/SignatureRequestCreateEmbeddedExample.php new file mode 100644 index 000000000..61d74044e --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.php @@ -0,0 +1,59 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCreateEmbeddedExample.py b/examples/SignatureRequestCreateEmbeddedExample.py new file mode 100644 index 000000000..2e1b93c1d --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.py @@ -0,0 +1,62 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedExample.rb b/examples/SignatureRequestCreateEmbeddedExample.rb new file mode 100644 index 000000000..55db08ca7 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.rb @@ -0,0 +1,55 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbedded.sh b/examples/SignatureRequestCreateEmbeddedExample.sh similarity index 100% rename from examples/SignatureRequestCreateEmbedded.sh rename to examples/SignatureRequestCreateEmbeddedExample.sh diff --git a/examples/SignatureRequestCreateEmbeddedExample.ts b/examples/SignatureRequestCreateEmbeddedExample.ts new file mode 100644 index 000000000..15c30c113 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.ts @@ -0,0 +1,54 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..40cbcbc51 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.cs @@ -0,0 +1,110 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..0228be4a6 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -0,0 +1,104 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..f7ea5d39a --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.php @@ -0,0 +1,86 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py new file mode 100644 index 000000000..8bc255e6f --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.py @@ -0,0 +1,92 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb new file mode 100644 index 000000000..9910ee894 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.rb @@ -0,0 +1,81 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..6fcc1bab3 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.ts @@ -0,0 +1,80 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.cs b/examples/SignatureRequestCreateEmbeddedWithTemplate.cs deleted file mode 100644 index ff9da4a75..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.cs +++ /dev/null @@ -1,55 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George" - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - signingOptions: subSigningOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestCreateEmbeddedWithTemplate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.java b/examples/SignatureRequestCreateEmbeddedWithTemplate.java deleted file mode 100644 index 96d14e58b..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,53 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.js b/examples/SignatureRequestCreateEmbeddedWithTemplate.js deleted file mode 100644 index 12ba7fc3c..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.js +++ /dev/null @@ -1,41 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.php b/examples/SignatureRequestCreateEmbeddedWithTemplate.php deleted file mode 100644 index 3ff087edb..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.php +++ /dev/null @@ -1,43 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.py b/examples/SignatureRequestCreateEmbeddedWithTemplate.py deleted file mode 100644 index 1b60db43c..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,45 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = ( - signature_request_api.signature_request_create_embedded_with_template(data) - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.rb b/examples/SignatureRequestCreateEmbeddedWithTemplate.rb deleted file mode 100644 index 6aba3fd28..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,39 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.ts b/examples/SignatureRequestCreateEmbeddedWithTemplate.ts deleted file mode 100644 index 993efd82f..000000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.ts +++ /dev/null @@ -1,41 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestCreateEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..d40f34240 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,66 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..5957ccba0 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..3ff0454e8 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbeddedWithTemplate( + signature_request_create_embedded_with_template_request: $signature_request_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..6a5835760 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,50 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_create_embedded_with_template_request = models.SignatureRequestCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" % e) diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..2de72cf8a --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new +signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_create_embedded_with_template_request.test_mode = true +signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplate.sh b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestCreateEmbeddedWithTemplate.sh rename to examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh diff --git a/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..399f0c491 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestCreateEmbeddedWithTemplateRequest = new models.SignatureRequestCreateEmbeddedWithTemplateRequest(); +signatureRequestCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEdit.cs b/examples/SignatureRequestEdit.cs deleted file mode 100644 index 02c197f63..000000000 --- a/examples/SignatureRequestEdit.cs +++ /dev/null @@ -1,87 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var metadata = new Dictionary() - { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestEditRequest( - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: signingOptions, - fieldOptions: subFieldOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEdit(signatureRequestId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestEdit.java b/examples/SignatureRequestEdit.java deleted file mode 100644 index 163b663b0..000000000 --- a/examples/SignatureRequestEdit.java +++ /dev/null @@ -1,69 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEdit.js b/examples/SignatureRequestEdit.js deleted file mode 100644 index 797ffc59e..000000000 --- a/examples/SignatureRequestEdit.js +++ /dev/null @@ -1,84 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestEditRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEdit.php b/examples/SignatureRequestEdit.php deleted file mode 100644 index 67b7c92a5..000000000 --- a/examples/SignatureRequestEdit.php +++ /dev/null @@ -1,62 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\SignatureRequestEditRequest(); -$data->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEdit($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEdit.py b/examples/SignatureRequestEdit.py deleted file mode 100644 index 213bed8b4..000000000 --- a/examples/SignatureRequestEdit.py +++ /dev/null @@ -1,66 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.SignatureRequestEditRequest( - title="NDA with Acme Co.", - subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=[ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, - field_options=field_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEdit.rb b/examples/SignatureRequestEdit.rb deleted file mode 100644 index b8db7b6b4..000000000 --- a/examples/SignatureRequestEdit.rb +++ /dev/null @@ -1,58 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::SignatureRequestEditRequest.new -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", -] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEdit.ts b/examples/SignatureRequestEdit.ts deleted file mode 100644 index 634c0ba86..000000000 --- a/examples/SignatureRequestEdit.ts +++ /dev/null @@ -1,85 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestEditRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - -const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbedded.cs b/examples/SignatureRequestEditEmbedded.cs deleted file mode 100644 index 87d7d731b..000000000 --- a/examples/SignatureRequestEditEmbedded.cs +++ /dev/null @@ -1,79 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestEditEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - signingOptions: signingOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEditEmbedded( - signatureRequestId, - data - ); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestEditEmbedded.java b/examples/SignatureRequestEditEmbedded.java deleted file mode 100644 index a9e0ddd22..000000000 --- a/examples/SignatureRequestEditEmbedded.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEditEmbedded.js b/examples/SignatureRequestEditEmbedded.js deleted file mode 100644 index c3b4ae01d..000000000 --- a/examples/SignatureRequestEditEmbedded.js +++ /dev/null @@ -1,58 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbedded.php b/examples/SignatureRequestEditEmbedded.php deleted file mode 100644 index 7af9b39b1..000000000 --- a/examples/SignatureRequestEditEmbedded.php +++ /dev/null @@ -1,58 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEditEmbedded( - $signatureRequestId, - $data - ); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEditEmbedded.py b/examples/SignatureRequestEditEmbedded.py deleted file mode 100644 index 1bbac3c2e..000000000 --- a/examples/SignatureRequestEditEmbedded.py +++ /dev/null @@ -1,55 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestEditEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", - subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_embedded( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbedded.rb b/examples/SignatureRequestEditEmbedded.rb deleted file mode 100644 index 6b5d379d4..000000000 --- a/examples/SignatureRequestEditEmbedded.rb +++ /dev/null @@ -1,48 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_embedded(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbedded.ts b/examples/SignatureRequestEditEmbedded.ts deleted file mode 100644 index 49c15b51b..000000000 --- a/examples/SignatureRequestEditEmbedded.ts +++ /dev/null @@ -1,58 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestEditEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbeddedExample.cs b/examples/SignatureRequestEditEmbeddedExample.cs new file mode 100644 index 000000000..356603bf6 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.cs @@ -0,0 +1,83 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedExample.java b/examples/SignatureRequestEditEmbeddedExample.java new file mode 100644 index 000000000..8370a232e --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.java @@ -0,0 +1,79 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedExample.php b/examples/SignatureRequestEditEmbeddedExample.php new file mode 100644 index 000000000..868c62562 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.php @@ -0,0 +1,60 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditEmbeddedExample.py b/examples/SignatureRequestEditEmbeddedExample.py new file mode 100644 index 000000000..e3e5f1a87 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.py @@ -0,0 +1,63 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedExample.rb b/examples/SignatureRequestEditEmbeddedExample.rb new file mode 100644 index 000000000..0e192377c --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.rb @@ -0,0 +1,56 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/examples/SignatureRequestEditEmbedded.sh b/examples/SignatureRequestEditEmbeddedExample.sh similarity index 100% rename from examples/SignatureRequestEditEmbedded.sh rename to examples/SignatureRequestEditEmbeddedExample.sh diff --git a/examples/SignatureRequestEditEmbeddedExample.ts b/examples/SignatureRequestEditEmbeddedExample.ts new file mode 100644 index 000000000..6affce8fb --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.ts @@ -0,0 +1,55 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..3be9c8142 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.cs @@ -0,0 +1,111 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..8859b04f8 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -0,0 +1,105 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..08ebeac0a --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.php @@ -0,0 +1,87 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py new file mode 100644 index 000000000..9c26905c3 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.py @@ -0,0 +1,93 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb new file mode 100644 index 000000000..0fc7bc7a3 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.rb @@ -0,0 +1,82 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..c65767fed --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.ts @@ -0,0 +1,81 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.cs b/examples/SignatureRequestEditEmbeddedWithTemplate.cs deleted file mode 100644 index 12a591d17..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.cs +++ /dev/null @@ -1,60 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - name: "George" - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - signingOptions: subSigningOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data - ); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.java b/examples/SignatureRequestEditEmbeddedWithTemplate.java deleted file mode 100644 index c9b68d068..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.java +++ /dev/null @@ -1,58 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.js b/examples/SignatureRequestEditEmbeddedWithTemplate.js deleted file mode 100644 index b4207e848..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.js +++ /dev/null @@ -1,46 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.php b/examples/SignatureRequestEditEmbeddedWithTemplate.php deleted file mode 100644 index 2ab8d4739..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.php +++ /dev/null @@ -1,48 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEditEmbeddedWithTemplate( - $signatureRequestId, - $data - ); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.py b/examples/SignatureRequestEditEmbeddedWithTemplate.py deleted file mode 100644 index 2e0be015e..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.py +++ /dev/null @@ -1,47 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - data = models.SignatureRequestEditEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_embedded_with_template( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.rb b/examples/SignatureRequestEditEmbeddedWithTemplate.rb deleted file mode 100644 index 4dc4c9e2f..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.rb +++ /dev/null @@ -1,41 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.ts b/examples/SignatureRequestEditEmbeddedWithTemplate.ts deleted file mode 100644 index cfe6cdc55..000000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.ts +++ /dev/null @@ -1,46 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestEditEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs b/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..fff755e13 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbeddedWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedWithTemplateRequest: signatureRequestEditEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.java b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..77c294dea --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -0,0 +1,68 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.php b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..640f35dfc --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.php @@ -0,0 +1,50 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbeddedWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request: $signature_request_edit_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.py b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..92f0378ef --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.py @@ -0,0 +1,51 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_edit_embedded_with_template_request = models.SignatureRequestEditEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: %s\n" % e) diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..f504f1944 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.rb @@ -0,0 +1,45 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +signature_request_edit_embedded_with_template_request = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new +signature_request_edit_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_edit_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_embedded_with_template_request.subject = "Purchase Order" +signature_request_edit_embedded_with_template_request.test_mode = true +signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}" +end diff --git a/examples/SignatureRequestEditEmbeddedWithTemplate.sh b/examples/SignatureRequestEditEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestEditEmbeddedWithTemplate.sh rename to examples/SignatureRequestEditEmbeddedWithTemplateExample.sh diff --git a/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts b/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..6da9e8e05 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.ts @@ -0,0 +1,44 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestEditEmbeddedWithTemplateRequest = new models.SignatureRequestEditEmbeddedWithTemplateRequest(); +signatureRequestEditEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestEditEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditEmbeddedWithTemplateRequest.testMode = true; +signatureRequestEditEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditExample.cs b/examples/SignatureRequestEditExample.cs new file mode 100644 index 000000000..b3542b75f --- /dev/null +++ b/examples/SignatureRequestEditExample.cs @@ -0,0 +1,93 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditExample.java b/examples/SignatureRequestEditExample.java new file mode 100644 index 000000000..c0423f9b9 --- /dev/null +++ b/examples/SignatureRequestEditExample.java @@ -0,0 +1,88 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditExample.php b/examples/SignatureRequestEditExample.php new file mode 100644 index 000000000..92d3747c5 --- /dev/null +++ b/examples/SignatureRequestEditExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditExample.py b/examples/SignatureRequestEditExample.py new file mode 100644 index 000000000..4c6fc1e74 --- /dev/null +++ b/examples/SignatureRequestEditExample.py @@ -0,0 +1,73 @@ +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) diff --git a/examples/SignatureRequestEditExample.rb b/examples/SignatureRequestEditExample.rb new file mode 100644 index 000000000..e55d7beee --- /dev/null +++ b/examples/SignatureRequestEditExample.rb @@ -0,0 +1,66 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/examples/SignatureRequestEdit.sh b/examples/SignatureRequestEditExample.sh similarity index 100% rename from examples/SignatureRequestEdit.sh rename to examples/SignatureRequestEditExample.sh diff --git a/examples/SignatureRequestEditExample.ts b/examples/SignatureRequestEditExample.ts new file mode 100644 index 000000000..43aca782d --- /dev/null +++ b/examples/SignatureRequestEditExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.signers = signers; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditGroupedSignersExample.cs b/examples/SignatureRequestEditGroupedSignersExample.cs new file mode 100644 index 000000000..35a41afa4 --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.cs @@ -0,0 +1,121 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditGroupedSignersExample.java b/examples/SignatureRequestEditGroupedSignersExample.java new file mode 100644 index 000000000..693b72c6c --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.java @@ -0,0 +1,114 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditGroupedSignersExample.php b/examples/SignatureRequestEditGroupedSignersExample.php new file mode 100644 index 000000000..af25d631a --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.php @@ -0,0 +1,96 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditGroupedSignersExample.py b/examples/SignatureRequestEditGroupedSignersExample.py new file mode 100644 index 000000000..41f5a54dc --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.py @@ -0,0 +1,103 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit: %s\n" % e) diff --git a/examples/SignatureRequestEditGroupedSignersExample.rb b/examples/SignatureRequestEditGroupedSignersExample.rb new file mode 100644 index 000000000..2b19ffabb --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.rb @@ -0,0 +1,92 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/examples/SignatureRequestEditGroupedSignersExample.ts b/examples/SignatureRequestEditGroupedSignersExample.ts new file mode 100644 index 000000000..fe5e19645 --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.ts @@ -0,0 +1,88 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestEditWithTemplate.cs b/examples/SignatureRequestEditWithTemplate.cs deleted file mode 100644 index 22038ee87..000000000 --- a/examples/SignatureRequestEditWithTemplate.cs +++ /dev/null @@ -1,71 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - emailAddress: "george@example.com", - name: "George" - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@emaple.com" - ); - - var customField1 = new SubCustomField( - name: "Cost", - value: "$20,000", - editor: "Client", - required: true - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestEditWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - ccs: new List(){cc1}, - customFields: new List(){customField1}, - signingOptions: signingOptions, - testMode: true - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestEditWithTemplate(signatureRequestId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestEditWithTemplate.java b/examples/SignatureRequestEditWithTemplate.java deleted file mode 100644 index da6677231..000000000 --- a/examples/SignatureRequestEditWithTemplate.java +++ /dev/null @@ -1,70 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestEditWithTemplate.js b/examples/SignatureRequestEditWithTemplate.js deleted file mode 100644 index 3bc93e246..000000000 --- a/examples/SignatureRequestEditWithTemplate.js +++ /dev/null @@ -1,59 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1 = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data, -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditWithTemplate.php b/examples/SignatureRequestEditWithTemplate.php deleted file mode 100644 index d9fe64d46..000000000 --- a/examples/SignatureRequestEditWithTemplate.php +++ /dev/null @@ -1,56 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") - ->setEditor("Client") - ->setRequired(true); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestEditWithTemplate($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestEditWithTemplate.py b/examples/SignatureRequestEditWithTemplate.py deleted file mode 100644 index 399b51697..000000000 --- a/examples/SignatureRequestEditWithTemplate.py +++ /dev/null @@ -1,60 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="george@example.com", - name="George", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - custom_field_1 = models.SubCustomField( - name="Cost", - value="$20,000", - editor="Client", - required=True, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_edit_with_template( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestEditWithTemplate.rb b/examples/SignatureRequestEditWithTemplate.rb deleted file mode 100644 index dacbaba5f..000000000 --- a/examples/SignatureRequestEditWithTemplate.rb +++ /dev/null @@ -1,52 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "george@example.com" -signer_1.name = "George" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -custom_field_1 = Dropbox::Sign::SubCustomField.new -custom_field_1.name = "Cost" -custom_field_1.value = "$20,000" -custom_field_1.editor = "Client" -custom_field_1.required = true - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.ccs = [cc_1] -data.custom_fields = [custom_field_1] -data.signing_options = signing_options -data.test_mode = true - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_edit_with_template(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestEditWithTemplate.ts b/examples/SignatureRequestEditWithTemplate.ts deleted file mode 100644 index d18720403..000000000 --- a/examples/SignatureRequestEditWithTemplate.ts +++ /dev/null @@ -1,59 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1: DropboxSign.SubCustomField = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestEditWithTemplateExample.cs b/examples/SignatureRequestEditWithTemplateExample.cs new file mode 100644 index 000000000..172f24b6c --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.cs @@ -0,0 +1,90 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditWithTemplateRequest: signatureRequestEditWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestEditWithTemplateExample.java b/examples/SignatureRequestEditWithTemplateExample.java new file mode 100644 index 000000000..bcb4128d6 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestEditWithTemplateExample.php b/examples/SignatureRequestEditWithTemplateExample.php new file mode 100644 index 000000000..aa8391c3e --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_edit_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request: $signature_request_edit_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestEditWithTemplateExample.py b/examples/SignatureRequestEditWithTemplateExample.py new file mode 100644 index 000000000..4e8653475 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.py @@ -0,0 +1,72 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( + name="Cost", + editor="Client", + required=True, + value="$20,000", + ) + + custom_fields = [ + custom_fields_1, + ] + + signature_request_edit_with_template_request = models.SignatureRequestEditWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_with_template: %s\n" % e) diff --git a/examples/SignatureRequestEditWithTemplateExample.rb b/examples/SignatureRequestEditWithTemplateExample.rb new file mode 100644 index 000000000..f3c2d8ed6 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.rb @@ -0,0 +1,64 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +custom_fields_1 = Dropbox::Sign::SubCustomField.new +custom_fields_1.name = "Cost" +custom_fields_1.editor = "Client" +custom_fields_1.required = true +custom_fields_1.value = "$20,000" + +custom_fields = [ + custom_fields_1, +] + +signature_request_edit_with_template_request = Dropbox::Sign::SignatureRequestEditWithTemplateRequest.new +signature_request_edit_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_edit_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_with_template_request.subject = "Purchase Order" +signature_request_edit_with_template_request.test_mode = true +signature_request_edit_with_template_request.signing_options = signing_options +signature_request_edit_with_template_request.signers = signers +signature_request_edit_with_template_request.ccs = ccs +signature_request_edit_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}" +end diff --git a/examples/SignatureRequestEditWithTemplate.sh b/examples/SignatureRequestEditWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestEditWithTemplate.sh rename to examples/SignatureRequestEditWithTemplateExample.sh diff --git a/examples/SignatureRequestEditWithTemplateExample.ts b/examples/SignatureRequestEditWithTemplateExample.ts new file mode 100644 index 000000000..650ce2ff1 --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.ts @@ -0,0 +1,63 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestEditWithTemplateRequest = new models.SignatureRequestEditWithTemplateRequest(); +signatureRequestEditWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestEditWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditWithTemplateRequest.testMode = true; +signatureRequestEditWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditWithTemplateRequest.signers = signers; +signatureRequestEditWithTemplateRequest.ccs = ccs; +signatureRequestEditWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestFiles.cs b/examples/SignatureRequestFiles.cs deleted file mode 100644 index d9ceb40a6..000000000 --- a/examples/SignatureRequestFiles.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestFiles(signatureRequestId, "pdf"); - - var fileStream = File.Create("file_response.pdf"); - result.Seek(0, SeekOrigin.Begin); - result.CopyTo(fileStream); - fileStream.Close(); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestFiles.java b/examples/SignatureRequestFiles.java deleted file mode 100644 index ca70f2321..000000000 --- a/examples/SignatureRequestFiles.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf"); - result.renameTo(new File("file_response.pdf")); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestFiles.js b/examples/SignatureRequestFiles.js deleted file mode 100644 index 309fea4d9..000000000 --- a/examples/SignatureRequestFiles.js +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -const fileType = "pdf"; - -const result = signatureRequestApi.signatureRequestFiles(signatureRequestId, fileType); - -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFiles.php b/examples/SignatureRequestFiles.php deleted file mode 100644 index 9fc70c7c2..000000000 --- a/examples/SignatureRequestFiles.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -$fileType = "pdf"; - -try { - $result = $signatureRequestApi->signatureRequestFiles($signatureRequestId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestFiles.py b/examples/SignatureRequestFiles.py deleted file mode 100644 index 1c32d32c4..000000000 --- a/examples/SignatureRequestFiles.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files( - signature_request_id, file_type="pdf" - ) - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFiles.rb b/examples/SignatureRequestFiles.rb deleted file mode 100644 index 171082637..000000000 --- a/examples/SignatureRequestFiles.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - file_bin = signature_request_api.signature_request_files(signature_request_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFiles.ts b/examples/SignatureRequestFiles.ts deleted file mode 100644 index 309fea4d9..000000000 --- a/examples/SignatureRequestFiles.ts +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -const fileType = "pdf"; - -const result = signatureRequestApi.signatureRequestFiles(signatureRequestId, fileType); - -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsDataUri.cs b/examples/SignatureRequestFilesAsDataUri.cs deleted file mode 100644 index 5ca7ca5bc..000000000 --- a/examples/SignatureRequestFilesAsDataUri.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestFilesAsDataUri(signatureRequestId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestFilesAsDataUri.java b/examples/SignatureRequestFilesAsDataUri.java deleted file mode 100644 index b90222308..000000000 --- a/examples/SignatureRequestFilesAsDataUri.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FileResponseDataUri result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestFilesAsDataUri.js b/examples/SignatureRequestFilesAsDataUri.js deleted file mode 100644 index 6836ecc1a..000000000 --- a/examples/SignatureRequestFilesAsDataUri.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsDataUri.php b/examples/SignatureRequestFilesAsDataUri.php deleted file mode 100644 index 7ae6b9df1..000000000 --- a/examples/SignatureRequestFilesAsDataUri.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestFilesAsDataUri($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestFilesAsDataUri.py b/examples/SignatureRequestFilesAsDataUri.py deleted file mode 100644 index 46bb01562..000000000 --- a/examples/SignatureRequestFilesAsDataUri.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files_as_data_uri( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsDataUri.rb b/examples/SignatureRequestFilesAsDataUri.rb deleted file mode 100644 index b95c37443..000000000 --- a/examples/SignatureRequestFilesAsDataUri.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = signature_request_api.signature_request_files_as_data_uri(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsDataUri.ts b/examples/SignatureRequestFilesAsDataUri.ts deleted file mode 100644 index 6836ecc1a..000000000 --- a/examples/SignatureRequestFilesAsDataUri.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsDataUriExample.cs b/examples/SignatureRequestFilesAsDataUriExample.cs new file mode 100644 index 000000000..60f837089 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsDataUri( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestFilesAsDataUriExample.java b/examples/SignatureRequestFilesAsDataUriExample.java new file mode 100644 index 000000000..765fb93ce --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestFilesAsDataUriExample.php b/examples/SignatureRequestFilesAsDataUriExample.php new file mode 100644 index 000000000..0d8d71902 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsDataUri( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestFilesAsDataUriExample.py b/examples/SignatureRequestFilesAsDataUriExample.py new file mode 100644 index 000000000..09a50923d --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files_as_data_uri( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsDataUriExample.rb b/examples/SignatureRequestFilesAsDataUriExample.rb new file mode 100644 index 000000000..9f9390e41 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_data_uri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}" +end diff --git a/examples/SignatureRequestFilesAsDataUri.sh b/examples/SignatureRequestFilesAsDataUriExample.sh similarity index 100% rename from examples/SignatureRequestFilesAsDataUri.sh rename to examples/SignatureRequestFilesAsDataUriExample.sh diff --git a/examples/SignatureRequestFilesAsDataUriExample.ts b/examples/SignatureRequestFilesAsDataUriExample.ts new file mode 100644 index 000000000..58630aeaa --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestFilesAsFileUrl.cs b/examples/SignatureRequestFilesAsFileUrl.cs deleted file mode 100644 index b3e92efd1..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestFilesAsFileUrl(signatureRequestId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestFilesAsFileUrl.java b/examples/SignatureRequestFilesAsFileUrl.java deleted file mode 100644 index 7bf3b9907..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FileResponse result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestFilesAsFileUrl.js b/examples/SignatureRequestFilesAsFileUrl.js deleted file mode 100644 index bb866605d..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsFileUrl.php b/examples/SignatureRequestFilesAsFileUrl.php deleted file mode 100644 index 91af0a41c..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestFilesAsFileUrl($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestFilesAsFileUrl.py b/examples/SignatureRequestFilesAsFileUrl.py deleted file mode 100644 index 9c6a5da4f..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_files_as_file_url( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsFileUrl.rb b/examples/SignatureRequestFilesAsFileUrl.rb deleted file mode 100644 index a4294a288..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = signature_request_api.signature_request_files_as_file_url(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestFilesAsFileUrl.ts b/examples/SignatureRequestFilesAsFileUrl.ts deleted file mode 100644 index bb866605d..000000000 --- a/examples/SignatureRequestFilesAsFileUrl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestFilesAsFileUrlExample.cs b/examples/SignatureRequestFilesAsFileUrlExample.cs new file mode 100644 index 000000000..f3bfe667a --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsFileUrl( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestFilesAsFileUrlExample.java b/examples/SignatureRequestFilesAsFileUrlExample.java new file mode 100644 index 000000000..62e253779 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestFilesAsFileUrlExample.php b/examples/SignatureRequestFilesAsFileUrlExample.php new file mode 100644 index 000000000..feb6ac055 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsFileUrl( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestFilesAsFileUrlExample.py b/examples/SignatureRequestFilesAsFileUrlExample.py new file mode 100644 index 000000000..9cd19e6db --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files_as_file_url( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files_as_file_url: %s\n" % e) diff --git a/examples/SignatureRequestFilesAsFileUrlExample.rb b/examples/SignatureRequestFilesAsFileUrlExample.rb new file mode 100644 index 000000000..14abf28bf --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_file_url( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}" +end diff --git a/examples/SignatureRequestFilesAsFileUrl.sh b/examples/SignatureRequestFilesAsFileUrlExample.sh similarity index 100% rename from examples/SignatureRequestFilesAsFileUrl.sh rename to examples/SignatureRequestFilesAsFileUrlExample.sh diff --git a/examples/SignatureRequestFilesAsFileUrlExample.ts b/examples/SignatureRequestFilesAsFileUrlExample.ts new file mode 100644 index 000000000..5ca65d932 --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestFilesExample.cs b/examples/SignatureRequestFilesExample.cs new file mode 100644 index 000000000..879127eda --- /dev/null +++ b/examples/SignatureRequestFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFiles( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + fileType: "pdf" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestFilesExample.java b/examples/SignatureRequestFilesExample.java new file mode 100644 index 000000000..758d2997b --- /dev/null +++ b/examples/SignatureRequestFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestFilesExample.php b/examples/SignatureRequestFilesExample.php new file mode 100644 index 000000000..b11f5ae30 --- /dev/null +++ b/examples/SignatureRequestFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFiles( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type: "pdf", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFiles: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestFilesExample.py b/examples/SignatureRequestFilesExample.py new file mode 100644 index 000000000..12694cc53 --- /dev/null +++ b/examples/SignatureRequestFilesExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type="pdf", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files: %s\n" % e) diff --git a/examples/SignatureRequestFilesExample.rb b/examples/SignatureRequestFilesExample.rb new file mode 100644 index 000000000..1d891d696 --- /dev/null +++ b/examples/SignatureRequestFilesExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + file_type: "pdf", + }, + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}" +end diff --git a/examples/SignatureRequestFiles.sh b/examples/SignatureRequestFilesExample.sh similarity index 100% rename from examples/SignatureRequestFiles.sh rename to examples/SignatureRequestFilesExample.sh diff --git a/examples/SignatureRequestFilesExample.ts b/examples/SignatureRequestFilesExample.ts new file mode 100644 index 000000000..88762904f --- /dev/null +++ b/examples/SignatureRequestFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf", // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFiles:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestGet.cs b/examples/SignatureRequestGet.cs deleted file mode 100644 index 33425be0a..000000000 --- a/examples/SignatureRequestGet.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try - { - var result = signatureRequestApi.SignatureRequestGet(signatureRequestId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestGet.java b/examples/SignatureRequestGet.java deleted file mode 100644 index 78e4af53c..000000000 --- a/examples/SignatureRequestGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestGet(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestGet.js b/examples/SignatureRequestGet.js deleted file mode 100644 index 894f53bcc..000000000 --- a/examples/SignatureRequestGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestGet(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestGet.php b/examples/SignatureRequestGet.php deleted file mode 100644 index a7eed1bb0..000000000 --- a/examples/SignatureRequestGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -try { - $result = $signatureRequestApi->signatureRequestGet($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestGet.py b/examples/SignatureRequestGet.py deleted file mode 100644 index 50d34099e..000000000 --- a/examples/SignatureRequestGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - - try: - response = signature_request_api.signature_request_get(signature_request_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestGet.rb b/examples/SignatureRequestGet.rb deleted file mode 100644 index 35721b8f9..000000000 --- a/examples/SignatureRequestGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -begin - result = signature_request_api.signature_request_get(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestGet.ts b/examples/SignatureRequestGet.ts deleted file mode 100644 index 894f53bcc..000000000 --- a/examples/SignatureRequestGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestGet(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestGetExample.cs b/examples/SignatureRequestGetExample.cs new file mode 100644 index 000000000..388861f1f --- /dev/null +++ b/examples/SignatureRequestGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestGet( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestGetExample.java b/examples/SignatureRequestGetExample.java new file mode 100644 index 000000000..b93d099d6 --- /dev/null +++ b/examples/SignatureRequestGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestGetExample.php b/examples/SignatureRequestGetExample.php new file mode 100644 index 000000000..dfb79eda9 --- /dev/null +++ b/examples/SignatureRequestGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestGet( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestGet: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestGetExample.py b/examples/SignatureRequestGetExample.py new file mode 100644 index 000000000..47359ef9c --- /dev/null +++ b/examples/SignatureRequestGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_get( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_get: %s\n" % e) diff --git a/examples/SignatureRequestGetExample.rb b/examples/SignatureRequestGetExample.rb new file mode 100644 index 000000000..6399f34f6 --- /dev/null +++ b/examples/SignatureRequestGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}" +end diff --git a/examples/SignatureRequestGet.sh b/examples/SignatureRequestGetExample.sh similarity index 100% rename from examples/SignatureRequestGet.sh rename to examples/SignatureRequestGetExample.sh diff --git a/examples/SignatureRequestGetExample.ts b/examples/SignatureRequestGetExample.ts new file mode 100644 index 000000000..05ea209b6 --- /dev/null +++ b/examples/SignatureRequestGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestGet:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestList.cs b/examples/SignatureRequestList.cs deleted file mode 100644 index 56129479b..000000000 --- a/examples/SignatureRequestList.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var accountId = "accountId"; - - try - { - var result = signatureRequestApi.SignatureRequestList(accountId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestList.java b/examples/SignatureRequestList.java deleted file mode 100644 index 1afcd8b34..000000000 --- a/examples/SignatureRequestList.java +++ /dev/null @@ -1,41 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var accountId = "accountId"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - SignatureRequestListResponse result = signatureRequestApi.signatureRequestList( - accountId, - page, - pageSize, - query - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestList.js b/examples/SignatureRequestList.js deleted file mode 100644 index a25f34433..000000000 --- a/examples/SignatureRequestList.js +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = null; -const page = 1; - -const result = signatureRequestApi.signatureRequestList(accountId, page); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestList.php b/examples/SignatureRequestList.php deleted file mode 100644 index 16ef2306e..000000000 --- a/examples/SignatureRequestList.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$accountId = null; -$page = 1; - -try { - $result = $signatureRequestApi->signatureRequestList($accountId, $page); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestList.py b/examples/SignatureRequestList.py deleted file mode 100644 index b35f92b06..000000000 --- a/examples/SignatureRequestList.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - account_id = None - page = 1 - - try: - response = signature_request_api.signature_request_list( - account_id=account_id, - page=page, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestList.rb b/examples/SignatureRequestList.rb deleted file mode 100644 index 30a4c49fd..000000000 --- a/examples/SignatureRequestList.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -account_id = null -page = 1 - -begin - result = signature_request_api.signature_request_list({ account_id: account_id, page: page }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestList.ts b/examples/SignatureRequestList.ts deleted file mode 100644 index a25f34433..000000000 --- a/examples/SignatureRequestList.ts +++ /dev/null @@ -1,20 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = null; -const page = 1; - -const result = signatureRequestApi.signatureRequestList(accountId, page); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestListExample.cs b/examples/SignatureRequestListExample.cs new file mode 100644 index 000000000..d5b2bfb9d --- /dev/null +++ b/examples/SignatureRequestListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestListExample.java b/examples/SignatureRequestListExample.java new file mode 100644 index 000000000..76f018548 --- /dev/null +++ b/examples/SignatureRequestListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestListExample.php b/examples/SignatureRequestListExample.php new file mode 100644 index 000000000..c11043fcf --- /dev/null +++ b/examples/SignatureRequestListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestListExample.py b/examples/SignatureRequestListExample.py new file mode 100644 index 000000000..6d3db2fe3 --- /dev/null +++ b/examples/SignatureRequestListExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_list( + account_id=None, + page=1, + page_size=20, + query=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_list: %s\n" % e) diff --git a/examples/SignatureRequestListExample.rb b/examples/SignatureRequestListExample.rb new file mode 100644 index 000000000..2fcc01276 --- /dev/null +++ b/examples/SignatureRequestListExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}" +end diff --git a/examples/SignatureRequestList.sh b/examples/SignatureRequestListExample.sh similarity index 100% rename from examples/SignatureRequestList.sh rename to examples/SignatureRequestListExample.sh diff --git a/examples/SignatureRequestListExample.ts b/examples/SignatureRequestListExample.ts new file mode 100644 index 000000000..20d63eddb --- /dev/null +++ b/examples/SignatureRequestListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestList:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestReleaseHold.cs b/examples/SignatureRequestReleaseHold.cs deleted file mode 100644 index 5819bb9a7..000000000 --- a/examples/SignatureRequestReleaseHold.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestReleaseHold(signatureRequestId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestReleaseHold.java b/examples/SignatureRequestReleaseHold.java deleted file mode 100644 index c17085aca..000000000 --- a/examples/SignatureRequestReleaseHold.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestReleaseHold.js b/examples/SignatureRequestReleaseHold.js deleted file mode 100644 index be4707943..000000000 --- a/examples/SignatureRequestReleaseHold.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestReleaseHold.php b/examples/SignatureRequestReleaseHold.php deleted file mode 100644 index cfaf1104b..000000000 --- a/examples/SignatureRequestReleaseHold.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestReleaseHold($signatureRequestId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestReleaseHold.py b/examples/SignatureRequestReleaseHold.py deleted file mode 100644 index 4f6b26a0b..000000000 --- a/examples/SignatureRequestReleaseHold.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_release_hold( - signature_request_id - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestReleaseHold.rb b/examples/SignatureRequestReleaseHold.rb deleted file mode 100644 index e31f863fd..000000000 --- a/examples/SignatureRequestReleaseHold.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_release_hold(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestReleaseHold.ts b/examples/SignatureRequestReleaseHold.ts deleted file mode 100644 index be4707943..000000000 --- a/examples/SignatureRequestReleaseHold.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestReleaseHoldExample.cs b/examples/SignatureRequestReleaseHoldExample.cs new file mode 100644 index 000000000..9b64cd74c --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestReleaseHoldExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestReleaseHold( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestReleaseHold: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestReleaseHoldExample.java b/examples/SignatureRequestReleaseHoldExample.java new file mode 100644 index 000000000..521794ef1 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestReleaseHoldExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestReleaseHold"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestReleaseHoldExample.php b/examples/SignatureRequestReleaseHoldExample.php new file mode 100644 index 000000000..dcbbd1b31 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestReleaseHold( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestReleaseHold: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestReleaseHoldExample.py b/examples/SignatureRequestReleaseHoldExample.py new file mode 100644 index 000000000..e584b4fd2 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_release_hold( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_release_hold: %s\n" % e) diff --git a/examples/SignatureRequestReleaseHoldExample.rb b/examples/SignatureRequestReleaseHoldExample.rb new file mode 100644 index 000000000..422ab2d05 --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_release_hold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}" +end diff --git a/examples/SignatureRequestReleaseHold.sh b/examples/SignatureRequestReleaseHoldExample.sh similarity index 100% rename from examples/SignatureRequestReleaseHold.sh rename to examples/SignatureRequestReleaseHoldExample.sh diff --git a/examples/SignatureRequestReleaseHoldExample.ts b/examples/SignatureRequestReleaseHoldExample.ts new file mode 100644 index 000000000..3dca1e10d --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestReleaseHold:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestRemind.cs b/examples/SignatureRequestRemind.cs deleted file mode 100644 index 1dc8f6d68..000000000 --- a/examples/SignatureRequestRemind.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var data = new SignatureRequestRemindRequest( - emailAddress: "john@example.com" - ); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - var result = signatureRequestApi.SignatureRequestRemind(signatureRequestId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestRemind.java b/examples/SignatureRequestRemind.java deleted file mode 100644 index be5d42a1a..000000000 --- a/examples/SignatureRequestRemind.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestRemindRequest() - .emailAddress("john@example.com"); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestRemind.js b/examples/SignatureRequestRemind.js deleted file mode 100644 index 3e582ed72..000000000 --- a/examples/SignatureRequestRemind.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "john@example.com", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemind.php b/examples/SignatureRequestRemind.php deleted file mode 100644 index 059803134..000000000 --- a/examples/SignatureRequestRemind.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestRemindRequest(); -$data->setEmailAddress("john@example.com"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestRemind($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestRemind.py b/examples/SignatureRequestRemind.py deleted file mode 100644 index 52d093fe8..000000000 --- a/examples/SignatureRequestRemind.py +++ /dev/null @@ -1,27 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestRemindRequest( - email_address="john@example.com", - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_remind( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestRemind.rb b/examples/SignatureRequestRemind.rb deleted file mode 100644 index 10979a437..000000000 --- a/examples/SignatureRequestRemind.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestRemindRequest.new -data.email_address = "john@example.com" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_remind(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestRemind.ts b/examples/SignatureRequestRemind.ts deleted file mode 100644 index cfe7cef10..000000000 --- a/examples/SignatureRequestRemind.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.SignatureRequestRemindRequest = { - emailAddress: "john@example.com", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemindExample.cs b/examples/SignatureRequestRemindExample.cs new file mode 100644 index 000000000..bef1acbf1 --- /dev/null +++ b/examples/SignatureRequestRemindExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemindExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest( + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestRemind( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestRemindRequest: signatureRequestRemindRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemind: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestRemindExample.java b/examples/SignatureRequestRemindExample.java new file mode 100644 index 000000000..23830d9d3 --- /dev/null +++ b/examples/SignatureRequestRemindExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemindExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemind"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestRemindExample.php b/examples/SignatureRequestRemindExample.php new file mode 100644 index 000000000..10b5086a4 --- /dev/null +++ b/examples/SignatureRequestRemindExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_remind_request = (new Dropbox\Sign\Model\SignatureRequestRemindRequest()) + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemind( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request: $signature_request_remind_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemind: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestRemindExample.py b/examples/SignatureRequestRemindExample.py new file mode 100644 index 000000000..048db3092 --- /dev/null +++ b/examples/SignatureRequestRemindExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_remind_request = models.SignatureRequestRemindRequest( + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_remind( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request=signature_request_remind_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_remind: %s\n" % e) diff --git a/examples/SignatureRequestRemindExample.rb b/examples/SignatureRequestRemindExample.rb new file mode 100644 index 000000000..722928d9e --- /dev/null +++ b/examples/SignatureRequestRemindExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new +signature_request_remind_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_remind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_remind_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}" +end diff --git a/examples/SignatureRequestRemind.sh b/examples/SignatureRequestRemindExample.sh similarity index 100% rename from examples/SignatureRequestRemind.sh rename to examples/SignatureRequestRemindExample.sh diff --git a/examples/SignatureRequestRemindExample.ts b/examples/SignatureRequestRemindExample.ts new file mode 100644 index 000000000..fa558c1d6 --- /dev/null +++ b/examples/SignatureRequestRemindExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestRemindRequest = new models.SignatureRequestRemindRequest(); +signatureRequestRemindRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemind:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestRemove.cs b/examples/SignatureRequestRemove.cs deleted file mode 100644 index f60968345..000000000 --- a/examples/SignatureRequestRemove.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try - { - signatureRequestApi.SignatureRequestRemove(signatureRequestId); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestRemove.java b/examples/SignatureRequestRemove.java deleted file mode 100644 index 90ba45bf3..000000000 --- a/examples/SignatureRequestRemove.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - signatureRequestApi.signatureRequestRemove(signatureRequestId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestRemove.js b/examples/SignatureRequestRemove.js deleted file mode 100644 index 189a44578..000000000 --- a/examples/SignatureRequestRemove.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemove(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemove.php b/examples/SignatureRequestRemove.php deleted file mode 100644 index ad60276c6..000000000 --- a/examples/SignatureRequestRemove.php +++ /dev/null @@ -1,20 +0,0 @@ -setUsername("YOUR_API_KEY"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $signatureRequestApi->signatureRequestRemove($signatureRequestId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestRemove.py b/examples/SignatureRequestRemove.py deleted file mode 100644 index 0663bf869..000000000 --- a/examples/SignatureRequestRemove.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - signature_request_api.signature_request_remove(signature_request_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestRemove.rb b/examples/SignatureRequestRemove.rb deleted file mode 100644 index 63937f53e..000000000 --- a/examples/SignatureRequestRemove.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_remove(signature_request_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestRemove.ts b/examples/SignatureRequestRemove.ts deleted file mode 100644 index 189a44578..000000000 --- a/examples/SignatureRequestRemove.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemove(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestRemoveExample.cs b/examples/SignatureRequestRemoveExample.cs new file mode 100644 index 000000000..f0b9cf86e --- /dev/null +++ b/examples/SignatureRequestRemoveExample.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemoveExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + new SignatureRequestApi(config).SignatureRequestRemove( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemove: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestRemoveExample.java b/examples/SignatureRequestRemoveExample.java new file mode 100644 index 000000000..d205e388a --- /dev/null +++ b/examples/SignatureRequestRemoveExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemove"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestRemoveExample.php b/examples/SignatureRequestRemoveExample.php new file mode 100644 index 000000000..87ecc7e6f --- /dev/null +++ b/examples/SignatureRequestRemoveExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemove( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemove: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestRemoveExample.py b/examples/SignatureRequestRemoveExample.py new file mode 100644 index 000000000..3a380080b --- /dev/null +++ b/examples/SignatureRequestRemoveExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_remove( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_remove: %s\n" % e) diff --git a/examples/SignatureRequestRemoveExample.rb b/examples/SignatureRequestRemoveExample.rb new file mode 100644 index 000000000..7940519df --- /dev/null +++ b/examples/SignatureRequestRemoveExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_remove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}" +end diff --git a/examples/SignatureRequestRemove.sh b/examples/SignatureRequestRemoveExample.sh similarity index 100% rename from examples/SignatureRequestRemove.sh rename to examples/SignatureRequestRemoveExample.sh diff --git a/examples/SignatureRequestRemoveExample.ts b/examples/SignatureRequestRemoveExample.ts new file mode 100644 index 000000000..7f76eb5a2 --- /dev/null +++ b/examples/SignatureRequestRemoveExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemove:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestSend.cs b/examples/SignatureRequestSend.cs deleted file mode 100644 index c1d45d1f1..000000000 --- a/examples/SignatureRequestSend.cs +++ /dev/null @@ -1,85 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var metadata = new Dictionary() - { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestSendRequest( - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: signingOptions, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestSend(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestSend.java b/examples/SignatureRequestSend.java deleted file mode 100644 index 4382c852b..000000000 --- a/examples/SignatureRequestSend.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new SignatureRequestSendRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSend(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestSend.js b/examples/SignatureRequestSend.js deleted file mode 100644 index 1735a30a9..000000000 --- a/examples/SignatureRequestSend.js +++ /dev/null @@ -1,82 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSend.php b/examples/SignatureRequestSend.php deleted file mode 100644 index 419d7acd9..000000000 --- a/examples/SignatureRequestSend.php +++ /dev/null @@ -1,60 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\SignatureRequestSendRequest(); -$data->setTitle("NDA with Acme Co.") - ->setSubject("The NDA we talked about") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestSend($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestSend.py b/examples/SignatureRequestSend.py deleted file mode 100644 index 74a624e5d..000000000 --- a/examples/SignatureRequestSend.py +++ /dev/null @@ -1,62 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.SignatureRequestSendRequest( - title="NDA with Acme Co.", - subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=[ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, - field_options=field_options, - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_send(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestSend.rb b/examples/SignatureRequestSend.rb deleted file mode 100644 index d6981f2b2..000000000 --- a/examples/SignatureRequestSend.rb +++ /dev/null @@ -1,56 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::SignatureRequestSendRequest.new -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", -] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_send(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestSend.ts b/examples/SignatureRequestSend.ts deleted file mode 100644 index ca321ca9a..000000000 --- a/examples/SignatureRequestSend.ts +++ /dev/null @@ -1,82 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestSendRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSendExample.cs b/examples/SignatureRequestSendExample.cs new file mode 100644 index 000000000..2958c264c --- /dev/null +++ b/examples/SignatureRequestSendExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestSendExample.java b/examples/SignatureRequestSendExample.java new file mode 100644 index 000000000..2a57da157 --- /dev/null +++ b/examples/SignatureRequestSendExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestSendExample.php b/examples/SignatureRequestSendExample.php new file mode 100644 index 000000000..f922a579e --- /dev/null +++ b/examples/SignatureRequestSendExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestSendExample.py b/examples/SignatureRequestSendExample.py new file mode 100644 index 000000000..21b1bfc26 --- /dev/null +++ b/examples/SignatureRequestSendExample.py @@ -0,0 +1,72 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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_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) diff --git a/examples/SignatureRequestSendExample.rb b/examples/SignatureRequestSendExample.rb new file mode 100644 index 000000000..28905902d --- /dev/null +++ b/examples/SignatureRequestSendExample.rb @@ -0,0 +1,65 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/examples/SignatureRequestSend.sh b/examples/SignatureRequestSendExample.sh similarity index 100% rename from examples/SignatureRequestSend.sh rename to examples/SignatureRequestSendExample.sh diff --git a/examples/SignatureRequestSendExample.ts b/examples/SignatureRequestSendExample.ts new file mode 100644 index 000000000..c742336fa --- /dev/null +++ b/examples/SignatureRequestSendExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.signers = signers; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestSendGroupedSignersExample.cs b/examples/SignatureRequestSendGroupedSignersExample.cs new file mode 100644 index 000000000..8263d9170 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.cs @@ -0,0 +1,120 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestSendGroupedSignersExample.java b/examples/SignatureRequestSendGroupedSignersExample.java new file mode 100644 index 000000000..14d6d0fba --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.java @@ -0,0 +1,113 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestSendGroupedSignersExample.php b/examples/SignatureRequestSendGroupedSignersExample.php new file mode 100644 index 000000000..bec0368b8 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.php @@ -0,0 +1,95 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestSendGroupedSignersExample.py b/examples/SignatureRequestSendGroupedSignersExample.py new file mode 100644 index 000000000..3a7e649c6 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.py @@ -0,0 +1,102 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_send: %s\n" % e) diff --git a/examples/SignatureRequestSendGroupedSignersExample.rb b/examples/SignatureRequestSendGroupedSignersExample.rb new file mode 100644 index 000000000..dec38e89c --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.rb @@ -0,0 +1,91 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/examples/SignatureRequestSendGroupedSignersExample.ts b/examples/SignatureRequestSendGroupedSignersExample.ts new file mode 100644 index 000000000..d7414588a --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.ts @@ -0,0 +1,87 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestSendWithTemplate.cs b/examples/SignatureRequestSendWithTemplate.cs deleted file mode 100644 index 7c78edcc2..000000000 --- a/examples/SignatureRequestSendWithTemplate.cs +++ /dev/null @@ -1,69 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signer1 = new SubSignatureRequestTemplateSigner( - role: "Client", - emailAddress: "george@example.com", - name: "George" - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@emaple.com" - ); - - var customField1 = new SubCustomField( - name: "Cost", - value: "$20,000", - editor: "Client", - required: true - ); - - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var data = new SignatureRequestSendWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - ccs: new List(){cc1}, - customFields: new List(){customField1}, - signingOptions: signingOptions, - testMode: true - ); - - try - { - var result = signatureRequestApi.SignatureRequestSendWithTemplate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestSendWithTemplate.java b/examples/SignatureRequestSendWithTemplate.java deleted file mode 100644 index 1907e4d89..000000000 --- a/examples/SignatureRequestSendWithTemplate.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestSendWithTemplate.js b/examples/SignatureRequestSendWithTemplate.js deleted file mode 100644 index cbbb998b2..000000000 --- a/examples/SignatureRequestSendWithTemplate.js +++ /dev/null @@ -1,54 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1 = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSendWithTemplate.php b/examples/SignatureRequestSendWithTemplate.php deleted file mode 100644 index 665105770..000000000 --- a/examples/SignatureRequestSendWithTemplate.php +++ /dev/null @@ -1,54 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@example.com"); - -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") - ->setEditor("Client") - ->setRequired(true); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") - ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -try { - $result = $signatureRequestApi->signatureRequestSendWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestSendWithTemplate.py b/examples/SignatureRequestSendWithTemplate.py deleted file mode 100644 index 239036605..000000000 --- a/examples/SignatureRequestSendWithTemplate.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="george@example.com", - name="George", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - custom_field_1 = models.SubCustomField( - name="Cost", - value="$20,000", - editor="Client", - required=True, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, - ) - - try: - response = signature_request_api.signature_request_send_with_template(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestSendWithTemplate.rb b/examples/SignatureRequestSendWithTemplate.rb deleted file mode 100644 index a31f711ab..000000000 --- a/examples/SignatureRequestSendWithTemplate.rb +++ /dev/null @@ -1,50 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "george@example.com" -signer_1.name = "George" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -custom_field_1 = Dropbox::Sign::SubCustomField.new -custom_field_1.name = "Cost" -custom_field_1.value = "$20,000" -custom_field_1.editor = "Client" -custom_field_1.required = true - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.ccs = [cc_1] -data.custom_fields = [custom_field_1] -data.signing_options = signing_options -data.test_mode = true - -begin - result = signature_request_api.signature_request_send_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestSendWithTemplate.ts b/examples/SignatureRequestSendWithTemplate.ts deleted file mode 100644 index 2f2135094..000000000 --- a/examples/SignatureRequestSendWithTemplate.ts +++ /dev/null @@ -1,54 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1: DropboxSign.SubCustomField = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestSendWithTemplateExample.cs b/examples/SignatureRequestSendWithTemplateExample.cs new file mode 100644 index 000000000..024b92ce8 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.cs @@ -0,0 +1,89 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest: signatureRequestSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestSendWithTemplateExample.java b/examples/SignatureRequestSendWithTemplateExample.java new file mode 100644 index 000000000..fe3a4ce83 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.java @@ -0,0 +1,86 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestSendWithTemplateExample.php b/examples/SignatureRequestSendWithTemplateExample.php new file mode 100644 index 000000000..7c9963cf3 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSendWithTemplate( + signature_request_send_with_template_request: $signature_request_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestSendWithTemplateExample.py b/examples/SignatureRequestSendWithTemplateExample.py new file mode 100644 index 000000000..468a6b101 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.py @@ -0,0 +1,71 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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_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) diff --git a/examples/SignatureRequestSendWithTemplateExample.rb b/examples/SignatureRequestSendWithTemplateExample.rb new file mode 100644 index 000000000..4ee78fded --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.rb @@ -0,0 +1,63 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +custom_fields_1 = Dropbox::Sign::SubCustomField.new +custom_fields_1.name = "Cost" +custom_fields_1.editor = "Client" +custom_fields_1.required = true +custom_fields_1.value = "$20,000" + +custom_fields = [ + custom_fields_1, +] + +signature_request_send_with_template_request = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new +signature_request_send_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_send_with_template_request.subject = "Purchase Order" +signature_request_send_with_template_request.test_mode = true +signature_request_send_with_template_request.signing_options = signing_options +signature_request_send_with_template_request.signers = signers +signature_request_send_with_template_request.ccs = ccs +signature_request_send_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send_with_template( + signature_request_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}" +end diff --git a/examples/SignatureRequestSendWithTemplate.sh b/examples/SignatureRequestSendWithTemplateExample.sh similarity index 100% rename from examples/SignatureRequestSendWithTemplate.sh rename to examples/SignatureRequestSendWithTemplateExample.sh diff --git a/examples/SignatureRequestSendWithTemplateExample.ts b/examples/SignatureRequestSendWithTemplateExample.ts new file mode 100644 index 000000000..181e37a35 --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestSendWithTemplateRequest = new models.SignatureRequestSendWithTemplateRequest(); +signatureRequestSendWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestSendWithTemplateRequest.testMode = true; +signatureRequestSendWithTemplateRequest.signingOptions = signingOptions; +signatureRequestSendWithTemplateRequest.signers = signers; +signatureRequestSendWithTemplateRequest.ccs = ccs; +signatureRequestSendWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/SignatureRequestUpdate.cs b/examples/SignatureRequestUpdate.cs deleted file mode 100644 index b8d73b2d0..000000000 --- a/examples/SignatureRequestUpdate.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestUpdateRequest( - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3" - ); - - try - { - var result = signatureRequestApi.SignatureRequestUpdate(signatureRequestId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/SignatureRequestUpdate.java b/examples/SignatureRequestUpdate.java deleted file mode 100644 index aca14a22b..000000000 --- a/examples/SignatureRequestUpdate.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestUpdateRequest() - .emailAddress("john@example.com") - .signatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/SignatureRequestUpdate.js b/examples/SignatureRequestUpdate.js deleted file mode 100644 index 87372e748..000000000 --- a/examples/SignatureRequestUpdate.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestUpdate.php b/examples/SignatureRequestUpdate.php deleted file mode 100644 index eda22b742..000000000 --- a/examples/SignatureRequestUpdate.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestUpdateRequest(); -$data->setEmailAddress("john@example.com") - ->setSignatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -try { - $result = $signatureRequestApi->signatureRequestUpdate($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/SignatureRequestUpdate.py b/examples/SignatureRequestUpdate.py deleted file mode 100644 index 369000092..000000000 --- a/examples/SignatureRequestUpdate.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestUpdateRequest( - email_address="john@example.com", - signature_id="78caf2a1d01cd39cea2bc1cbb340dac3", - ) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - - try: - response = signature_request_api.signature_request_update( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/SignatureRequestUpdate.rb b/examples/SignatureRequestUpdate.rb deleted file mode 100644 index 8294a4410..000000000 --- a/examples/SignatureRequestUpdate.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestUpdateRequest.new -data.email_address = "john@example.com" -data.signature_id = "78caf2a1d01cd39cea2bc1cbb340dac3" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - -begin - result = signature_request_api.signature_request_update(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/SignatureRequestUpdate.ts b/examples/SignatureRequestUpdate.ts deleted file mode 100644 index 61a7c7466..000000000 --- a/examples/SignatureRequestUpdate.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.SignatureRequestUpdateRequest = { - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/SignatureRequestUpdateExample.cs b/examples/SignatureRequestUpdateExample.cs new file mode 100644 index 000000000..7d9551620 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest( + signatureId: "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestUpdate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestUpdateRequest: signatureRequestUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/SignatureRequestUpdateExample.java b/examples/SignatureRequestUpdateExample.java new file mode 100644 index 000000000..ef9873326 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/SignatureRequestUpdateExample.php b/examples/SignatureRequestUpdateExample.php new file mode 100644 index 000000000..818add598 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_update_request = (new Dropbox\Sign\Model\SignatureRequestUpdateRequest()) + ->setSignatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f") + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestUpdate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request: $signature_request_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestUpdate: {$e->getMessage()}"; +} diff --git a/examples/SignatureRequestUpdateExample.py b/examples/SignatureRequestUpdateExample.py new file mode 100644 index 000000000..0d9bc45fb --- /dev/null +++ b/examples/SignatureRequestUpdateExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_update_request = models.SignatureRequestUpdateRequest( + signature_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_update( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request=signature_request_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_update: %s\n" % e) diff --git a/examples/SignatureRequestUpdateExample.rb b/examples/SignatureRequestUpdateExample.rb new file mode 100644 index 000000000..3cac8ae67 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_update_request = Dropbox::Sign::SignatureRequestUpdateRequest.new +signature_request_update_request.signature_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +signature_request_update_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_update( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}" +end diff --git a/examples/SignatureRequestUpdate.sh b/examples/SignatureRequestUpdateExample.sh similarity index 100% rename from examples/SignatureRequestUpdate.sh rename to examples/SignatureRequestUpdateExample.sh diff --git a/examples/SignatureRequestUpdateExample.ts b/examples/SignatureRequestUpdateExample.ts new file mode 100644 index 000000000..fa02e0345 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestUpdateRequest = new models.SignatureRequestUpdateRequest(); +signatureRequestUpdateRequest.signatureId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +signatureRequestUpdateRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestUpdate:"); + console.log(error.body); +}); diff --git a/examples/TeamAddMember.cs b/examples/TeamAddMember.cs deleted file mode 100644 index 515014d8d..000000000 --- a/examples/TeamAddMember.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamAddMemberRequest( - emailAddress: "george@example.com" - ); - - try - { - var result = teamApi.TeamAddMember(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamAddMember.java b/examples/TeamAddMember.java deleted file mode 100644 index 454820932..000000000 --- a/examples/TeamAddMember.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamAddMemberRequest() - .emailAddress("george@example.com"); - - String teamId = null; - - try { - TeamGetResponse result = teamApi.teamAddMember(data, teamId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamAddMember.js b/examples/TeamAddMember.js deleted file mode 100644 index eaa69ade3..000000000 --- a/examples/TeamAddMember.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@example.com", -}; - -const result = teamApi.teamAddMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamAddMember.php b/examples/TeamAddMember.php deleted file mode 100644 index 7247c83ed..000000000 --- a/examples/TeamAddMember.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamAddMemberRequest(); -$data->setEmailAddress("george@example.com"); - -try { - $result = $teamApi->teamAddMember($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamAddMember.py b/examples/TeamAddMember.py deleted file mode 100644 index 67900f458..000000000 --- a/examples/TeamAddMember.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamAddMemberRequest( - email_address="george@example.com", - ) - - try: - response = team_api.team_add_member(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamAddMember.rb b/examples/TeamAddMember.rb deleted file mode 100644 index 34b41e33c..000000000 --- a/examples/TeamAddMember.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamAddMemberRequest.new -data.email_address = "george@example.com" - -begin - result = team_api.team_add_member(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamAddMember.ts b/examples/TeamAddMember.ts deleted file mode 100644 index 8e84f240f..000000000 --- a/examples/TeamAddMember.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamAddMemberRequest = { - emailAddress: "george@example.com", -}; - -const result = teamApi.teamAddMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamAddMemberAccountIdExample.cs b/examples/TeamAddMemberAccountIdExample.cs new file mode 100644 index 000000000..fe700fca7 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamAddMemberAccountIdExample.java b/examples/TeamAddMemberAccountIdExample.java new file mode 100644 index 000000000..cdeea5ec5 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamAddMemberAccountIdExample.php b/examples/TeamAddMemberAccountIdExample.php new file mode 100644 index 000000000..f864f4437 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/examples/TeamAddMemberAccountIdExample.py b/examples/TeamAddMemberAccountIdExample.py new file mode 100644 index 000000000..402e0f2c5 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/examples/TeamAddMemberAccountIdExample.rb b/examples/TeamAddMemberAccountIdExample.rb new file mode 100644 index 000000000..e19955860 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35" + +begin + response = Dropbox::Sign::TeamApi.new.team_add_member( + team_add_member_request, + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_add_member: #{e}" +end diff --git a/examples/TeamAddMemberAccountIdExample.ts b/examples/TeamAddMemberAccountIdExample.ts new file mode 100644 index 000000000..6aedbc340 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/examples/TeamAddMemberExample.cs b/examples/TeamAddMemberExample.cs new file mode 100644 index 000000000..3529c6ee0 --- /dev/null +++ b/examples/TeamAddMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + emailAddress: "george@example.com" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamAddMemberExample.java b/examples/TeamAddMemberExample.java new file mode 100644 index 000000000..788cc3bd0 --- /dev/null +++ b/examples/TeamAddMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamAddMemberExample.php b/examples/TeamAddMemberExample.php new file mode 100644 index 000000000..441e34dbe --- /dev/null +++ b/examples/TeamAddMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setEmailAddress("george@example.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/examples/TeamAddMemberExample.py b/examples/TeamAddMemberExample.py new file mode 100644 index 000000000..caef04ea5 --- /dev/null +++ b/examples/TeamAddMemberExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + email_address="george@example.com", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/examples/TeamAddMemberExample.rb b/examples/TeamAddMemberExample.rb new file mode 100644 index 000000000..b312e9894 --- /dev/null +++ b/examples/TeamAddMemberExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.email_address = "george@example.com" + +begin + response = Dropbox::Sign::TeamApi.new.team_add_member( + team_add_member_request, + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_add_member: #{e}" +end diff --git a/examples/TeamAddMember.sh b/examples/TeamAddMemberExample.sh similarity index 100% rename from examples/TeamAddMember.sh rename to examples/TeamAddMemberExample.sh diff --git a/examples/TeamAddMemberExample.ts b/examples/TeamAddMemberExample.ts new file mode 100644 index 000000000..0ffde9292 --- /dev/null +++ b/examples/TeamAddMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.emailAddress = "george@example.com"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/examples/TeamCreate.cs b/examples/TeamCreate.cs deleted file mode 100644 index 78d0768be..000000000 --- a/examples/TeamCreate.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamCreateRequest( - name: "New Team Name" - ); - - try - { - var result = teamApi.TeamCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamCreate.java b/examples/TeamCreate.java deleted file mode 100644 index 0ecf2f50d..000000000 --- a/examples/TeamCreate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamCreateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamCreate.js b/examples/TeamCreate.js deleted file mode 100644 index e8cb5486e..000000000 --- a/examples/TeamCreate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - name: "New Team Name" -}; - -const result = teamApi.teamCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamCreate.php b/examples/TeamCreate.php deleted file mode 100644 index 3abdac1c2..000000000 --- a/examples/TeamCreate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamCreateRequest(); -$data->setName("New Team Name"); - -try { - $result = $teamApi->teamCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamCreate.py b/examples/TeamCreate.py deleted file mode 100644 index 4c1384681..000000000 --- a/examples/TeamCreate.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamCreateRequest( - name="New Team Name", - ) - - try: - response = team_api.team_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamCreate.rb b/examples/TeamCreate.rb deleted file mode 100644 index b97bfa396..000000000 --- a/examples/TeamCreate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamCreateRequest.new -data.name = "New Team Name" - -begin - result = team_api.team_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamCreate.ts b/examples/TeamCreate.ts deleted file mode 100644 index 8ef337f86..000000000 --- a/examples/TeamCreate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamCreateRequest = { - name: "New Team Name" -}; - -const result = teamApi.teamCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamCreateExample.cs b/examples/TeamCreateExample.cs new file mode 100644 index 000000000..794c4627d --- /dev/null +++ b/examples/TeamCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamCreateRequest = new TeamCreateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamCreate( + teamCreateRequest: teamCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamCreateExample.java b/examples/TeamCreateExample.java new file mode 100644 index 000000000..0b72d53e2 --- /dev/null +++ b/examples/TeamCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamCreateExample.php b/examples/TeamCreateExample.php new file mode 100644 index 000000000..aabcac028 --- /dev/null +++ b/examples/TeamCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_create_request = (new Dropbox\Sign\Model\TeamCreateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamCreate( + team_create_request: $team_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamCreate: {$e->getMessage()}"; +} diff --git a/examples/TeamCreateExample.py b/examples/TeamCreateExample.py new file mode 100644 index 000000000..88772104e --- /dev/null +++ b/examples/TeamCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_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) diff --git a/examples/TeamCreateExample.rb b/examples/TeamCreateExample.rb new file mode 100644 index 000000000..6bac61268 --- /dev/null +++ b/examples/TeamCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_create_request = Dropbox::Sign::TeamCreateRequest.new +team_create_request.name = "New Team Name" + +begin + response = Dropbox::Sign::TeamApi.new.team_create( + team_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_create: #{e}" +end diff --git a/examples/TeamCreate.sh b/examples/TeamCreateExample.sh similarity index 100% rename from examples/TeamCreate.sh rename to examples/TeamCreateExample.sh diff --git a/examples/TeamCreateExample.ts b/examples/TeamCreateExample.ts new file mode 100644 index 000000000..22ad05f83 --- /dev/null +++ b/examples/TeamCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamCreateRequest = new models.TeamCreateRequest(); +teamCreateRequest.name = "New Team Name"; + +apiCaller.teamCreate( + teamCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamCreate:"); + console.log(error.body); +}); diff --git a/examples/TeamDelete.cs b/examples/TeamDelete.cs deleted file mode 100644 index 35eca42ff..000000000 --- a/examples/TeamDelete.cs +++ /dev/null @@ -1,31 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - try - { - teamApi.TeamDelete(); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamDelete.java b/examples/TeamDelete.java deleted file mode 100644 index 9f09ef6d3..000000000 --- a/examples/TeamDelete.java +++ /dev/null @@ -1,29 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - teamApi.teamDelete(); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamDelete.js b/examples/TeamDelete.js deleted file mode 100644 index b211e14a3..000000000 --- a/examples/TeamDelete.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamDelete(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamDelete.php b/examples/TeamDelete.php deleted file mode 100644 index 327fec0a6..000000000 --- a/examples/TeamDelete.php +++ /dev/null @@ -1,21 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $teamApi->teamDelete(); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamDelete.py b/examples/TeamDelete.py deleted file mode 100644 index 9548749c7..000000000 --- a/examples/TeamDelete.py +++ /dev/null @@ -1,16 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - try: - team_api.team_delete() - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamDelete.rb b/examples/TeamDelete.rb deleted file mode 100644 index 336f3bad4..000000000 --- a/examples/TeamDelete.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -begin - result = team_api.team_delete - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamDelete.ts b/examples/TeamDelete.ts deleted file mode 100644 index b211e14a3..000000000 --- a/examples/TeamDelete.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamDelete(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamDeleteExample.cs b/examples/TeamDeleteExample.cs new file mode 100644 index 000000000..b5c7a83b4 --- /dev/null +++ b/examples/TeamDeleteExample.cs @@ -0,0 +1,31 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +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); + } + } +} diff --git a/examples/TeamDeleteExample.java b/examples/TeamDeleteExample.java new file mode 100644 index 000000000..f39d1324c --- /dev/null +++ b/examples/TeamDeleteExample.java @@ -0,0 +1,36 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TeamApi(config).teamDelete(); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamDeleteExample.php b/examples/TeamDeleteExample.php new file mode 100644 index 000000000..9c429b748 --- /dev/null +++ b/examples/TeamDeleteExample.php @@ -0,0 +1,18 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TeamApi(config: $config))->teamDelete(); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamDelete: {$e->getMessage()}"; +} diff --git a/examples/TeamDeleteExample.py b/examples/TeamDeleteExample.py new file mode 100644 index 000000000..2da2f0be7 --- /dev/null +++ b/examples/TeamDeleteExample.py @@ -0,0 +1,16 @@ +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) diff --git a/examples/TeamDeleteExample.rb b/examples/TeamDeleteExample.rb new file mode 100644 index 000000000..729b6f794 --- /dev/null +++ b/examples/TeamDeleteExample.rb @@ -0,0 +1,13 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::TeamApi.new.team_delete +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_delete: #{e}" +end diff --git a/examples/TeamDelete.sh b/examples/TeamDeleteExample.sh similarity index 100% rename from examples/TeamDelete.sh rename to examples/TeamDeleteExample.sh diff --git a/examples/TeamDeleteExample.ts b/examples/TeamDeleteExample.ts new file mode 100644 index 000000000..c37216b0c --- /dev/null +++ b/examples/TeamDeleteExample.ts @@ -0,0 +1,12 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamDelete().catch(error => { + console.log("Exception when calling TeamApi#teamDelete:"); + console.log(error.body); +}); diff --git a/examples/TeamGet.cs b/examples/TeamGet.cs deleted file mode 100644 index f1984f536..000000000 --- a/examples/TeamGet.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - try - { - var result = teamApi.TeamGet(); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamGet.java b/examples/TeamGet.java deleted file mode 100644 index 035014b86..000000000 --- a/examples/TeamGet.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetResponse result = teamApi.teamGet(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamGet.js b/examples/TeamGet.js deleted file mode 100644 index dd1fc78da..000000000 --- a/examples/TeamGet.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamGet(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamGet.php b/examples/TeamGet.php deleted file mode 100644 index ccd714dad..000000000 --- a/examples/TeamGet.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $result = $teamApi->teamGet(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamGet.py b/examples/TeamGet.py deleted file mode 100644 index 7272e46f3..000000000 --- a/examples/TeamGet.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - try: - response = team_api.team_get() - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamGet.rb b/examples/TeamGet.rb deleted file mode 100644 index 7f3048844..000000000 --- a/examples/TeamGet.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -begin - result = team_api.team_get - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamGet.ts b/examples/TeamGet.ts deleted file mode 100644 index dd1fc78da..000000000 --- a/examples/TeamGet.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamGet(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamGetExample.cs b/examples/TeamGetExample.cs new file mode 100644 index 000000000..3a79cd2a4 --- /dev/null +++ b/examples/TeamGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamGetExample.java b/examples/TeamGetExample.java new file mode 100644 index 000000000..4356bb8a9 --- /dev/null +++ b/examples/TeamGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamGetExample.php b/examples/TeamGetExample.php new file mode 100644 index 000000000..79c6e054d --- /dev/null +++ b/examples/TeamGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamGet: {$e->getMessage()}"; +} diff --git a/examples/TeamGetExample.py b/examples/TeamGetExample.py new file mode 100644 index 000000000..dc0b0532e --- /dev/null +++ b/examples/TeamGetExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_get() + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_get: %s\n" % e) diff --git a/examples/TeamGetExample.rb b/examples/TeamGetExample.rb new file mode 100644 index 000000000..903822830 --- /dev/null +++ b/examples/TeamGetExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_get + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_get: #{e}" +end diff --git a/examples/TeamGet.sh b/examples/TeamGetExample.sh similarity index 100% rename from examples/TeamGet.sh rename to examples/TeamGetExample.sh diff --git a/examples/TeamGetExample.ts b/examples/TeamGetExample.ts new file mode 100644 index 000000000..65d8758fc --- /dev/null +++ b/examples/TeamGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamGet:"); + console.log(error.body); +}); diff --git a/examples/TeamInfo.cs b/examples/TeamInfo.cs deleted file mode 100644 index 284dcdfed..000000000 --- a/examples/TeamInfo.cs +++ /dev/null @@ -1,32 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - try - { - var result = teamApi.TeamInfo(); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamInfo.java b/examples/TeamInfo.java deleted file mode 100644 index 94ace0c38..000000000 --- a/examples/TeamInfo.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetInfoResponse result = teamApi.teamInfo(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamInfo"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamInfo.js b/examples/TeamInfo.js deleted file mode 100644 index 0e03b0f70..000000000 --- a/examples/TeamInfo.js +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamInfo(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInfo.php b/examples/TeamInfo.php deleted file mode 100644 index e43c06b72..000000000 --- a/examples/TeamInfo.php +++ /dev/null @@ -1,22 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -try { - $result = $teamApi->teamInfo(); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamInfo.py b/examples/TeamInfo.py deleted file mode 100644 index fe54802bc..000000000 --- a/examples/TeamInfo.py +++ /dev/null @@ -1,19 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - try: - response = team_api.team_info() - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamInfo.rb b/examples/TeamInfo.rb deleted file mode 100644 index a7435f0c7..000000000 --- a/examples/TeamInfo.rb +++ /dev/null @@ -1,18 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -begin - result = team_api.team_info - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamInfo.ts b/examples/TeamInfo.ts deleted file mode 100644 index 0e03b0f70..000000000 --- a/examples/TeamInfo.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamInfo(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInfoExample.cs b/examples/TeamInfoExample.cs new file mode 100644 index 000000000..a761bce3c --- /dev/null +++ b/examples/TeamInfoExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInfoExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInfo( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInfo: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamInfoExample.java b/examples/TeamInfoExample.java new file mode 100644 index 000000000..8b5718628 --- /dev/null +++ b/examples/TeamInfoExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInfoExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamInfoExample.php b/examples/TeamInfoExample.php new file mode 100644 index 000000000..c908d5182 --- /dev/null +++ b/examples/TeamInfoExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInfo( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInfo: {$e->getMessage()}"; +} diff --git a/examples/TeamInfoExample.py b/examples/TeamInfoExample.py new file mode 100644 index 000000000..994688dc2 --- /dev/null +++ b/examples/TeamInfoExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_info( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_info: %s\n" % e) diff --git a/examples/TeamInfoExample.rb b/examples/TeamInfoExample.rb new file mode 100644 index 000000000..dfe5874d5 --- /dev/null +++ b/examples/TeamInfoExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_info( + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_info: #{e}" +end diff --git a/examples/TeamInfo.sh b/examples/TeamInfoExample.sh similarity index 100% rename from examples/TeamInfo.sh rename to examples/TeamInfoExample.sh diff --git a/examples/TeamInfoExample.ts b/examples/TeamInfoExample.ts new file mode 100644 index 000000000..d0050e94c --- /dev/null +++ b/examples/TeamInfoExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInfo:"); + console.log(error.body); +}); diff --git a/examples/TeamInvites.cs b/examples/TeamInvites.cs deleted file mode 100644 index b52c3b1c5..000000000 --- a/examples/TeamInvites.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var emailAddress = "user@dropboxsign.com"; - - try - { - var result = teamApi.TeamInvites(emailAddress); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamInvites.java b/examples/TeamInvites.java deleted file mode 100644 index 56b517b17..000000000 --- a/examples/TeamInvites.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var emailAddress = "user@dropboxsign.com"; - - try { - TeamInvitesResponse result = teamApi.teamInvites(emailAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamInvites.js b/examples/TeamInvites.js deleted file mode 100644 index 21a250156..000000000 --- a/examples/TeamInvites.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const emailAddress = "user@dropboxsign.com"; - -const result = teamApi.teamInvites(emailAddress); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInvites.php b/examples/TeamInvites.php deleted file mode 100644 index 2cda1469d..000000000 --- a/examples/TeamInvites.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$emailAddress = "user@dropboxsign.com"; - -try { - $result = $teamApi->teamInvites($emailAddress); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamInvites.py b/examples/TeamInvites.py deleted file mode 100644 index 898e64187..000000000 --- a/examples/TeamInvites.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - email_address = "user@dropboxsign.com" - - try: - response = team_api.team_invites(email_address=email_address) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamInvites.rb b/examples/TeamInvites.rb deleted file mode 100644 index 7294ea425..000000000 --- a/examples/TeamInvites.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -email_address = "user@dropboxsign.com" - -begin - result = team_api.team_invites({ email_address: email_address }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamInvites.ts b/examples/TeamInvites.ts deleted file mode 100644 index 21a250156..000000000 --- a/examples/TeamInvites.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const emailAddress = "user@dropboxsign.com"; - -const result = teamApi.teamInvites(emailAddress); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamInvitesExample.cs b/examples/TeamInvitesExample.cs new file mode 100644 index 000000000..90454cbac --- /dev/null +++ b/examples/TeamInvitesExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInvitesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInvites(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInvites: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamInvitesExample.java b/examples/TeamInvitesExample.java new file mode 100644 index 000000000..204109825 --- /dev/null +++ b/examples/TeamInvitesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInvitesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInvites"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamInvitesExample.php b/examples/TeamInvitesExample.php new file mode 100644 index 000000000..db9459376 --- /dev/null +++ b/examples/TeamInvitesExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInvites(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInvites: {$e->getMessage()}"; +} diff --git a/examples/TeamInvitesExample.py b/examples/TeamInvitesExample.py new file mode 100644 index 000000000..c9764ae11 --- /dev/null +++ b/examples/TeamInvitesExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_invites() + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_invites: %s\n" % e) diff --git a/examples/TeamInvitesExample.rb b/examples/TeamInvitesExample.rb new file mode 100644 index 000000000..9fee219c0 --- /dev/null +++ b/examples/TeamInvitesExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_invites + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_invites: #{e}" +end diff --git a/examples/TeamInvites.sh b/examples/TeamInvitesExample.sh similarity index 100% rename from examples/TeamInvites.sh rename to examples/TeamInvitesExample.sh diff --git a/examples/TeamInvitesExample.ts b/examples/TeamInvitesExample.ts new file mode 100644 index 000000000..7debb4877 --- /dev/null +++ b/examples/TeamInvitesExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInvites().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInvites:"); + console.log(error.body); +}); diff --git a/examples/TeamMembers.cs b/examples/TeamMembers.cs deleted file mode 100644 index 3426971cf..000000000 --- a/examples/TeamMembers.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - - try - { - var result = teamApi.TeamMembers(teamId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamMembers.java b/examples/TeamMembers.java deleted file mode 100644 index c3579567b..000000000 --- a/examples/TeamMembers.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamMembersResponse result = teamApi.teamMembers(teamId, page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamMembers.js b/examples/TeamMembers.js deleted file mode 100644 index eee5075cf..000000000 --- a/examples/TeamMembers.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamMembers(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamMembers.php b/examples/TeamMembers.php deleted file mode 100644 index 60128aa30..000000000 --- a/examples/TeamMembers.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -try { - $result = $teamApi->teamMembers($teamId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamMembers.py b/examples/TeamMembers.py deleted file mode 100644 index ed27ca884..000000000 --- a/examples/TeamMembers.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - - try: - response = team_api.team_members(team_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamMembers.rb b/examples/TeamMembers.rb deleted file mode 100644 index ce05cb2d7..000000000 --- a/examples/TeamMembers.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - -begin - result = team_api.team_members(team_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamMembers.ts b/examples/TeamMembers.ts deleted file mode 100644 index eee5075cf..000000000 --- a/examples/TeamMembers.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamMembers(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamMembersExample.cs b/examples/TeamMembersExample.cs new file mode 100644 index 000000000..72213f8a7 --- /dev/null +++ b/examples/TeamMembersExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamMembersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamMembers( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamMembers: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamMembersExample.java b/examples/TeamMembersExample.java new file mode 100644 index 000000000..bc709c951 --- /dev/null +++ b/examples/TeamMembersExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamMembersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamMembers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamMembersExample.php b/examples/TeamMembersExample.php new file mode 100644 index 000000000..79c0343b1 --- /dev/null +++ b/examples/TeamMembersExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamMembers( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamMembers: {$e->getMessage()}"; +} diff --git a/examples/TeamMembersExample.py b/examples/TeamMembersExample.py new file mode 100644 index 000000000..92c3ebaf5 --- /dev/null +++ b/examples/TeamMembersExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_members( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_members: %s\n" % e) diff --git a/examples/TeamMembersExample.rb b/examples/TeamMembersExample.rb new file mode 100644 index 000000000..f35f9d174 --- /dev/null +++ b/examples/TeamMembersExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_members( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_members: #{e}" +end diff --git a/examples/TeamMembers.sh b/examples/TeamMembersExample.sh similarity index 100% rename from examples/TeamMembers.sh rename to examples/TeamMembersExample.sh diff --git a/examples/TeamMembersExample.ts b/examples/TeamMembersExample.ts new file mode 100644 index 000000000..17479dbda --- /dev/null +++ b/examples/TeamMembersExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamMembers:"); + console.log(error.body); +}); diff --git a/examples/TeamRemoveMember.cs b/examples/TeamRemoveMember.cs deleted file mode 100644 index c4051b639..000000000 --- a/examples/TeamRemoveMember.cs +++ /dev/null @@ -1,37 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamRemoveMemberRequest( - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com" - ); - - try - { - var result = teamApi.TeamRemoveMember(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamRemoveMember.java b/examples/TeamRemoveMember.java deleted file mode 100644 index 28514c7ec..000000000 --- a/examples/TeamRemoveMember.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamRemoveMemberRequest() - .emailAddress("teammate@dropboxsign.com") - .newOwnerEmailAddress("new_teammate@dropboxsign.com"); - - try { - TeamGetResponse result = teamApi.teamRemoveMember(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamRemoveMember.js b/examples/TeamRemoveMember.js deleted file mode 100644 index 291e6fadb..000000000 --- a/examples/TeamRemoveMember.js +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com", -}; - -const result = teamApi.teamRemoveMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamRemoveMember.php b/examples/TeamRemoveMember.php deleted file mode 100644 index 73ec2ae6c..000000000 --- a/examples/TeamRemoveMember.php +++ /dev/null @@ -1,26 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamRemoveMemberRequest(); -$data->setEmailAddress("teammate@dropboxsign.com") - ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); - -try { - $result = $teamApi->teamRemoveMember($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamRemoveMember.py b/examples/TeamRemoveMember.py deleted file mode 100644 index 5dfe5b0bf..000000000 --- a/examples/TeamRemoveMember.py +++ /dev/null @@ -1,24 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamRemoveMemberRequest( - email_address="teammate@dropboxsign.com", - new_owner_email_address="new_teammate@dropboxsign.com", - ) - - try: - response = team_api.team_remove_member(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamRemoveMember.rb b/examples/TeamRemoveMember.rb deleted file mode 100644 index b2255ef4b..000000000 --- a/examples/TeamRemoveMember.rb +++ /dev/null @@ -1,22 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamRemoveMemberRequest.new -data.email_address = "teammate@dropboxsign.com" -data.new_owner_email_address = "new_teammate@dropboxsign.com" - -begin - result = team_api.team_remove_member(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamRemoveMember.ts b/examples/TeamRemoveMember.ts deleted file mode 100644 index b7ba4beac..000000000 --- a/examples/TeamRemoveMember.ts +++ /dev/null @@ -1,22 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamRemoveMemberRequest = { - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com", -}; - -const result = teamApi.teamRemoveMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamRemoveMemberAccountIdExample.cs b/examples/TeamRemoveMemberAccountIdExample.cs new file mode 100644 index 000000000..0c6ae21a3 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamRemoveMemberAccountIdExample.java b/examples/TeamRemoveMemberAccountIdExample.java new file mode 100644 index 000000000..85c46ee65 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamRemoveMemberAccountIdExample.php b/examples/TeamRemoveMemberAccountIdExample.php new file mode 100644 index 000000000..90d902633 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/examples/TeamRemoveMemberAccountIdExample.py b/examples/TeamRemoveMemberAccountIdExample.py new file mode 100644 index 000000000..132ab54cb --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_remove_member_request = models.TeamRemoveMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) diff --git a/examples/TeamRemoveMemberAccountIdExample.rb b/examples/TeamRemoveMemberAccountIdExample.rb new file mode 100644 index 000000000..16913dd79 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new +team_remove_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35" + +begin + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_remove_member: #{e}" +end diff --git a/examples/TeamRemoveMemberAccountIdExample.ts b/examples/TeamRemoveMemberAccountIdExample.ts new file mode 100644 index 000000000..e170817b3 --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/examples/TeamRemoveMemberExample.cs b/examples/TeamRemoveMemberExample.cs new file mode 100644 index 000000000..23aeff1ff --- /dev/null +++ b/examples/TeamRemoveMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + emailAddress: "teammate@dropboxsign.com", + newOwnerEmailAddress: "new_teammate@dropboxsign.com" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamRemoveMemberExample.java b/examples/TeamRemoveMemberExample.java new file mode 100644 index 000000000..40938583f --- /dev/null +++ b/examples/TeamRemoveMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamRemoveMemberExample.php b/examples/TeamRemoveMemberExample.php new file mode 100644 index 000000000..3212aa335 --- /dev/null +++ b/examples/TeamRemoveMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setEmailAddress("teammate@dropboxsign.com") + ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/examples/TeamRemoveMemberExample.py b/examples/TeamRemoveMemberExample.py new file mode 100644 index 000000000..7847d7289 --- /dev/null +++ b/examples/TeamRemoveMemberExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_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) diff --git a/examples/TeamRemoveMemberExample.rb b/examples/TeamRemoveMemberExample.rb new file mode 100644 index 000000000..27c87cb0e --- /dev/null +++ b/examples/TeamRemoveMemberExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new +team_remove_member_request.email_address = "teammate@dropboxsign.com" +team_remove_member_request.new_owner_email_address = "new_teammate@dropboxsign.com" + +begin + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_remove_member: #{e}" +end diff --git a/examples/TeamRemoveMember.sh b/examples/TeamRemoveMemberExample.sh similarity index 100% rename from examples/TeamRemoveMember.sh rename to examples/TeamRemoveMemberExample.sh diff --git a/examples/TeamRemoveMemberExample.ts b/examples/TeamRemoveMemberExample.ts new file mode 100644 index 000000000..efd33d694 --- /dev/null +++ b/examples/TeamRemoveMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.emailAddress = "teammate@dropboxsign.com"; +teamRemoveMemberRequest.newOwnerEmailAddress = "new_teammate@dropboxsign.com"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/examples/TeamSubTeams.cs b/examples/TeamSubTeams.cs deleted file mode 100644 index cab5c691f..000000000 --- a/examples/TeamSubTeams.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - - try - { - var result = teamApi.TeamSubTeams(teamId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamSubTeams.java b/examples/TeamSubTeams.java deleted file mode 100644 index f4a5b50e5..000000000 --- a/examples/TeamSubTeams.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamSubTeamsResponse result = teamApi.teamSubTeams(teamId, page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamSubTeams"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamSubTeams.js b/examples/TeamSubTeams.js deleted file mode 100644 index faf7a9ea6..000000000 --- a/examples/TeamSubTeams.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamSubTeams(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamSubTeams.php b/examples/TeamSubTeams.php deleted file mode 100644 index 8daf498e2..000000000 --- a/examples/TeamSubTeams.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -try { - $result = $teamApi->teamSubTeams($teamId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamSubTeams.py b/examples/TeamSubTeams.py deleted file mode 100644 index d6f7dc183..000000000 --- a/examples/TeamSubTeams.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - - try: - response = team_api.team_sub_teams(team_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamSubTeams.rb b/examples/TeamSubTeams.rb deleted file mode 100644 index 94192cdff..000000000 --- a/examples/TeamSubTeams.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - -begin - result = team_api.team_sub_teams(team_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamSubTeams.ts b/examples/TeamSubTeams.ts deleted file mode 100644 index faf7a9ea6..000000000 --- a/examples/TeamSubTeams.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamSubTeams(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamSubTeamsExample.cs b/examples/TeamSubTeamsExample.cs new file mode 100644 index 000000000..1760310a5 --- /dev/null +++ b/examples/TeamSubTeamsExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamSubTeamsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamSubTeams( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamSubTeams: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamSubTeamsExample.java b/examples/TeamSubTeamsExample.java new file mode 100644 index 000000000..f0ee98cf1 --- /dev/null +++ b/examples/TeamSubTeamsExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamSubTeamsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamSubTeams"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamSubTeamsExample.php b/examples/TeamSubTeamsExample.php new file mode 100644 index 000000000..ae7a990e2 --- /dev/null +++ b/examples/TeamSubTeamsExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamSubTeams( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamSubTeams: {$e->getMessage()}"; +} diff --git a/examples/TeamSubTeamsExample.py b/examples/TeamSubTeamsExample.py new file mode 100644 index 000000000..93afde113 --- /dev/null +++ b/examples/TeamSubTeamsExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_sub_teams( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_sub_teams: %s\n" % e) diff --git a/examples/TeamSubTeamsExample.rb b/examples/TeamSubTeamsExample.rb new file mode 100644 index 000000000..12c87f2b7 --- /dev/null +++ b/examples/TeamSubTeamsExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_sub_teams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_sub_teams: #{e}" +end diff --git a/examples/TeamSubTeams.sh b/examples/TeamSubTeamsExample.sh similarity index 100% rename from examples/TeamSubTeams.sh rename to examples/TeamSubTeamsExample.sh diff --git a/examples/TeamSubTeamsExample.ts b/examples/TeamSubTeamsExample.ts new file mode 100644 index 000000000..e6ef9c8da --- /dev/null +++ b/examples/TeamSubTeamsExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamSubTeams:"); + console.log(error.body); +}); diff --git a/examples/TeamUpdate.cs b/examples/TeamUpdate.cs deleted file mode 100644 index f31b538a5..000000000 --- a/examples/TeamUpdate.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamUpdateRequest( - name: "New Team Name" - ); - - try - { - var result = teamApi.TeamUpdate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TeamUpdate.java b/examples/TeamUpdate.java deleted file mode 100644 index eedcafc71..000000000 --- a/examples/TeamUpdate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamUpdateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamUpdate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TeamUpdate.js b/examples/TeamUpdate.js deleted file mode 100644 index 842457d4c..000000000 --- a/examples/TeamUpdate.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - name: "New Team Name", -}; - -const result = teamApi.teamUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamUpdate.php b/examples/TeamUpdate.php deleted file mode 100644 index 6bac87d66..000000000 --- a/examples/TeamUpdate.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamUpdateRequest(); -$data->setName("New Team Name"); - -try { - $result = $teamApi->teamUpdate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TeamUpdate.py b/examples/TeamUpdate.py deleted file mode 100644 index b89ef1135..000000000 --- a/examples/TeamUpdate.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamUpdateRequest( - name="New Team Name", - ) - - try: - response = team_api.team_update(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TeamUpdate.rb b/examples/TeamUpdate.rb deleted file mode 100644 index 27edefa90..000000000 --- a/examples/TeamUpdate.rb +++ /dev/null @@ -1,21 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamUpdateRequest.new -data.name = "New Team Name" - -begin - result = team_api.team_update(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TeamUpdate.ts b/examples/TeamUpdate.ts deleted file mode 100644 index 73eac24a6..000000000 --- a/examples/TeamUpdate.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamUpdateRequest = { - name: "New Team Name", -}; - -const result = teamApi.teamUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TeamUpdateExample.cs b/examples/TeamUpdateExample.cs new file mode 100644 index 000000000..355811ee4 --- /dev/null +++ b/examples/TeamUpdateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamUpdateRequest = new TeamUpdateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamUpdate( + teamUpdateRequest: teamUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TeamUpdateExample.java b/examples/TeamUpdateExample.java new file mode 100644 index 000000000..54f6bf2a1 --- /dev/null +++ b/examples/TeamUpdateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TeamUpdateExample.php b/examples/TeamUpdateExample.php new file mode 100644 index 000000000..3338af6e6 --- /dev/null +++ b/examples/TeamUpdateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_update_request = (new Dropbox\Sign\Model\TeamUpdateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamUpdate( + team_update_request: $team_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamUpdate: {$e->getMessage()}"; +} diff --git a/examples/TeamUpdateExample.py b/examples/TeamUpdateExample.py new file mode 100644 index 000000000..e28eb2907 --- /dev/null +++ b/examples/TeamUpdateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_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) diff --git a/examples/TeamUpdateExample.rb b/examples/TeamUpdateExample.rb new file mode 100644 index 000000000..7f925ffff --- /dev/null +++ b/examples/TeamUpdateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_update_request = Dropbox::Sign::TeamUpdateRequest.new +team_update_request.name = "New Team Name" + +begin + response = Dropbox::Sign::TeamApi.new.team_update( + team_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_update: #{e}" +end diff --git a/examples/TeamUpdate.sh b/examples/TeamUpdateExample.sh similarity index 100% rename from examples/TeamUpdate.sh rename to examples/TeamUpdateExample.sh diff --git a/examples/TeamUpdateExample.ts b/examples/TeamUpdateExample.ts new file mode 100644 index 000000000..0e32bcdd4 --- /dev/null +++ b/examples/TeamUpdateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamUpdateRequest = new models.TeamUpdateRequest(); +teamUpdateRequest.name = "New Team Name"; + +apiCaller.teamUpdate( + teamUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamUpdate:"); + console.log(error.body); +}); diff --git a/examples/TemplateAddUser.cs b/examples/TemplateAddUser.cs deleted file mode 100644 index 23d85c8c1..000000000 --- a/examples/TemplateAddUser.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - var data = new TemplateAddUserRequest( - emailAddress: "george@dropboxsign.com" - ); - - try - { - var result = templateApi.TemplateAddUser(templateId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateAddUser.java b/examples/TemplateAddUser.java deleted file mode 100644 index 759990b4c..000000000 --- a/examples/TemplateAddUser.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateAddUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateAddUser(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateAddUser.js b/examples/TemplateAddUser.js deleted file mode 100644 index 1b53fa3e2..000000000 --- a/examples/TemplateAddUser.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateAddUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateAddUser.php b/examples/TemplateAddUser.php deleted file mode 100644 index 2bbc31885..000000000 --- a/examples/TemplateAddUser.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateAddUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateAddUser($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateAddUser.py b/examples/TemplateAddUser.py deleted file mode 100644 index 5476f8e8b..000000000 --- a/examples/TemplateAddUser.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateAddUserRequest( - email_address="george@dropboxsign.com", - ) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_add_user(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateAddUser.rb b/examples/TemplateAddUser.rb deleted file mode 100644 index 89573c390..000000000 --- a/examples/TemplateAddUser.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateAddUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "f57db65d3f933b5316d398057a36176831451a35" - -begin - result = template_api.template_add_user(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateAddUser.ts b/examples/TemplateAddUser.ts deleted file mode 100644 index 6919a088d..000000000 --- a/examples/TemplateAddUser.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateAddUserRequest = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateAddUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateAddUserExample.cs b/examples/TemplateAddUserExample.cs new file mode 100644 index 000000000..dc4107a2f --- /dev/null +++ b/examples/TemplateAddUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateAddUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateAddUserRequest = new TemplateAddUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateAddUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateAddUserRequest: templateAddUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateAddUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateAddUserExample.java b/examples/TemplateAddUserExample.java new file mode 100644 index 000000000..144cb00ef --- /dev/null +++ b/examples/TemplateAddUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateAddUserExample.php b/examples/TemplateAddUserExample.php new file mode 100644 index 000000000..a76613a1d --- /dev/null +++ b/examples/TemplateAddUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_add_user_request = (new Dropbox\Sign\Model\TemplateAddUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateAddUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request: $template_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateAddUser: {$e->getMessage()}"; +} diff --git a/examples/TemplateAddUserExample.py b/examples/TemplateAddUserExample.py new file mode 100644 index 000000000..5259a01d4 --- /dev/null +++ b/examples/TemplateAddUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_add_user_request = models.TemplateAddUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_add_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request=template_add_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_add_user: %s\n" % e) diff --git a/examples/TemplateAddUserExample.rb b/examples/TemplateAddUserExample.rb new file mode 100644 index 000000000..a34a81fbf --- /dev/null +++ b/examples/TemplateAddUserExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_add_user_request = Dropbox::Sign::TemplateAddUserRequest.new +template_add_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_add_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_add_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_add_user: #{e}" +end diff --git a/examples/TemplateAddUser.sh b/examples/TemplateAddUserExample.sh similarity index 100% rename from examples/TemplateAddUser.sh rename to examples/TemplateAddUserExample.sh diff --git a/examples/TemplateAddUserExample.ts b/examples/TemplateAddUserExample.ts new file mode 100644 index 000000000..f801c3e65 --- /dev/null +++ b/examples/TemplateAddUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateAddUserRequest = new models.TemplateAddUserRequest(); +templateAddUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateAddUser:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreate.cs b/examples/TemplateCreate.cs deleted file mode 100644 index cce736293..000000000 --- a/examples/TemplateCreate.cs +++ /dev/null @@ -1,79 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var role1 = new SubTemplateRole( - name: "Client", - order: 0 - ); - - var role2 = new SubTemplateRole( - name: "Witness", - order: 1 - ); - - var mergeField1 = new SubMergeField( - name: "Full Name", - type: SubMergeField.TypeEnum.Text - ); - - var mergeField2 = new SubMergeField( - name: "Is Registered?", - type: SubMergeField.TypeEnum.Checkbox - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateCreateRequest( - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: files, - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: new List(){role1, role2}, - ccRoles: new List(){"Manager"}, - mergeFields: new List(){mergeField1, mergeField2}, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = templateApi.TemplateCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateCreate.java b/examples/TemplateCreate.java deleted file mode 100644 index f2cd5990b..000000000 --- a/examples/TemplateCreate.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateResponse result = templateApi.templateCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateCreate.js b/examples/TemplateCreate.js deleted file mode 100644 index f71d247e1..000000000 --- a/examples/TemplateCreate.js +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1 = { - name: "Client", - order: 0, -}; - -const role2 = { - name: "Witness", - order: 1, -}; - -const mergeField1 = { - name: "Full Name", - type: "text", -}; - -const mergeField2 = { - name: "Is Registered?", - type: "checkbox", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreate.php b/examples/TemplateCreate.php deleted file mode 100644 index 7b1b866f2..000000000 --- a/examples/TemplateCreate.php +++ /dev/null @@ -1,53 +0,0 @@ -setUsername('YOUR_API_KEY'); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName('Client') - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName('Witness') - ->setOrder(1); - -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName('Full Name') - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); - -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName('Is Registered?') - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateRequest(); -$data->setClientId('37dee8d8440c66d54cfa05d92c160882') - ->setFiles([new SplFileObject(__DIR__ . '/example_signature_request.pdf')]) - ->setTitle('Test Template') - ->setSubject('Please sign this document') - ->setMessage('For your approval') - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(['Manager']) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $templateApi->templateCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo 'Exception when calling Dropbox Sign API: ' - . print_r($error->getError()); -} diff --git a/examples/TemplateCreate.py b/examples/TemplateCreate.py deleted file mode 100644 index cb7b60e51..000000000 --- a/examples/TemplateCreate.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, - ) - - merge_field_1 = models.SubMergeField( - name="Full Name", - type="text", - ) - - merge_field_2 = models.SubMergeField( - name="Is Registered?", - type="checkbox", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.TemplateCreateRequest( - client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", - message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, - test_mode=True, - ) - - try: - response = template_api.template_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateCreate.rb b/examples/TemplateCreate.rb deleted file mode 100644 index 09863a2f2..000000000 --- a/examples/TemplateCreate.rb +++ /dev/null @@ -1,49 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -role_1 = Dropbox::Sign::SubTemplateRole.new -role_1.name = "Client" -role_1.order = 0 - -role_2 = Dropbox::Sign::SubTemplateRole.new -role_2.name = "Witness" -role_2.order = 1 - -merge_field_1 = Dropbox::Sign::SubMergeField.new -merge_field_1.name = "Full Name" -merge_field_1.type = "text" - -merge_field_2 = Dropbox::Sign::SubMergeField.new -merge_field_2.name = "Is Registered?" -merge_field_2.type = "checkbox" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::TemplateCreateRequest.new -data.client_id = "37dee8d8440c66d54cfa05d92c160882" -data.files = [File.new("example_signature_request.pdf", "r")] -data.title = "Test Template" -data.subject = "Please sign this document" -data.message = "For your approval" -data.signer_roles = [role_1, role_2] -data.cc_roles = ["Manager"] -data.merge_fields = [merge_field_1, merge_field_2] -data.field_options = field_options -data.test_mode = true - -begin - result = template_api.template_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateCreate.ts b/examples/TemplateCreate.ts deleted file mode 100644 index 2bcd3689e..000000000 --- a/examples/TemplateCreate.ts +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1: DropboxSign.SubTemplateRole = { - name: "Client", - order: 0, -}; - -const role2: DropboxSign.SubTemplateRole = { - name: "Witness", - order: 1, -}; - -const mergeField1: DropboxSign.SubMergeField = { - name: "Full Name", - type: DropboxSign.SubMergeField.TypeEnum.Text, -}; - -const mergeField2: DropboxSign.SubMergeField = { - name: "Is Registered?", - type: DropboxSign.SubMergeField.TypeEnum.Checkbox, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.TemplateCreateRequest = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreateEmbeddedDraft.cs b/examples/TemplateCreateEmbeddedDraft.cs deleted file mode 100644 index 42335ff90..000000000 --- a/examples/TemplateCreateEmbeddedDraft.cs +++ /dev/null @@ -1,79 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var role1 = new SubTemplateRole( - name: "Client", - order: 0 - ); - - var role2 = new SubTemplateRole( - name: "Witness", - order: 1 - ); - - var mergeField1 = new SubMergeField( - name: "Full Name", - type: SubMergeField.TypeEnum.Text - ); - - var mergeField2 = new SubMergeField( - name: "Is Registered?", - type: SubMergeField.TypeEnum.Checkbox - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateCreateEmbeddedDraftRequest( - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: files, - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: new List(){role1, role2}, - ccRoles: new List(){"Manager"}, - mergeFields: new List(){mergeField1, mergeField2}, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = templateApi.TemplateCreateEmbeddedDraft(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateCreateEmbeddedDraft.java b/examples/TemplateCreateEmbeddedDraft.java deleted file mode 100644 index 7ae46b461..000000000 --- a/examples/TemplateCreateEmbeddedDraft.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateEmbeddedDraftRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateEmbeddedDraftResponse result = templateApi.templateCreateEmbeddedDraft(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateCreateEmbeddedDraft.js b/examples/TemplateCreateEmbeddedDraft.js deleted file mode 100644 index 1d8ba8741..000000000 --- a/examples/TemplateCreateEmbeddedDraft.js +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1 = { - name: "Client", - order: 0, -}; - -const role2 = { - name: "Witness", - order: 1, -}; - -const mergeField1 = { - name: "Full Name", - type: "text", -}; - -const mergeField2 = { - name: "Is Registered?", - type: "checkbox", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreateEmbeddedDraft(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreateEmbeddedDraft.php b/examples/TemplateCreateEmbeddedDraft.php deleted file mode 100644 index 4e1421b47..000000000 --- a/examples/TemplateCreateEmbeddedDraft.php +++ /dev/null @@ -1,53 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName("Client") - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName("Witness") - ->setOrder(1); - -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName("Full Name") - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); - -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName("Is Registered?") - ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest(); -$data->setClientId("37dee8d8440c66d54cfa05d92c160882") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTitle("Test Template") - ->setSubject("Please sign this document") - ->setMessage("For your approval") - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(["Manager"]) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $templateApi->templateCreateEmbeddedDraft($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateCreateEmbeddedDraft.py b/examples/TemplateCreateEmbeddedDraft.py deleted file mode 100644 index 9b49f037c..000000000 --- a/examples/TemplateCreateEmbeddedDraft.py +++ /dev/null @@ -1,56 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, - ) - - merge_field_1 = models.SubMergeField( - name="Full Name", - type="text", - ) - - merge_field_2 = models.SubMergeField( - name="Is Registered?", - type="checkbox", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.TemplateCreateEmbeddedDraftRequest( - client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", - message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, - test_mode=True, - ) - - try: - response = template_api.template_create_embedded_draft(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraft.rb b/examples/TemplateCreateEmbeddedDraft.rb deleted file mode 100644 index 6eb0f2750..000000000 --- a/examples/TemplateCreateEmbeddedDraft.rb +++ /dev/null @@ -1,49 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -role_1 = Dropbox::Sign::SubTemplateRole.new -role_1.name = "Client" -role_1.order = 0 - -role_2 = Dropbox::Sign::SubTemplateRole.new -role_2.name = "Witness" -role_2.order = 1 - -merge_field_1 = Dropbox::Sign::SubMergeField.new -merge_field_1.name = "Full Name" -merge_field_1.type = "text" - -merge_field_2 = Dropbox::Sign::SubMergeField.new -merge_field_2.name = "Is Registered?" -merge_field_2.type = "checkbox" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new -data.client_id = "37dee8d8440c66d54cfa05d92c160882" -data.files = [File.new("example_signature_request.pdf", "r")] -data.title = "Test Template" -data.subject = "Please sign this document" -data.message = "For your approval" -data.signer_roles = [role_1, role_2] -data.cc_roles = ["Manager"] -data.merge_fields = [merge_field_1, merge_field_2] -data.field_options = field_options -data.test_mode = true - -begin - result = template_api.template_create_embedded_draft(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateCreateEmbeddedDraft.ts b/examples/TemplateCreateEmbeddedDraft.ts deleted file mode 100644 index 960e8a65d..000000000 --- a/examples/TemplateCreateEmbeddedDraft.ts +++ /dev/null @@ -1,61 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1: DropboxSign.SubTemplateRole = { - name: "Client", - order: 0, -}; - -const role2: DropboxSign.SubTemplateRole = { - name: "Witness", - order: 1, -}; - -const mergeField1: DropboxSign.SubMergeField = { - name: "Full Name", - type: DropboxSign.SubMergeField.TypeEnum.Text, -}; - -const mergeField2: DropboxSign.SubMergeField = { - name: "Is Registered?", - type: DropboxSign.SubMergeField.TypeEnum.Checkbox, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.TemplateCreateEmbeddedDraftRequest = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreateEmbeddedDraft(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateCreateEmbeddedDraftExample.cs b/examples/TemplateCreateEmbeddedDraftExample.cs new file mode 100644 index 000000000..e26574c52 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftExample.java b/examples/TemplateCreateEmbeddedDraftExample.java new file mode 100644 index 000000000..cb8c9ce12 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.java @@ -0,0 +1,85 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftExample.php b/examples/TemplateCreateEmbeddedDraftExample.php new file mode 100644 index 000000000..bf035f3cb --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.php @@ -0,0 +1,66 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftExample.py b/examples/TemplateCreateEmbeddedDraftExample.py new file mode 100644 index 000000000..2e96c0a48 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.py @@ -0,0 +1,71 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftExample.rb b/examples/TemplateCreateEmbeddedDraftExample.rb new file mode 100644 index 000000000..8d40c03a2 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.rb @@ -0,0 +1,62 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraft.sh b/examples/TemplateCreateEmbeddedDraftExample.sh similarity index 100% rename from examples/TemplateCreateEmbeddedDraft.sh rename to examples/TemplateCreateEmbeddedDraftExample.sh diff --git a/examples/TemplateCreateEmbeddedDraftExample.ts b/examples/TemplateCreateEmbeddedDraftExample.ts new file mode 100644 index 000000000..6371fcd18 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs new file mode 100644 index 000000000..2603e2c47 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java new file mode 100644 index 000000000..61c6fc967 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldGroups(formFieldGroups); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php new file mode 100644 index 000000000..120c310df --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py new file mode 100644 index 000000000..84232eacf --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb new file mode 100644 index 000000000..3cf7abbf2 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb @@ -0,0 +1,108 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_field_groups = form_field_groups +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts new file mode 100644 index 000000000..5bdb6384f --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldGroups = formFieldGroups; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs new file mode 100644 index 000000000..6d7a8e39b --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java new file mode 100644 index 000000000..7bb877263 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldRules(formFieldRules); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php new file mode 100644 index 000000000..5456b67fc --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py new file mode 100644 index 000000000..e20394052 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb new file mode 100644 index 000000000..38263c1cb --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb @@ -0,0 +1,124 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_field_rules = form_field_rules +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts new file mode 100644 index 000000000..ce20fc91d --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldRules = formFieldRules; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..cb3fd770d --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..38e8fccbc --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..6dc4c93c7 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..b99b91ac7 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..525ee3773 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..0ce2cbcd4 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateExample.cs b/examples/TemplateCreateExample.cs new file mode 100644 index 000000000..09fad4bd6 --- /dev/null +++ b/examples/TemplateCreateExample.cs @@ -0,0 +1,129 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateExample.java b/examples/TemplateCreateExample.java new file mode 100644 index 000000000..b8b8e5150 --- /dev/null +++ b/examples/TemplateCreateExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateExample.php b/examples/TemplateCreateExample.php new file mode 100644 index 000000000..93b6dedd0 --- /dev/null +++ b/examples/TemplateCreateExample.php @@ -0,0 +1,100 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateExample.py b/examples/TemplateCreateExample.py new file mode 100644 index 000000000..a6ed3611e --- /dev/null +++ b/examples/TemplateCreateExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateExample.rb b/examples/TemplateCreateExample.rb new file mode 100644 index 000000000..f4d623397 --- /dev/null +++ b/examples/TemplateCreateExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreate.sh b/examples/TemplateCreateExample.sh similarity index 100% rename from examples/TemplateCreate.sh rename to examples/TemplateCreateExample.sh diff --git a/examples/TemplateCreateExample.ts b/examples/TemplateCreateExample.ts new file mode 100644 index 000000000..c17b780a9 --- /dev/null +++ b/examples/TemplateCreateExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateFormFieldGroupsExample.cs b/examples/TemplateCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b8c56e791 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldGroups: formFieldGroups, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateFormFieldGroupsExample.java b/examples/TemplateCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..08612bd26 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldGroups(formFieldGroups); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateFormFieldGroupsExample.php b/examples/TemplateCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..1c0e02063 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldGroups($form_field_groups) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateFormFieldGroupsExample.py b/examples/TemplateCreateFormFieldGroupsExample.py new file mode 100644 index 000000000..6a755d022 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_groups=form_field_groups, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldGroupsExample.rb b/examples/TemplateCreateFormFieldGroupsExample.rb new file mode 100644 index 000000000..83fdc09bb --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.rb @@ -0,0 +1,108 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_groups = form_field_groups +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldGroupsExample.ts b/examples/TemplateCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..e12c74953 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldGroups = formFieldGroups; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateFormFieldRulesExample.cs b/examples/TemplateCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..6e2224ff4 --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldRules: formFieldRules, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateFormFieldRulesExample.java b/examples/TemplateCreateFormFieldRulesExample.java new file mode 100644 index 000000000..a3c621aee --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldRules(formFieldRules); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateFormFieldRulesExample.php b/examples/TemplateCreateFormFieldRulesExample.php new file mode 100644 index 000000000..74009f900 --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldRules($form_field_rules) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateFormFieldRulesExample.py b/examples/TemplateCreateFormFieldRulesExample.py new file mode 100644 index 000000000..a7f2d94ff --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_rules=form_field_rules, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldRulesExample.rb b/examples/TemplateCreateFormFieldRulesExample.rb new file mode 100644 index 000000000..cea893e1d --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.rb @@ -0,0 +1,124 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_rules = form_field_rules +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldRulesExample.ts b/examples/TemplateCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..31a949aea --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldRules = formFieldRules; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.cs b/examples/TemplateCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..503e80645 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.java b/examples/TemplateCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..397046a78 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.php b/examples/TemplateCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..a4f60e965 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.py b/examples/TemplateCreateFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..6e2185aa9 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.rb b/examples/TemplateCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..39185b3d0 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/examples/TemplateCreateFormFieldsPerDocumentExample.ts b/examples/TemplateCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..d580e665b --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/examples/TemplateDelete.cs b/examples/TemplateDelete.cs deleted file mode 100644 index 2740496cf..000000000 --- a/examples/TemplateDelete.cs +++ /dev/null @@ -1,33 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - templateApi.TemplateDelete(templateId); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateDelete.java b/examples/TemplateDelete.java deleted file mode 100644 index 0714a45d4..000000000 --- a/examples/TemplateDelete.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - templateApi.templateDelete(templateId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateDelete.js b/examples/TemplateDelete.js deleted file mode 100644 index a82580ff4..000000000 --- a/examples/TemplateDelete.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateDelete(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateDelete.php b/examples/TemplateDelete.php deleted file mode 100644 index 3858b7559..000000000 --- a/examples/TemplateDelete.php +++ /dev/null @@ -1,23 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $templateApi->templateDelete($templateId); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateDelete.py b/examples/TemplateDelete.py deleted file mode 100644 index c87622efa..000000000 --- a/examples/TemplateDelete.py +++ /dev/null @@ -1,18 +0,0 @@ -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - template_api.template_delete(template_id) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateDelete.rb b/examples/TemplateDelete.rb deleted file mode 100644 index cff67b421..000000000 --- a/examples/TemplateDelete.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_delete(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateDelete.ts b/examples/TemplateDelete.ts deleted file mode 100644 index a82580ff4..000000000 --- a/examples/TemplateDelete.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateDelete(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateDeleteExample.cs b/examples/TemplateDeleteExample.cs new file mode 100644 index 000000000..5a49ea03f --- /dev/null +++ b/examples/TemplateDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new TemplateApi(config).TemplateDelete( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateDeleteExample.java b/examples/TemplateDeleteExample.java new file mode 100644 index 000000000..b9d0b77ad --- /dev/null +++ b/examples/TemplateDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateDeleteExample.php b/examples/TemplateDeleteExample.php new file mode 100644 index 000000000..63c7a6a72 --- /dev/null +++ b/examples/TemplateDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateDelete( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateDelete: {$e->getMessage()}"; +} diff --git a/examples/TemplateDeleteExample.py b/examples/TemplateDeleteExample.py new file mode 100644 index 000000000..3bf63f5ad --- /dev/null +++ b/examples/TemplateDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.TemplateApi(api_client).template_delete( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + except ApiException as e: + print("Exception when calling TemplateApi#template_delete: %s\n" % e) diff --git a/examples/TemplateDeleteExample.rb b/examples/TemplateDeleteExample.rb new file mode 100644 index 000000000..33e07f299 --- /dev/null +++ b/examples/TemplateDeleteExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::TemplateApi.new.template_delete( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_delete: #{e}" +end diff --git a/examples/TemplateDelete.sh b/examples/TemplateDeleteExample.sh similarity index 100% rename from examples/TemplateDelete.sh rename to examples/TemplateDeleteExample.sh diff --git a/examples/TemplateDeleteExample.ts b/examples/TemplateDeleteExample.ts new file mode 100644 index 000000000..3f0aae438 --- /dev/null +++ b/examples/TemplateDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateDelete( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).catch(error => { + console.log("Exception when calling TemplateApi#templateDelete:"); + console.log(error.body); +}); diff --git a/examples/TemplateFiles.cs b/examples/TemplateFiles.cs deleted file mode 100644 index db4d641c7..000000000 --- a/examples/TemplateFiles.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateFiles(templateId, "pdf"); - - var fileStream = File.Create("file_response.pdf"); - result.Seek(0, SeekOrigin.Begin); - result.CopyTo(fileStream); - fileStream.Close(); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateFiles.java b/examples/TemplateFiles.java deleted file mode 100644 index 2c24e4827..000000000 --- a/examples/TemplateFiles.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - File result = templateApi.templateFiles(templateId, "pdf"); - result.renameTo(new File("file_response.pdf")); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateFiles.js b/examples/TemplateFiles.js deleted file mode 100644 index 00217b49b..000000000 --- a/examples/TemplateFiles.js +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; -const fileType = "pdf"; - -const result = templateApi.templateFiles(templateId, fileType); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFiles.php b/examples/TemplateFiles.php deleted file mode 100644 index e3e7341ee..000000000 --- a/examples/TemplateFiles.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; -$fileType = "pdf"; - -try { - $result = $templateApi->templateFiles($templateId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateFiles.py b/examples/TemplateFiles.py deleted file mode 100644 index 59874bc61..000000000 --- a/examples/TemplateFiles.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files(template_id, file_type="pdf") - open("file_response.pdf", "wb").write(response.read()) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFiles.rb b/examples/TemplateFiles.rb deleted file mode 100644 index 0ad5d6070..000000000 --- a/examples/TemplateFiles.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - file_bin = template_api.template_files(template_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateFiles.ts b/examples/TemplateFiles.ts deleted file mode 100644 index 00217b49b..000000000 --- a/examples/TemplateFiles.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; -const fileType = "pdf"; - -const result = templateApi.templateFiles(templateId, fileType); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsDataUri.cs b/examples/TemplateFilesAsDataUri.cs deleted file mode 100644 index 0d999f5ac..000000000 --- a/examples/TemplateFilesAsDataUri.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateFilesAsDataUri(templateId, "pdf", false, false); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateFilesAsDataUri.java b/examples/TemplateFilesAsDataUri.java deleted file mode 100644 index 868f2803a..000000000 --- a/examples/TemplateFilesAsDataUri.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponseDataUri result = templateApi.templateFilesAsDataUri(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateFilesAsDataUri.js b/examples/TemplateFilesAsDataUri.js deleted file mode 100644 index 8e0f53654..000000000 --- a/examples/TemplateFilesAsDataUri.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsDataUri(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsDataUri.php b/examples/TemplateFilesAsDataUri.php deleted file mode 100644 index f52cc28ea..000000000 --- a/examples/TemplateFilesAsDataUri.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateFilesAsDataUri($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateFilesAsDataUri.py b/examples/TemplateFilesAsDataUri.py deleted file mode 100644 index 9dbc44e4a..000000000 --- a/examples/TemplateFilesAsDataUri.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files_as_data_uri(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsDataUri.rb b/examples/TemplateFilesAsDataUri.rb deleted file mode 100644 index a6689553b..000000000 --- a/examples/TemplateFilesAsDataUri.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_files_as_data_uri(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateFilesAsDataUri.ts b/examples/TemplateFilesAsDataUri.ts deleted file mode 100644 index 8e0f53654..000000000 --- a/examples/TemplateFilesAsDataUri.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsDataUri(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsDataUriExample.cs b/examples/TemplateFilesAsDataUriExample.cs new file mode 100644 index 000000000..5c946b84a --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsDataUri( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateFilesAsDataUriExample.java b/examples/TemplateFilesAsDataUriExample.java new file mode 100644 index 000000000..6ef950fe3 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateFilesAsDataUriExample.php b/examples/TemplateFilesAsDataUriExample.php new file mode 100644 index 000000000..df19ef818 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsDataUri( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/examples/TemplateFilesAsDataUriExample.py b/examples/TemplateFilesAsDataUriExample.py new file mode 100644 index 000000000..ce91dc6ec --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_data_uri( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_data_uri: %s\n" % e) diff --git a/examples/TemplateFilesAsDataUriExample.rb b/examples/TemplateFilesAsDataUriExample.rb new file mode 100644 index 000000000..c51e03680 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files_as_data_uri( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_data_uri: #{e}" +end diff --git a/examples/TemplateFilesAsDataUri.sh b/examples/TemplateFilesAsDataUriExample.sh similarity index 100% rename from examples/TemplateFilesAsDataUri.sh rename to examples/TemplateFilesAsDataUriExample.sh diff --git a/examples/TemplateFilesAsDataUriExample.ts b/examples/TemplateFilesAsDataUriExample.ts new file mode 100644 index 000000000..40a8e2ac0 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/examples/TemplateFilesAsFileUrl.cs b/examples/TemplateFilesAsFileUrl.cs deleted file mode 100644 index 4bdc39d81..000000000 --- a/examples/TemplateFilesAsFileUrl.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateFilesAsFileUrl(templateId, "pdf", false, false); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateFilesAsFileUrl.java b/examples/TemplateFilesAsFileUrl.java deleted file mode 100644 index a3989a61f..000000000 --- a/examples/TemplateFilesAsFileUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponse result = templateApi.templateFilesAsFileUrl(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateFilesAsFileUrl.js b/examples/TemplateFilesAsFileUrl.js deleted file mode 100644 index 305392726..000000000 --- a/examples/TemplateFilesAsFileUrl.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsFileUrl(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsFileUrl.php b/examples/TemplateFilesAsFileUrl.php deleted file mode 100644 index 36a061b98..000000000 --- a/examples/TemplateFilesAsFileUrl.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateFilesAsFileUrl($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateFilesAsFileUrl.py b/examples/TemplateFilesAsFileUrl.py deleted file mode 100644 index c1a8da3a7..000000000 --- a/examples/TemplateFilesAsFileUrl.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_files_as_file_url(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateFilesAsFileUrl.rb b/examples/TemplateFilesAsFileUrl.rb deleted file mode 100644 index b5502db1c..000000000 --- a/examples/TemplateFilesAsFileUrl.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_files_as_file_url(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateFilesAsFileUrl.ts b/examples/TemplateFilesAsFileUrl.ts deleted file mode 100644 index 305392726..000000000 --- a/examples/TemplateFilesAsFileUrl.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsFileUrl(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateFilesAsFileUrlExample.cs b/examples/TemplateFilesAsFileUrlExample.cs new file mode 100644 index 000000000..3b5bc98f1 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsFileUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateFilesAsFileUrlExample.java b/examples/TemplateFilesAsFileUrlExample.java new file mode 100644 index 000000000..3ac688da1 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateFilesAsFileUrlExample.php b/examples/TemplateFilesAsFileUrlExample.php new file mode 100644 index 000000000..d4fb8f53c --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsFileUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/examples/TemplateFilesAsFileUrlExample.py b/examples/TemplateFilesAsFileUrlExample.py new file mode 100644 index 000000000..052891df2 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_file_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_file_url: %s\n" % e) diff --git a/examples/TemplateFilesAsFileUrlExample.rb b/examples/TemplateFilesAsFileUrlExample.rb new file mode 100644 index 000000000..055fd32f6 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files_as_file_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_file_url: #{e}" +end diff --git a/examples/TemplateFilesAsFileUrl.sh b/examples/TemplateFilesAsFileUrlExample.sh similarity index 100% rename from examples/TemplateFilesAsFileUrl.sh rename to examples/TemplateFilesAsFileUrlExample.sh diff --git a/examples/TemplateFilesAsFileUrlExample.ts b/examples/TemplateFilesAsFileUrlExample.ts new file mode 100644 index 000000000..e80f1ad91 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/examples/TemplateFilesExample.cs b/examples/TemplateFilesExample.cs new file mode 100644 index 000000000..96e9237ee --- /dev/null +++ b/examples/TemplateFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + fileType: null + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateFilesExample.java b/examples/TemplateFilesExample.java new file mode 100644 index 000000000..90c2975b2 --- /dev/null +++ b/examples/TemplateFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateFilesExample.php b/examples/TemplateFilesExample.php new file mode 100644 index 000000000..c9d7d5307 --- /dev/null +++ b/examples/TemplateFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + file_type: null, + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}"; +} diff --git a/examples/TemplateFilesExample.py b/examples/TemplateFilesExample.py new file mode 100644 index 000000000..712642766 --- /dev/null +++ b/examples/TemplateFilesExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + file_type=None, + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling TemplateApi#template_files: %s\n" % e) diff --git a/examples/TemplateFilesExample.rb b/examples/TemplateFilesExample.rb new file mode 100644 index 000000000..6aef00074 --- /dev/null +++ b/examples/TemplateFilesExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files: #{e}" +end diff --git a/examples/TemplateFiles.sh b/examples/TemplateFilesExample.sh similarity index 100% rename from examples/TemplateFiles.sh rename to examples/TemplateFilesExample.sh diff --git a/examples/TemplateFilesExample.ts b/examples/TemplateFilesExample.ts new file mode 100644 index 000000000..923f16d56 --- /dev/null +++ b/examples/TemplateFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + undefined, // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFiles:"); + console.log(error.body); +}); diff --git a/examples/TemplateGet.cs b/examples/TemplateGet.cs deleted file mode 100644 index 8354820fd..000000000 --- a/examples/TemplateGet.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateGet(templateId); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateGet.java b/examples/TemplateGet.java deleted file mode 100644 index 5c4721fd7..000000000 --- a/examples/TemplateGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateGet(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateGet.js b/examples/TemplateGet.js deleted file mode 100644 index 365fe69b9..000000000 --- a/examples/TemplateGet.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateGet(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateGet.php b/examples/TemplateGet.php deleted file mode 100644 index b6e469748..000000000 --- a/examples/TemplateGet.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateGet($templateId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateGet.py b/examples/TemplateGet.py deleted file mode 100644 index 1c41b3649..000000000 --- a/examples/TemplateGet.py +++ /dev/null @@ -1,21 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_get(template_id) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateGet.rb b/examples/TemplateGet.rb deleted file mode 100644 index f308d2b7b..000000000 --- a/examples/TemplateGet.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "f57db65d3f933b5316d398057a36176831451a35" - -begin - result = template_api.template_get(template_id) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateGet.ts b/examples/TemplateGet.ts deleted file mode 100644 index 365fe69b9..000000000 --- a/examples/TemplateGet.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateGet(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateGetExample.cs b/examples/TemplateGetExample.cs new file mode 100644 index 000000000..067300032 --- /dev/null +++ b/examples/TemplateGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateGet( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateGetExample.java b/examples/TemplateGetExample.java new file mode 100644 index 000000000..affbf4d04 --- /dev/null +++ b/examples/TemplateGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateGetExample.php b/examples/TemplateGetExample.php new file mode 100644 index 000000000..3625ff5a4 --- /dev/null +++ b/examples/TemplateGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateGet( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateGet: {$e->getMessage()}"; +} diff --git a/examples/TemplateGetExample.py b/examples/TemplateGetExample.py new file mode 100644 index 000000000..2226f74d0 --- /dev/null +++ b/examples/TemplateGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_get( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_get: %s\n" % e) diff --git a/examples/TemplateGetExample.rb b/examples/TemplateGetExample.rb new file mode 100644 index 000000000..aacf15e90 --- /dev/null +++ b/examples/TemplateGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_get( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_get: #{e}" +end diff --git a/examples/TemplateGet.sh b/examples/TemplateGetExample.sh similarity index 100% rename from examples/TemplateGet.sh rename to examples/TemplateGetExample.sh diff --git a/examples/TemplateGetExample.ts b/examples/TemplateGetExample.ts new file mode 100644 index 000000000..b4fcdda6c --- /dev/null +++ b/examples/TemplateGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateGet( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateGet:"); + console.log(error.body); +}); diff --git a/examples/TemplateList.cs b/examples/TemplateList.cs deleted file mode 100644 index b6cb40dc2..000000000 --- a/examples/TemplateList.cs +++ /dev/null @@ -1,34 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - - try - { - var result = templateApi.TemplateList(accountId, 1, 20, null); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateList.java b/examples/TemplateList.java deleted file mode 100644 index 136dcf3be..000000000 --- a/examples/TemplateList.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - TemplateListResponse result = templateApi.templateList(accountId, page, pageSize, query); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateList.js b/examples/TemplateList.js deleted file mode 100644 index be9197a82..000000000 --- a/examples/TemplateList.js +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateList(accountId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateList.php b/examples/TemplateList.php deleted file mode 100644 index 1a2ea5b13..000000000 --- a/examples/TemplateList.php +++ /dev/null @@ -1,24 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -try { - $result = $templateApi->templateList($accountId); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateList.py b/examples/TemplateList.py deleted file mode 100644 index 4ce779ffe..000000000 --- a/examples/TemplateList.py +++ /dev/null @@ -1,23 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - account_id = "f57db65d3f933b5316d398057a36176831451a35" - - try: - response = template_api.template_list( - account_id=account_id, - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateList.rb b/examples/TemplateList.rb deleted file mode 100644 index e0006c738..000000000 --- a/examples/TemplateList.rb +++ /dev/null @@ -1,20 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -account_id = "f57db65d3f933b5316d398057a36176831451a35" - -begin - result = template_api.template_list({ account_id: account_id }) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateList.ts b/examples/TemplateList.ts deleted file mode 100644 index be9197a82..000000000 --- a/examples/TemplateList.ts +++ /dev/null @@ -1,19 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateList(accountId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateListExample.cs b/examples/TemplateListExample.cs new file mode 100644 index 000000000..b41f357ce --- /dev/null +++ b/examples/TemplateListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateListExample.java b/examples/TemplateListExample.java new file mode 100644 index 000000000..45250a456 --- /dev/null +++ b/examples/TemplateListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateListExample.php b/examples/TemplateListExample.php new file mode 100644 index 000000000..536c2a630 --- /dev/null +++ b/examples/TemplateListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}"; +} diff --git a/examples/TemplateListExample.py b/examples/TemplateListExample.py new file mode 100644 index 000000000..6b96ea19c --- /dev/null +++ b/examples/TemplateListExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_list( + account_id=None, + page=1, + page_size=20, + query=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_list: %s\n" % e) diff --git a/examples/TemplateListExample.rb b/examples/TemplateListExample.rb new file mode 100644 index 000000000..a69c46f66 --- /dev/null +++ b/examples/TemplateListExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_list: #{e}" +end diff --git a/examples/TemplateList.sh b/examples/TemplateListExample.sh similarity index 100% rename from examples/TemplateList.sh rename to examples/TemplateListExample.sh diff --git a/examples/TemplateListExample.ts b/examples/TemplateListExample.ts new file mode 100644 index 000000000..e678a6c26 --- /dev/null +++ b/examples/TemplateListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateList:"); + console.log(error.body); +}); diff --git a/examples/TemplateRemoveUser.cs b/examples/TemplateRemoveUser.cs deleted file mode 100644 index da93c4c7d..000000000 --- a/examples/TemplateRemoveUser.cs +++ /dev/null @@ -1,38 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var data = new TemplateRemoveUserRequest( - emailAddress: "george@dropboxsign.com" - ); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try - { - var result = templateApi.TemplateRemoveUser(templateId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateRemoveUser.java b/examples/TemplateRemoveUser.java deleted file mode 100644 index 9dd210c08..000000000 --- a/examples/TemplateRemoveUser.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateRemoveUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateGetResponse result = templateApi.templateRemoveUser(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateRemoveUser.js b/examples/TemplateRemoveUser.js deleted file mode 100644 index 9683986c1..000000000 --- a/examples/TemplateRemoveUser.js +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -const result = templateApi.templateRemoveUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateRemoveUser.php b/examples/TemplateRemoveUser.php deleted file mode 100644 index 8e7aa9a97..000000000 --- a/examples/TemplateRemoveUser.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateRemoveUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -try { - $result = $templateApi->templateRemoveUser($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateRemoveUser.py b/examples/TemplateRemoveUser.py deleted file mode 100644 index c16c4b001..000000000 --- a/examples/TemplateRemoveUser.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateRemoveUserRequest( - email_address="george@dropboxsign.com", - ) - - template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - - try: - response = template_api.template_remove_user(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateRemoveUser.rb b/examples/TemplateRemoveUser.rb deleted file mode 100644 index b9035297a..000000000 --- a/examples/TemplateRemoveUser.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateRemoveUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - -begin - result = template_api.template_remove_user(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateRemoveUser.ts b/examples/TemplateRemoveUser.ts deleted file mode 100644 index 7bd823902..000000000 --- a/examples/TemplateRemoveUser.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateRemoveUserRequest = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -const result = templateApi.templateRemoveUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateRemoveUserExample.cs b/examples/TemplateRemoveUserExample.cs new file mode 100644 index 000000000..66bcbfe53 --- /dev/null +++ b/examples/TemplateRemoveUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateRemoveUserRequest = new TemplateRemoveUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateRemoveUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateRemoveUserRequest: templateRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateRemoveUserExample.java b/examples/TemplateRemoveUserExample.java new file mode 100644 index 000000000..d3d157b24 --- /dev/null +++ b/examples/TemplateRemoveUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateRemoveUserExample.php b/examples/TemplateRemoveUserExample.php new file mode 100644 index 000000000..ecd5770f4 --- /dev/null +++ b/examples/TemplateRemoveUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_remove_user_request = (new Dropbox\Sign\Model\TemplateRemoveUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateRemoveUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request: $template_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateRemoveUser: {$e->getMessage()}"; +} diff --git a/examples/TemplateRemoveUserExample.py b/examples/TemplateRemoveUserExample.py new file mode 100644 index 000000000..c44814c40 --- /dev/null +++ b/examples/TemplateRemoveUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_remove_user_request = models.TemplateRemoveUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_remove_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request=template_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_remove_user: %s\n" % e) diff --git a/examples/TemplateRemoveUserExample.rb b/examples/TemplateRemoveUserExample.rb new file mode 100644 index 000000000..00687e102 --- /dev/null +++ b/examples/TemplateRemoveUserExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_remove_user_request = Dropbox::Sign::TemplateRemoveUserRequest.new +template_remove_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_remove_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_remove_user: #{e}" +end diff --git a/examples/TemplateRemoveUser.sh b/examples/TemplateRemoveUserExample.sh similarity index 100% rename from examples/TemplateRemoveUser.sh rename to examples/TemplateRemoveUserExample.sh diff --git a/examples/TemplateRemoveUserExample.ts b/examples/TemplateRemoveUserExample.ts new file mode 100644 index 000000000..f896f81e1 --- /dev/null +++ b/examples/TemplateRemoveUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateRemoveUserRequest = new models.TemplateRemoveUserRequest(); +templateRemoveUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateRemoveUser:"); + console.log(error.body); +}); diff --git a/examples/TemplateUpdateFiles.cs b/examples/TemplateUpdateFiles.cs deleted file mode 100644 index 1ac81efd8..000000000 --- a/examples/TemplateUpdateFiles.cs +++ /dev/null @@ -1,48 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateUpdateFilesRequest( - files: files - ); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try - { - var result = templateApi.TemplateUpdateFiles(templateId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/TemplateUpdateFiles.java b/examples/TemplateUpdateFiles.java deleted file mode 100644 index 873544c84..000000000 --- a/examples/TemplateUpdateFiles.java +++ /dev/null @@ -1,38 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateUpdateFilesRequest() - .addFilesItem(new File("example_signature_request.pdf")); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateUpdateFilesResponse result = templateApi.templateUpdateFiles(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/TemplateUpdateFiles.js b/examples/TemplateUpdateFiles.js deleted file mode 100644 index 81eb26ecc..000000000 --- a/examples/TemplateUpdateFiles.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - files: [fs.createReadStream("example_signature_request.pdf")], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateUpdateFiles(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateUpdateFiles.php b/examples/TemplateUpdateFiles.php deleted file mode 100644 index c9e3fbe62..000000000 --- a/examples/TemplateUpdateFiles.php +++ /dev/null @@ -1,27 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateUpdateFilesRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -try { - $result = $templateApi->templateUpdateFiles($templateId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/TemplateUpdateFiles.py b/examples/TemplateUpdateFiles.py deleted file mode 100644 index 341af5020..000000000 --- a/examples/TemplateUpdateFiles.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateUpdateFilesRequest( - files=[open("example_signature_request.pdf", "rb")], - ) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - - try: - response = template_api.template_update_files(template_id, data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/TemplateUpdateFiles.rb b/examples/TemplateUpdateFiles.rb deleted file mode 100644 index f4c31e0c7..000000000 --- a/examples/TemplateUpdateFiles.rb +++ /dev/null @@ -1,23 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateUpdateFilesRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - -begin - result = template_api.template_update_files(template_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/TemplateUpdateFiles.ts b/examples/TemplateUpdateFiles.ts deleted file mode 100644 index ce6bee73e..000000000 --- a/examples/TemplateUpdateFiles.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import fs from "fs"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateUpdateFilesRequest = { - files: [fs.createReadStream("example_signature_request.pdf")], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateUpdateFiles(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/TemplateUpdateFilesExample.cs b/examples/TemplateUpdateFilesExample.cs new file mode 100644 index 000000000..1fe2ccf5e --- /dev/null +++ b/examples/TemplateUpdateFilesExample.cs @@ -0,0 +1,46 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateUpdateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest( + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new TemplateApi(config).TemplateUpdateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateUpdateFilesRequest: templateUpdateFilesRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateUpdateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/TemplateUpdateFilesExample.java b/examples/TemplateUpdateFilesExample.java new file mode 100644 index 000000000..865668461 --- /dev/null +++ b/examples/TemplateUpdateFilesExample.java @@ -0,0 +1,46 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateUpdateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateUpdateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/TemplateUpdateFilesExample.php b/examples/TemplateUpdateFilesExample.php new file mode 100644 index 000000000..26470da0f --- /dev/null +++ b/examples/TemplateUpdateFilesExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_update_files_request = (new Dropbox\Sign\Model\TemplateUpdateFilesRequest()) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request: $template_update_files_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateUpdateFiles: {$e->getMessage()}"; +} diff --git a/examples/TemplateUpdateFilesExample.py b/examples/TemplateUpdateFilesExample.py new file mode 100644 index 000000000..71ab006be --- /dev/null +++ b/examples/TemplateUpdateFilesExample.py @@ -0,0 +1,27 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_update_files_request = models.TemplateUpdateFilesRequest( + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.TemplateApi(api_client).template_update_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request=template_update_files_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_update_files: %s\n" % e) diff --git a/examples/TemplateUpdateFilesExample.rb b/examples/TemplateUpdateFilesExample.rb new file mode 100644 index 000000000..d5088f2a7 --- /dev/null +++ b/examples/TemplateUpdateFilesExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_update_files_request = Dropbox::Sign::TemplateUpdateFilesRequest.new +template_update_files_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::TemplateApi.new.template_update_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_update_files_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_update_files: #{e}" +end diff --git a/examples/TemplateUpdateFiles.sh b/examples/TemplateUpdateFilesExample.sh similarity index 100% rename from examples/TemplateUpdateFiles.sh rename to examples/TemplateUpdateFilesExample.sh diff --git a/examples/TemplateUpdateFilesExample.ts b/examples/TemplateUpdateFilesExample.ts new file mode 100644 index 000000000..139a53fff --- /dev/null +++ b/examples/TemplateUpdateFilesExample.ts @@ -0,0 +1,22 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateUpdateFilesRequest = new models.TemplateUpdateFilesRequest(); +templateUpdateFilesRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateUpdateFiles:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreate.cs b/examples/UnclaimedDraftCreate.cs deleted file mode 100644 index b645322e5..000000000 --- a/examples/UnclaimedDraftCreate.cs +++ /dev/null @@ -1,85 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var signer1 = new SubUnclaimedDraftSigner( - emailAddress: "jack@example.com", - name: "Jack", - order: 0 - ); - - var signer2 = new SubUnclaimedDraftSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY - ); - - var metadata = new Dictionary() - { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new UnclaimedDraftCreateRequest( - subject: "The NDA we talked about", - type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: subSigningOptions, - fieldOptions: subFieldOptions, - testMode: true - ); - - try - { - var result = unclaimedDraftApi.UnclaimedDraftCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/UnclaimedDraftCreate.java b/examples/UnclaimedDraftCreate.java deleted file mode 100644 index 5ba805715..000000000 --- a/examples/UnclaimedDraftCreate.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer1 = new SubUnclaimedDraftSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubUnclaimedDraftSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); - - var data = new UnclaimedDraftCreateRequest() - .subject("The NDA we talked about") - .type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE) - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(subSigningOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftCreate.js b/examples/UnclaimedDraftCreate.js deleted file mode 100644 index 70d1c2a05..000000000 --- a/examples/UnclaimedDraftCreate.js +++ /dev/null @@ -1,64 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - subject: "The NDA we talked about", - type: "request_signature", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ - signer1, - signer2, - ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreate.php b/examples/UnclaimedDraftCreate.php deleted file mode 100644 index e9d7bee89..000000000 --- a/examples/UnclaimedDraftCreate.php +++ /dev/null @@ -1,60 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer1->setEmailAddress("jack@example.com") - ->setName("Jack") - ->setOrder(0); - -$signer2 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateRequest(); -$data->setSubject("The NDA we talked about") - ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", - ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftCreate.py b/examples/UnclaimedDraftCreate.py deleted file mode 100644 index 3ae301624..000000000 --- a/examples/UnclaimedDraftCreate.py +++ /dev/null @@ -1,62 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubUnclaimedDraftSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) - - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.UnclaimedDraftCreateRequest( - subject="The NDA we talked about", - type="request_signature", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=[ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, - field_options=field_options, - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreate.rb b/examples/UnclaimedDraftCreate.rb deleted file mode 100644 index 36d7ff747..000000000 --- a/examples/UnclaimedDraftCreate.rb +++ /dev/null @@ -1,56 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -signer_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubUnclaimedDraftSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::UnclaimedDraftCreateRequest.new -data.subject = "The NDA we talked about" -data.type = "request_signature" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", -] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true - -begin - result = unclaimed_draft_api.unclaimed_draft_create(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreate.ts b/examples/UnclaimedDraftCreate.ts deleted file mode 100644 index 137fc64e2..000000000 --- a/examples/UnclaimedDraftCreate.ts +++ /dev/null @@ -1,64 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubUnclaimedDraftSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubUnclaimedDraftSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.UnclaimedDraftCreateRequest = { - subject: "The NDA we talked about", - type: DropboxSign.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ - signer1, - signer2, - ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbedded.cs b/examples/UnclaimedDraftCreateEmbedded.cs deleted file mode 100644 index 294663094..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.cs +++ /dev/null @@ -1,49 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new UnclaimedDraftCreateEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: files, - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true - ); - - try - { - var result = unclaimedDraftApi.UnclaimedDraftCreateEmbedded(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/UnclaimedDraftCreateEmbedded.java b/examples/UnclaimedDraftCreateEmbedded.java deleted file mode 100644 index 56ad9a5ae..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .addFilesItem(new File("example_signature_request.pdf")) - .requesterEmailAddress("jack@dropboxsign.com") - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftCreateEmbedded.js b/examples/UnclaimedDraftCreateEmbedded.js deleted file mode 100644 index 6f0865c8e..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.js +++ /dev/null @@ -1,25 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: [fs.createReadStream("example_signature_request.pdf")], - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbedded.php b/examples/UnclaimedDraftCreateEmbedded.php deleted file mode 100644 index b163ca833..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbedded($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftCreateEmbedded.py b/examples/UnclaimedDraftCreateEmbedded.py deleted file mode 100644 index a5f260c23..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.py +++ /dev/null @@ -1,26 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - files=[open("example_signature_request.pdf", "rb")], - requester_email_address="jack@dropboxsign.com", - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbedded.rb b/examples/UnclaimedDraftCreateEmbedded.rb deleted file mode 100644 index ab80ad56c..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.files = [File.new("example_signature_request.pdf", "r")] -data.requester_email_address = "jack@dropboxsign.com" -data.test_mode = true - -begin - result = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbedded.ts b/examples/UnclaimedDraftCreateEmbedded.ts deleted file mode 100644 index 5dbdaab51..000000000 --- a/examples/UnclaimedDraftCreateEmbedded.ts +++ /dev/null @@ -1,25 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.UnclaimedDraftCreateEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: [fs.createReadStream("example_signature_request.pdf")], - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.cs b/examples/UnclaimedDraftCreateEmbeddedExample.cs new file mode 100644 index 000000000..4637922b5 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.cs @@ -0,0 +1,48 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.java b/examples/UnclaimedDraftCreateEmbeddedExample.java new file mode 100644 index 000000000..0dfd50d88 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.java @@ -0,0 +1,48 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.php b/examples/UnclaimedDraftCreateEmbeddedExample.php new file mode 100644 index 000000000..4ad74cf2c --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(true) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.py b/examples/UnclaimedDraftCreateEmbeddedExample.py new file mode 100644 index 000000000..dade05ec4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.py @@ -0,0 +1,29 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.rb b/examples/UnclaimedDraftCreateEmbeddedExample.rb new file mode 100644 index 000000000..a22330de8 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.rb @@ -0,0 +1,25 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = true +unclaimed_draft_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbedded.sh b/examples/UnclaimedDraftCreateEmbeddedExample.sh similarity index 100% rename from examples/UnclaimedDraftCreateEmbedded.sh rename to examples/UnclaimedDraftCreateEmbeddedExample.sh diff --git a/examples/UnclaimedDraftCreateEmbeddedExample.ts b/examples/UnclaimedDraftCreateEmbeddedExample.ts new file mode 100644 index 000000000..d17be1564 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.ts @@ -0,0 +1,24 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = true; +unclaimedDraftCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs new file mode 100644 index 000000000..58e77d162 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs @@ -0,0 +1,95 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java new file mode 100644 index 000000000..f597e3e18 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java @@ -0,0 +1,94 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php new file mode 100644 index 000000000..c56719913 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php @@ -0,0 +1,76 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py new file mode 100644 index 000000000..b825eeac8 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py @@ -0,0 +1,78 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb new file mode 100644 index 000000000..46129e4d7 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb @@ -0,0 +1,71 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_groups = form_field_groups +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts new file mode 100644 index 000000000..bb10352f4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts @@ -0,0 +1,70 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs new file mode 100644 index 000000000..367136511 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs @@ -0,0 +1,115 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java new file mode 100644 index 000000000..d2483f32f --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java @@ -0,0 +1,110 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php new file mode 100644 index 000000000..2280c7252 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php @@ -0,0 +1,92 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py new file mode 100644 index 000000000..931cc0bdd --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py @@ -0,0 +1,96 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb new file mode 100644 index 000000000..a6b174891 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb @@ -0,0 +1,87 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_rules = form_field_rules +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts new file mode 100644 index 000000000..8223f693e --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts @@ -0,0 +1,86 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..f9b29f003 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs @@ -0,0 +1,81 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..f425a3d36 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java @@ -0,0 +1,82 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..249c7eacb --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php @@ -0,0 +1,64 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..6828613cd --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py @@ -0,0 +1,65 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..774085a28 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb @@ -0,0 +1,59 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..66efc0596 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts @@ -0,0 +1,58 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs deleted file mode 100644 index 775c42111..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs +++ /dev/null @@ -1,52 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var signer = new SubUnclaimedDraftTemplateSigner( - role: "Client", - name: "George", - emailAddress: "george@example.com" - ); - - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - requesterEmailAddress: "jack@dropboxsign.com", - signers: new List(){signer}, - ccs: new List(){cc1}, - testMode: true - ); - - try - { - var result = unclaimedDraftApi.UnclaimedDraftCreateEmbeddedWithTemplate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java deleted file mode 100644 index 7a5983a75..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,50 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer = new SubUnclaimedDraftTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .requesterEmailAddress("jack@dropboxsign.com") - .signers(List.of(signer)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js deleted file mode 100644 index 097712e7f..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.js +++ /dev/null @@ -1,37 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - name: "George", - emailAddress: "george@example.com", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@dropboxsign.com", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requesterEmailAddress: "jack@dropboxsign.com", - signers: [ signer1 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php deleted file mode 100644 index 7d870ac3c..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.php +++ /dev/null @@ -1,39 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner(); -$signer1->setRole("Client") - ->setName("George") - ->setEmailAddress("george@example.com"); - -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@dropboxsign.com"); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["61a832ff0d8423f91d503e76bfbcc750f7417c78"]) - ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setTestMode(true); - -try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbeddedWithTemplate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py deleted file mode 100644 index c4122b185..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.py +++ /dev/null @@ -1,41 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftTemplateSigner( - role="Client", - name="George", - email_address="george@example.com", - ) - - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requester_email_address="jack@dropboxsign.com", - signers=[signer_1], - ccs=[cc_1], - test_mode=True, - ) - - try: - response = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template( - data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb deleted file mode 100644 index abe1f5ca6..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb +++ /dev/null @@ -1,35 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -signer_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new -signer_1.role = "Client" -signer_1.name = "George" -signer_1.email_address = "george@example.com" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["61a832ff0d8423f91d503e76bfbcc750f7417c78"] -data.requester_email_address = "jack@dropboxsign.com" -data.signers = [signer_1] -data.ccs = [cc_1] -data.test_mode = true - -begin - result = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template(data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts deleted file mode 100644 index cc23f74af..000000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts +++ /dev/null @@ -1,37 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubUnclaimedDraftTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@dropboxsign.com", -}; - -const data: DropboxSign.UnclaimedDraftCreateEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requesterEmailAddress: "jack@dropboxsign.com", - signers: [ signer1 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..2fea6ff83 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@dropboxsign.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signers1 = new SubUnclaimedDraftTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + testMode: false, + ccs: ccs, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest: unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..174c678a4 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..d51e60ee7 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@dropboxsign.com"); + +$ccs = [ + $ccs_1, +]; + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_embedded_with_template_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setTestMode(false) + ->setCcs($ccs) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbeddedWithTemplate( + unclaimed_draft_create_embedded_with_template_request: $unclaimed_draft_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..fbb76e6bf --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,50 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@dropboxsign.com", + ) + + ccs = [ + ccs_1, + ] + + signers_1 = models.SubUnclaimedDraftTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_embedded_with_template_request = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + test_mode=False, + ccs=ccs, + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request=unclaimed_draft_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..c6e799cae --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@dropboxsign.com" + +ccs = [ + ccs_1, +] + +signers_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +unclaimed_draft_create_embedded_with_template_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new +unclaimed_draft_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_with_template_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +unclaimed_draft_create_embedded_with_template_request.test_mode = false +unclaimed_draft_create_embedded_with_template_request.ccs = ccs +unclaimed_draft_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: #{e}" +end diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh similarity index 100% rename from examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh rename to examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh diff --git a/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..8e78741d8 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@dropboxsign.com"; + +const ccs = [ + ccs1, +]; + +const signers1 = new models.SubUnclaimedDraftTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateEmbeddedWithTemplateRequest = new models.UnclaimedDraftCreateEmbeddedWithTemplateRequest(); +unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode = false; +unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs = ccs; +unclaimedDraftCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateExample.cs b/examples/UnclaimedDraftCreateExample.cs new file mode 100644 index 000000000..e5080a671 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.cs @@ -0,0 +1,59 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signers1 = new SubUnclaimedDraftSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateExample.java b/examples/UnclaimedDraftCreateExample.java new file mode 100644 index 000000000..219de1f5a --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.java @@ -0,0 +1,57 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateExample.php b/examples/UnclaimedDraftCreateExample.php new file mode 100644 index 000000000..8aa132af0 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.php @@ -0,0 +1,38 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(true) + ->setFiles([ + ]) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateExample.py b/examples/UnclaimedDraftCreateExample.py new file mode 100644 index 000000000..f7715b7ea --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.py @@ -0,0 +1,39 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signers_1 = models.SubUnclaimedDraftSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateExample.rb b/examples/UnclaimedDraftCreateExample.rb new file mode 100644 index 000000000..12f94dfd2 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.rb @@ -0,0 +1,34 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signers_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers = [ + signers_1, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = true +unclaimed_draft_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +unclaimed_draft_create_request.signers = signers + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreate.sh b/examples/UnclaimedDraftCreateExample.sh similarity index 100% rename from examples/UnclaimedDraftCreate.sh rename to examples/UnclaimedDraftCreateExample.sh diff --git a/examples/UnclaimedDraftCreateExample.ts b/examples/UnclaimedDraftCreateExample.ts new file mode 100644 index 000000000..dc23f50d2 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.ts @@ -0,0 +1,33 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signers1 = new models.SubUnclaimedDraftSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = true; +unclaimedDraftCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +unclaimedDraftCreateRequest.signers = signers; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.cs b/examples/UnclaimedDraftCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b5ae35929 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.cs @@ -0,0 +1,94 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.java b/examples/UnclaimedDraftCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..e30a749bb --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.java @@ -0,0 +1,93 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.php b/examples/UnclaimedDraftCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..92ec35b20 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.php @@ -0,0 +1,75 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.py b/examples/UnclaimedDraftCreateFormFieldGroupsExample.py new file mode 100644 index 000000000..4af69152a --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.py @@ -0,0 +1,77 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb b/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb new file mode 100644 index 000000000..881fde8ab --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.rb @@ -0,0 +1,70 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_groups = form_field_groups +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldGroupsExample.ts b/examples/UnclaimedDraftCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..f3e47da2c --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.ts @@ -0,0 +1,69 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.cs b/examples/UnclaimedDraftCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..dabc20ce6 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.cs @@ -0,0 +1,114 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.java b/examples/UnclaimedDraftCreateFormFieldRulesExample.java new file mode 100644 index 000000000..49de71fbe --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.java @@ -0,0 +1,109 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.php b/examples/UnclaimedDraftCreateFormFieldRulesExample.php new file mode 100644 index 000000000..a58ad4d10 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.php @@ -0,0 +1,91 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.py b/examples/UnclaimedDraftCreateFormFieldRulesExample.py new file mode 100644 index 000000000..a0bba3023 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.rb b/examples/UnclaimedDraftCreateFormFieldRulesExample.rb new file mode 100644 index 000000000..54822f3a7 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.rb @@ -0,0 +1,86 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_rules = form_field_rules +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldRulesExample.ts b/examples/UnclaimedDraftCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..c4abba3b1 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.ts @@ -0,0 +1,85 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..86eae8aea --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,80 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..b048a8ba9 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,81 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..93e3b015a --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,63 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..d15b6c577 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,64 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..e4bc66ec0 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,58 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..b5e61ab5a --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,57 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/examples/UnclaimedDraftEditAndResend.cs b/examples/UnclaimedDraftEditAndResend.cs deleted file mode 100644 index cfbb3709a..000000000 --- a/examples/UnclaimedDraftEditAndResend.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System; -using System.Collections.Generic; -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -public class Example -{ - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var data = new UnclaimedDraftEditAndResendRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - testMode: true - ); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - - try - { - var result = unclaimedDraftApi.UnclaimedDraftEditAndResend(signatureRequestId, data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } -} diff --git a/examples/UnclaimedDraftEditAndResend.java b/examples/UnclaimedDraftEditAndResend.java deleted file mode 100644 index bf33d8f69..000000000 --- a/examples/UnclaimedDraftEditAndResend.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftEditAndResendRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .testMode(true); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/examples/UnclaimedDraftEditAndResend.js b/examples/UnclaimedDraftEditAndResend.js deleted file mode 100644 index 0ff7c3683..000000000 --- a/examples/UnclaimedDraftEditAndResend.js +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - testMode: true, -}; - -const signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -const result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftEditAndResend.php b/examples/UnclaimedDraftEditAndResend.php deleted file mode 100644 index 5f985d8c6..000000000 --- a/examples/UnclaimedDraftEditAndResend.php +++ /dev/null @@ -1,28 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -try { - $result = $unclaimedDraftApi->unclaimedDraftEditAndResend($signatureRequestId, $data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/examples/UnclaimedDraftEditAndResend.py b/examples/UnclaimedDraftEditAndResend.py deleted file mode 100644 index bbcad88ff..000000000 --- a/examples/UnclaimedDraftEditAndResend.py +++ /dev/null @@ -1,28 +0,0 @@ -from pprint import pprint - -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftEditAndResendRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - test_mode=True, - ) - - signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - - try: - response = unclaimed_draft_api.unclaimed_draft_edit_and_resend( - signature_request_id, data - ) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/examples/UnclaimedDraftEditAndResend.rb b/examples/UnclaimedDraftEditAndResend.rb deleted file mode 100644 index 9b4b1c7b6..000000000 --- a/examples/UnclaimedDraftEditAndResend.rb +++ /dev/null @@ -1,24 +0,0 @@ -require "dropbox-sign" - -Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key - config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" -end - -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -data = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.test_mode = true - -signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - -begin - result = unclaimed_draft_api.unclaimed_draft_edit_and_resend(signature_request_id, data) - p result -rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" -end diff --git a/examples/UnclaimedDraftEditAndResend.ts b/examples/UnclaimedDraftEditAndResend.ts deleted file mode 100644 index 320b0b750..000000000 --- a/examples/UnclaimedDraftEditAndResend.ts +++ /dev/null @@ -1,24 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.UnclaimedDraftEditAndResendRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - testMode: true, -}; - -const signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -const result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/examples/UnclaimedDraftEditAndResendExample.cs b/examples/UnclaimedDraftEditAndResendExample.cs new file mode 100644 index 000000000..459364b01 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftEditAndResendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + testMode: false + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftEditAndResend( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimedDraftEditAndResendRequest: unclaimedDraftEditAndResendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftEditAndResend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/examples/UnclaimedDraftEditAndResendExample.java b/examples/UnclaimedDraftEditAndResendExample.java new file mode 100644 index 000000000..4866e6524 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftEditAndResendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/examples/UnclaimedDraftEditAndResendExample.php b/examples/UnclaimedDraftEditAndResendExample.php new file mode 100644 index 000000000..f82ea4946 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_edit_and_resend_request = (new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTestMode(false); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftEditAndResend( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request: $unclaimed_draft_edit_and_resend_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend: {$e->getMessage()}"; +} diff --git a/examples/UnclaimedDraftEditAndResendExample.py b/examples/UnclaimedDraftEditAndResendExample.py new file mode 100644 index 000000000..440aaaa9e --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_edit_and_resend_request = models.UnclaimedDraftEditAndResendRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + test_mode=False, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_edit_and_resend( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request=unclaimed_draft_edit_and_resend_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: %s\n" % e) diff --git a/examples/UnclaimedDraftEditAndResendExample.rb b/examples/UnclaimedDraftEditAndResendExample.rb new file mode 100644 index 000000000..dccc4d027 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +unclaimed_draft_edit_and_resend_request = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new +unclaimed_draft_edit_and_resend_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_edit_and_resend_request.test_mode = false + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_edit_and_resend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + unclaimed_draft_edit_and_resend_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: #{e}" +end diff --git a/examples/UnclaimedDraftEditAndResend.sh b/examples/UnclaimedDraftEditAndResendExample.sh similarity index 100% rename from examples/UnclaimedDraftEditAndResend.sh rename to examples/UnclaimedDraftEditAndResendExample.sh diff --git a/examples/UnclaimedDraftEditAndResendExample.ts b/examples/UnclaimedDraftEditAndResendExample.ts new file mode 100644 index 000000000..16a998390 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftEditAndResendRequest = new models.UnclaimedDraftEditAndResendRequest(); +unclaimedDraftEditAndResendRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftEditAndResendRequest.testMode = false; + +apiCaller.unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend:"); + console.log(error.body); +}); diff --git a/examples/json/AccountCreateOAuthResponseExample.json b/examples/json/AccountCreateOAuthResponse.json similarity index 100% rename from examples/json/AccountCreateOAuthResponseExample.json rename to examples/json/AccountCreateOAuthResponse.json diff --git a/examples/json/AccountCreateRequestDefaultExample.json b/examples/json/AccountCreateRequest.json similarity index 100% rename from examples/json/AccountCreateRequestDefaultExample.json rename to examples/json/AccountCreateRequest.json diff --git a/examples/json/AccountCreateRequestOAuthExample.json b/examples/json/AccountCreateRequestOAuth.json similarity index 100% rename from examples/json/AccountCreateRequestOAuthExample.json rename to examples/json/AccountCreateRequestOAuth.json diff --git a/examples/json/AccountCreateResponseExample.json b/examples/json/AccountCreateResponse.json similarity index 100% rename from examples/json/AccountCreateResponseExample.json rename to examples/json/AccountCreateResponse.json diff --git a/examples/json/AccountGetResponseExample.json b/examples/json/AccountGetResponse.json similarity index 100% rename from examples/json/AccountGetResponseExample.json rename to examples/json/AccountGetResponse.json diff --git a/examples/json/AccountUpdateRequestDefaultExample.json b/examples/json/AccountUpdateRequest.json similarity index 100% rename from examples/json/AccountUpdateRequestDefaultExample.json rename to examples/json/AccountUpdateRequest.json diff --git a/examples/json/AccountUpdateResponseExample.json b/examples/json/AccountUpdateResponse.json similarity index 100% rename from examples/json/AccountUpdateResponseExample.json rename to examples/json/AccountUpdateResponse.json diff --git a/examples/json/AccountVerifyFoundResponseExample.json b/examples/json/AccountVerifyFoundResponse.json similarity index 100% rename from examples/json/AccountVerifyFoundResponseExample.json rename to examples/json/AccountVerifyFoundResponse.json diff --git a/examples/json/AccountVerifyNotFoundResponseExample.json b/examples/json/AccountVerifyNotFoundResponse.json similarity index 100% rename from examples/json/AccountVerifyNotFoundResponseExample.json rename to examples/json/AccountVerifyNotFoundResponse.json diff --git a/examples/json/AccountVerifyRequestDefaultExample.json b/examples/json/AccountVerifyRequest.json similarity index 100% rename from examples/json/AccountVerifyRequestDefaultExample.json rename to examples/json/AccountVerifyRequest.json diff --git a/examples/json/ApiAppCreateRequest.json b/examples/json/ApiAppCreateRequest.json new file mode 100644 index 000000000..e21b53a74 --- /dev/null +++ b/examples/json/ApiAppCreateRequest.json @@ -0,0 +1,18 @@ +{ + "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" + } +} diff --git a/examples/json/ApiAppCreateRequestDefaultExample.json b/examples/json/ApiAppCreateRequestDefaultExample.json deleted file mode 100644 index 2d5cd3c74..000000000 --- a/examples/json/ApiAppCreateRequestDefaultExample.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "name": "My Production App", - "domains": [ - "example.com" - ], - "oauth": { - "callback_url": "https://example.com/oauth", - "scopes": [ - "basic_account_info", - "request_signature" - ] - }, - "white_labeling_options": { - "primary_button_color": "#00b3e6", - "primary_button_text_color": "#ffffff" - } -} diff --git a/examples/json/ApiAppCreateResponseExample.json b/examples/json/ApiAppCreateResponse.json similarity index 100% rename from examples/json/ApiAppCreateResponseExample.json rename to examples/json/ApiAppCreateResponse.json diff --git a/examples/json/ApiAppGetResponseExample.json b/examples/json/ApiAppGetResponse.json similarity index 100% rename from examples/json/ApiAppGetResponseExample.json rename to examples/json/ApiAppGetResponse.json diff --git a/examples/json/ApiAppListResponseExample.json b/examples/json/ApiAppListResponse.json similarity index 100% rename from examples/json/ApiAppListResponseExample.json rename to examples/json/ApiAppListResponse.json diff --git a/examples/json/ApiAppUpdateRequest.json b/examples/json/ApiAppUpdateRequest.json new file mode 100644 index 000000000..3a06dbcf6 --- /dev/null +++ b/examples/json/ApiAppUpdateRequest.json @@ -0,0 +1,19 @@ +{ + "name": "New Name", + "callback_url": "https://example.com/dropboxsign", + "custom_logo_file": "CustomLogoFile.png", + "domains": [ + "example.com" + ], + "oauth": { + "callback_url": "https://example.com/oauth", + "scopes": [ + "basic_account_info", + "request_signature" + ] + }, + "white_labeling_options": { + "primary_button_color": "#00b3e6", + "primary_button_text_color": "#ffffff" + } +} diff --git a/examples/json/ApiAppUpdateRequestDefaultExample.json b/examples/json/ApiAppUpdateRequestDefaultExample.json deleted file mode 100644 index 7977b977e..000000000 --- a/examples/json/ApiAppUpdateRequestDefaultExample.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "name": "New Name", - "callback_url": "https://example.com/dropboxsign", - "white_labeling_options": { - "primary_button_color": "#00b3e6", - "primary_button_text_color": "#ffffff" - } -} diff --git a/examples/json/ApiAppUpdateResponseExample.json b/examples/json/ApiAppUpdateResponse.json similarity index 100% rename from examples/json/ApiAppUpdateResponseExample.json rename to examples/json/ApiAppUpdateResponse.json diff --git a/examples/json/BulkSendJobGetResponseExample.json b/examples/json/BulkSendJobGetResponse.json similarity index 100% rename from examples/json/BulkSendJobGetResponseExample.json rename to examples/json/BulkSendJobGetResponse.json diff --git a/examples/json/BulkSendJobListResponseExample.json b/examples/json/BulkSendJobListResponse.json similarity index 100% rename from examples/json/BulkSendJobListResponseExample.json rename to examples/json/BulkSendJobListResponse.json diff --git a/examples/json/EmbeddedEditUrlRequestDefaultExample.json b/examples/json/EmbeddedEditUrlRequest.json similarity index 100% rename from examples/json/EmbeddedEditUrlRequestDefaultExample.json rename to examples/json/EmbeddedEditUrlRequest.json diff --git a/examples/json/EmbeddedEditUrlResponseExample.json b/examples/json/EmbeddedEditUrlResponse.json similarity index 100% rename from examples/json/EmbeddedEditUrlResponseExample.json rename to examples/json/EmbeddedEditUrlResponse.json diff --git a/examples/json/EmbeddedSignUrlResponseExample.json b/examples/json/EmbeddedSignUrlResponse.json similarity index 100% rename from examples/json/EmbeddedSignUrlResponseExample.json rename to examples/json/EmbeddedSignUrlResponse.json diff --git a/examples/json/Error400ResponseExample.json b/examples/json/Error400Response.json similarity index 100% rename from examples/json/Error400ResponseExample.json rename to examples/json/Error400Response.json diff --git a/examples/json/Error401ResponseExample.json b/examples/json/Error401Response.json similarity index 100% rename from examples/json/Error401ResponseExample.json rename to examples/json/Error401Response.json diff --git a/examples/json/Error402ResponseExample.json b/examples/json/Error402Response.json similarity index 100% rename from examples/json/Error402ResponseExample.json rename to examples/json/Error402Response.json diff --git a/examples/json/Error403ResponseExample.json b/examples/json/Error403Response.json similarity index 100% rename from examples/json/Error403ResponseExample.json rename to examples/json/Error403Response.json diff --git a/examples/json/Error404ResponseExample.json b/examples/json/Error404Response.json similarity index 100% rename from examples/json/Error404ResponseExample.json rename to examples/json/Error404Response.json diff --git a/examples/json/Error409ResponseExample.json b/examples/json/Error409Response.json similarity index 100% rename from examples/json/Error409ResponseExample.json rename to examples/json/Error409Response.json diff --git a/examples/json/Error410ResponseExample.json b/examples/json/Error410Response.json similarity index 100% rename from examples/json/Error410ResponseExample.json rename to examples/json/Error410Response.json diff --git a/examples/json/Error422ResponseExample.json b/examples/json/Error422Response.json similarity index 100% rename from examples/json/Error422ResponseExample.json rename to examples/json/Error422Response.json diff --git a/examples/json/Error429ResponseExample.json b/examples/json/Error429Response.json similarity index 100% rename from examples/json/Error429ResponseExample.json rename to examples/json/Error429Response.json diff --git a/examples/json/Error4XXResponseExample.json b/examples/json/Error4XXResponse.json similarity index 100% rename from examples/json/Error4XXResponseExample.json rename to examples/json/Error4XXResponse.json diff --git a/examples/json/EventCallbackAccountSignatureRequestSentExample.json b/examples/json/EventCallbackAccountSignatureRequestSent.json similarity index 100% rename from examples/json/EventCallbackAccountSignatureRequestSentExample.json rename to examples/json/EventCallbackAccountSignatureRequestSent.json diff --git a/examples/json/EventCallbackAccountTemplateCreatedExample.json b/examples/json/EventCallbackAccountTemplateCreated.json similarity index 100% rename from examples/json/EventCallbackAccountTemplateCreatedExample.json rename to examples/json/EventCallbackAccountTemplateCreated.json diff --git a/examples/json/EventCallbackAppAccountConfirmedExample.json b/examples/json/EventCallbackAppAccountConfirmed.json similarity index 100% rename from examples/json/EventCallbackAppAccountConfirmedExample.json rename to examples/json/EventCallbackAppAccountConfirmed.json diff --git a/examples/json/EventCallbackAppSignatureRequestSentExample.json b/examples/json/EventCallbackAppSignatureRequestSent.json similarity index 100% rename from examples/json/EventCallbackAppSignatureRequestSentExample.json rename to examples/json/EventCallbackAppSignatureRequestSent.json diff --git a/examples/json/EventCallbackAppTemplateCreatedExample.json b/examples/json/EventCallbackAppTemplateCreated.json similarity index 100% rename from examples/json/EventCallbackAppTemplateCreatedExample.json rename to examples/json/EventCallbackAppTemplateCreated.json diff --git a/examples/json/FaxGetResponseExample.json b/examples/json/FaxGetResponse.json similarity index 100% rename from examples/json/FaxGetResponseExample.json rename to examples/json/FaxGetResponse.json diff --git a/examples/json/FaxLineAddUserRequestExample.json b/examples/json/FaxLineAddUserRequest.json similarity index 100% rename from examples/json/FaxLineAddUserRequestExample.json rename to examples/json/FaxLineAddUserRequest.json diff --git a/examples/json/FaxLineAreaCodeGetResponseExample.json b/examples/json/FaxLineAreaCodeGetResponse.json similarity index 100% rename from examples/json/FaxLineAreaCodeGetResponseExample.json rename to examples/json/FaxLineAreaCodeGetResponse.json diff --git a/examples/json/FaxLineCreateRequestExample.json b/examples/json/FaxLineCreateRequest.json similarity index 100% rename from examples/json/FaxLineCreateRequestExample.json rename to examples/json/FaxLineCreateRequest.json diff --git a/examples/json/FaxLineDeleteRequestExample.json b/examples/json/FaxLineDeleteRequest.json similarity index 100% rename from examples/json/FaxLineDeleteRequestExample.json rename to examples/json/FaxLineDeleteRequest.json diff --git a/examples/json/FaxLineListResponseExample.json b/examples/json/FaxLineListResponse.json similarity index 100% rename from examples/json/FaxLineListResponseExample.json rename to examples/json/FaxLineListResponse.json diff --git a/examples/json/FaxLineRemoveUserRequestExample.json b/examples/json/FaxLineRemoveUserRequest.json similarity index 100% rename from examples/json/FaxLineRemoveUserRequestExample.json rename to examples/json/FaxLineRemoveUserRequest.json diff --git a/examples/json/FaxLineResponseExample.json b/examples/json/FaxLineResponse.json similarity index 100% rename from examples/json/FaxLineResponseExample.json rename to examples/json/FaxLineResponse.json diff --git a/examples/json/FaxListResponseExample.json b/examples/json/FaxListResponse.json similarity index 100% rename from examples/json/FaxListResponseExample.json rename to examples/json/FaxListResponse.json diff --git a/examples/json/FaxSendRequest.json b/examples/json/FaxSendRequest.json new file mode 100644 index 000000000..7bfb88209 --- /dev/null +++ b/examples/json/FaxSendRequest.json @@ -0,0 +1,12 @@ +{ + "files": [ + "./example_fax.pdf" + ], + "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!" +} diff --git a/examples/json/FaxSendRequestExample.json b/examples/json/FaxSendRequestExample.json deleted file mode 100644 index 4b4ac16b3..000000000 --- a/examples/json/FaxSendRequestExample.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "file_urls": [ - "https://api.hellosign.com/v3/fax/files/2b388914e3ae3b738bd4e2ee2850c677e6dc53d2" - ], - "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!" -} diff --git a/examples/json/OAuthTokenGenerateRequestExample.json b/examples/json/OAuthTokenGenerateRequest.json similarity index 100% rename from examples/json/OAuthTokenGenerateRequestExample.json rename to examples/json/OAuthTokenGenerateRequest.json diff --git a/examples/json/OAuthTokenGenerateResponseExample.json b/examples/json/OAuthTokenGenerateResponse.json similarity index 100% rename from examples/json/OAuthTokenGenerateResponseExample.json rename to examples/json/OAuthTokenGenerateResponse.json diff --git a/examples/json/OAuthTokenRefreshRequestExample.json b/examples/json/OAuthTokenRefreshRequest.json similarity index 100% rename from examples/json/OAuthTokenRefreshRequestExample.json rename to examples/json/OAuthTokenRefreshRequest.json diff --git a/examples/json/OAuthTokenRefreshResponseExample.json b/examples/json/OAuthTokenRefreshResponse.json similarity index 100% rename from examples/json/OAuthTokenRefreshResponseExample.json rename to examples/json/OAuthTokenRefreshResponse.json diff --git a/examples/json/ReportCreateRequestDefaultExample.json b/examples/json/ReportCreateRequest.json similarity index 100% rename from examples/json/ReportCreateRequestDefaultExample.json rename to examples/json/ReportCreateRequest.json diff --git a/examples/json/ReportCreateResponseExample.json b/examples/json/ReportCreateResponse.json similarity index 100% rename from examples/json/ReportCreateResponseExample.json rename to examples/json/ReportCreateResponse.json diff --git a/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json diff --git a/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json b/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormData.json similarity index 100% rename from examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormDataExample.json rename to examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestFormData.json diff --git a/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json rename to examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json diff --git a/examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestBulkSendWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestBulkSendWithTemplateRequest.json diff --git a/examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json b/examples/json/SignatureRequestBulkSendWithTemplateRequestFormData.json similarity index 100% rename from examples/json/SignatureRequestBulkSendWithTemplateRequestFormDataExample.json rename to examples/json/SignatureRequestBulkSendWithTemplateRequestFormData.json diff --git a/examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json b/examples/json/SignatureRequestBulkSendWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json rename to examples/json/SignatureRequestBulkSendWithTemplateResponse.json diff --git a/examples/json/SignatureRequestCreateEmbeddedRequest.json b/examples/json/SignatureRequestCreateEmbeddedRequest.json new file mode 100644 index 000000000..ba7accb05 --- /dev/null +++ b/examples/json/SignatureRequestCreateEmbeddedRequest.json @@ -0,0 +1,33 @@ +{ + "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + }, + { + "email_address": "jill@example.com", + "name": "Jill", + "order": 1 + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "files": [ + "./example_signature_request.pdf" + ], + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json b/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json deleted file mode 100644 index 724db5940..000000000 --- a/examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", - "title": "NDA with Acme Co.", - "subject": "The NDA we talked about", - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "signers": [ - { - "email_address": "jack@example.com", - "name": "Jack", - "order": 0 - }, - { - "email_address": "jill@example.com", - "name": "Jill", - "order": 1 - } - ], - "cc_email_addresses": [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com" - ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" - ], - "signing_options": { - "draw": true, - "type": true, - "upload": true, - "phone": false, - "default_type": "draw" - }, - "test_mode": true -} diff --git a/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json b/examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json rename to examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestCreateEmbeddedResponseExample.json b/examples/json/SignatureRequestCreateEmbeddedResponse.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedResponseExample.json rename to examples/json/SignatureRequestCreateEmbeddedResponse.json diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json diff --git a/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json rename to examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json diff --git a/examples/json/SignatureRequestEditEmbeddedRequest.json b/examples/json/SignatureRequestEditEmbeddedRequest.json new file mode 100644 index 000000000..ba7accb05 --- /dev/null +++ b/examples/json/SignatureRequestEditEmbeddedRequest.json @@ -0,0 +1,33 @@ +{ + "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + }, + { + "email_address": "jill@example.com", + "name": "Jill", + "order": 1 + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "files": [ + "./example_signature_request.pdf" + ], + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json b/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json deleted file mode 100644 index 724db5940..000000000 --- a/examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", - "title": "NDA with Acme Co.", - "subject": "The NDA we talked about", - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "signers": [ - { - "email_address": "jack@example.com", - "name": "Jack", - "order": 0 - }, - { - "email_address": "jill@example.com", - "name": "Jill", - "order": 1 - } - ], - "cc_email_addresses": [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com" - ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" - ], - "signing_options": { - "draw": true, - "type": true, - "upload": true, - "phone": false, - "default_type": "draw" - }, - "test_mode": true -} diff --git a/examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json b/examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json rename to examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestEditEmbeddedResponseExample.json b/examples/json/SignatureRequestEditEmbeddedResponse.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedResponseExample.json rename to examples/json/SignatureRequestEditEmbeddedResponse.json diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json diff --git a/examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json b/examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestEditEmbeddedWithTemplateResponseExample.json rename to examples/json/SignatureRequestEditEmbeddedWithTemplateResponse.json diff --git a/examples/json/SignatureRequestEditRequest.json b/examples/json/SignatureRequestEditRequest.json new file mode 100644 index 000000000..3d1b98727 --- /dev/null +++ b/examples/json/SignatureRequestEditRequest.json @@ -0,0 +1,39 @@ +{ + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + }, + { + "email_address": "jill@example.com", + "name": "Jill", + "order": 1 + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "files": [ + "./example_signature_request.pdf" + ], + "metadata": { + "custom_id": 1234, + "custom_text": "NDA #9" + }, + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "field_options": { + "date_format": "DD - MM - YYYY" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestEditRequestDefaultExample.json b/examples/json/SignatureRequestEditRequestDefaultExample.json deleted file mode 100644 index adfda81ec..000000000 --- a/examples/json/SignatureRequestEditRequestDefaultExample.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "title": "NDA with Acme Co.", - "subject": "The NDA we talked about", - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "signers": [ - { - "email_address": "jack@example.com", - "name": "Jack", - "order": 0 - }, - { - "email_address": "jill@example.com", - "name": "Jill", - "order": 1 - } - ], - "cc_email_addresses": [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com" - ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" - ], - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signing_options": { - "draw": true, - "type": true, - "upload": true, - "phone": false, - "default_type": "draw" - }, - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "test_mode": true -} diff --git a/examples/json/SignatureRequestEditRequestGroupedSignersExample.json b/examples/json/SignatureRequestEditRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestEditRequestGroupedSignersExample.json rename to examples/json/SignatureRequestEditRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestEditResponseExample.json b/examples/json/SignatureRequestEditResponse.json similarity index 100% rename from examples/json/SignatureRequestEditResponseExample.json rename to examples/json/SignatureRequestEditResponse.json diff --git a/examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestEditWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestEditWithTemplateRequest.json diff --git a/examples/json/SignatureRequestEditWithTemplateResponseExample.json b/examples/json/SignatureRequestEditWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestEditWithTemplateResponseExample.json rename to examples/json/SignatureRequestEditWithTemplateResponse.json diff --git a/examples/json/SignatureRequestFilesResponseExample.json b/examples/json/SignatureRequestFilesResponse.json similarity index 100% rename from examples/json/SignatureRequestFilesResponseExample.json rename to examples/json/SignatureRequestFilesResponse.json diff --git a/examples/json/SignatureRequestGetResponseExample.json b/examples/json/SignatureRequestGetResponse.json similarity index 100% rename from examples/json/SignatureRequestGetResponseExample.json rename to examples/json/SignatureRequestGetResponse.json diff --git a/examples/json/SignatureRequestListResponseExample.json b/examples/json/SignatureRequestListResponse.json similarity index 100% rename from examples/json/SignatureRequestListResponseExample.json rename to examples/json/SignatureRequestListResponse.json diff --git a/examples/json/SignatureRequestReleaseHoldResponseExample.json b/examples/json/SignatureRequestReleaseHoldResponse.json similarity index 100% rename from examples/json/SignatureRequestReleaseHoldResponseExample.json rename to examples/json/SignatureRequestReleaseHoldResponse.json diff --git a/examples/json/SignatureRequestRemindRequestDefaultExample.json b/examples/json/SignatureRequestRemindRequest.json similarity index 100% rename from examples/json/SignatureRequestRemindRequestDefaultExample.json rename to examples/json/SignatureRequestRemindRequest.json diff --git a/examples/json/SignatureRequestRemindResponseExample.json b/examples/json/SignatureRequestRemindResponse.json similarity index 100% rename from examples/json/SignatureRequestRemindResponseExample.json rename to examples/json/SignatureRequestRemindResponse.json diff --git a/examples/json/SignatureRequestSendRequest.json b/examples/json/SignatureRequestSendRequest.json new file mode 100644 index 000000000..3d1b98727 --- /dev/null +++ b/examples/json/SignatureRequestSendRequest.json @@ -0,0 +1,39 @@ +{ + "title": "NDA with Acme Co.", + "subject": "The NDA we talked about", + "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + }, + { + "email_address": "jill@example.com", + "name": "Jill", + "order": 1 + } + ], + "cc_email_addresses": [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + ], + "files": [ + "./example_signature_request.pdf" + ], + "metadata": { + "custom_id": 1234, + "custom_text": "NDA #9" + }, + "signing_options": { + "draw": true, + "type": true, + "upload": true, + "phone": false, + "default_type": "draw" + }, + "field_options": { + "date_format": "DD - MM - YYYY" + }, + "test_mode": true +} diff --git a/examples/json/SignatureRequestSendRequestDefaultExample.json b/examples/json/SignatureRequestSendRequestDefaultExample.json deleted file mode 100644 index adfda81ec..000000000 --- a/examples/json/SignatureRequestSendRequestDefaultExample.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "title": "NDA with Acme Co.", - "subject": "The NDA we talked about", - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "signers": [ - { - "email_address": "jack@example.com", - "name": "Jack", - "order": 0 - }, - { - "email_address": "jill@example.com", - "name": "Jill", - "order": 1 - } - ], - "cc_email_addresses": [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com" - ], - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" - ], - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signing_options": { - "draw": true, - "type": true, - "upload": true, - "phone": false, - "default_type": "draw" - }, - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "test_mode": true -} diff --git a/examples/json/SignatureRequestSendRequestGroupedSignersExample.json b/examples/json/SignatureRequestSendRequestGroupedSigners.json similarity index 100% rename from examples/json/SignatureRequestSendRequestGroupedSignersExample.json rename to examples/json/SignatureRequestSendRequestGroupedSigners.json diff --git a/examples/json/SignatureRequestSendResponseExample.json b/examples/json/SignatureRequestSendResponse.json similarity index 100% rename from examples/json/SignatureRequestSendResponseExample.json rename to examples/json/SignatureRequestSendResponse.json diff --git a/examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json b/examples/json/SignatureRequestSendWithTemplateRequest.json similarity index 100% rename from examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json rename to examples/json/SignatureRequestSendWithTemplateRequest.json diff --git a/examples/json/SignatureRequestSendWithTemplateResponseExample.json b/examples/json/SignatureRequestSendWithTemplateResponse.json similarity index 100% rename from examples/json/SignatureRequestSendWithTemplateResponseExample.json rename to examples/json/SignatureRequestSendWithTemplateResponse.json diff --git a/examples/json/SignatureRequestUpdateRequestDefaultExample.json b/examples/json/SignatureRequestUpdateRequest.json similarity index 100% rename from examples/json/SignatureRequestUpdateRequestDefaultExample.json rename to examples/json/SignatureRequestUpdateRequest.json diff --git a/examples/json/SignatureRequestUpdateResponseExample.json b/examples/json/SignatureRequestUpdateResponse.json similarity index 100% rename from examples/json/SignatureRequestUpdateResponseExample.json rename to examples/json/SignatureRequestUpdateResponse.json diff --git a/examples/json/TeamAddMemberRequestEmailAddressExample.json b/examples/json/TeamAddMemberRequest.json similarity index 100% rename from examples/json/TeamAddMemberRequestEmailAddressExample.json rename to examples/json/TeamAddMemberRequest.json diff --git a/examples/json/TeamAddMemberRequestAccountIdExample.json b/examples/json/TeamAddMemberRequestAccountId.json similarity index 100% rename from examples/json/TeamAddMemberRequestAccountIdExample.json rename to examples/json/TeamAddMemberRequestAccountId.json diff --git a/examples/json/TeamAddMemberResponseExample.json b/examples/json/TeamAddMemberResponse.json similarity index 100% rename from examples/json/TeamAddMemberResponseExample.json rename to examples/json/TeamAddMemberResponse.json diff --git a/examples/json/TeamCreateRequestDefaultExample.json b/examples/json/TeamCreateRequest.json similarity index 100% rename from examples/json/TeamCreateRequestDefaultExample.json rename to examples/json/TeamCreateRequest.json diff --git a/examples/json/TeamCreateResponseExample.json b/examples/json/TeamCreateResponse.json similarity index 100% rename from examples/json/TeamCreateResponseExample.json rename to examples/json/TeamCreateResponse.json diff --git a/examples/json/TeamDoesNotExistResponseExample.json b/examples/json/TeamDoesNotExistResponse.json similarity index 100% rename from examples/json/TeamDoesNotExistResponseExample.json rename to examples/json/TeamDoesNotExistResponse.json diff --git a/examples/json/TeamGetInfoResponseExample.json b/examples/json/TeamGetInfoResponse.json similarity index 100% rename from examples/json/TeamGetInfoResponseExample.json rename to examples/json/TeamGetInfoResponse.json diff --git a/examples/json/TeamGetResponseExample.json b/examples/json/TeamGetResponse.json similarity index 100% rename from examples/json/TeamGetResponseExample.json rename to examples/json/TeamGetResponse.json diff --git a/examples/json/TeamGetRootInfoResponseExample.json b/examples/json/TeamGetRootInfoResponse.json similarity index 100% rename from examples/json/TeamGetRootInfoResponseExample.json rename to examples/json/TeamGetRootInfoResponse.json diff --git a/examples/json/TeamInvitesResponseExample.json b/examples/json/TeamInvitesResponse.json similarity index 100% rename from examples/json/TeamInvitesResponseExample.json rename to examples/json/TeamInvitesResponse.json diff --git a/examples/json/TeamMembersResponseExample.json b/examples/json/TeamMembersResponse.json similarity index 100% rename from examples/json/TeamMembersResponseExample.json rename to examples/json/TeamMembersResponse.json diff --git a/examples/json/TeamRemoveMemberRequestEmailAddressExample.json b/examples/json/TeamRemoveMemberRequest.json similarity index 100% rename from examples/json/TeamRemoveMemberRequestEmailAddressExample.json rename to examples/json/TeamRemoveMemberRequest.json diff --git a/examples/json/TeamRemoveMemberRequestAccountIdExample.json b/examples/json/TeamRemoveMemberRequestAccountId.json similarity index 100% rename from examples/json/TeamRemoveMemberRequestAccountIdExample.json rename to examples/json/TeamRemoveMemberRequestAccountId.json diff --git a/examples/json/TeamRemoveMemberResponseExample.json b/examples/json/TeamRemoveMemberResponse.json similarity index 100% rename from examples/json/TeamRemoveMemberResponseExample.json rename to examples/json/TeamRemoveMemberResponse.json diff --git a/examples/json/TeamSubTeamsResponseExample.json b/examples/json/TeamSubTeamsResponse.json similarity index 100% rename from examples/json/TeamSubTeamsResponseExample.json rename to examples/json/TeamSubTeamsResponse.json diff --git a/examples/json/TeamUpdateRequestDefaultExample.json b/examples/json/TeamUpdateRequest.json similarity index 100% rename from examples/json/TeamUpdateRequestDefaultExample.json rename to examples/json/TeamUpdateRequest.json diff --git a/examples/json/TeamUpdateResponseExample.json b/examples/json/TeamUpdateResponse.json similarity index 100% rename from examples/json/TeamUpdateResponseExample.json rename to examples/json/TeamUpdateResponse.json diff --git a/examples/json/TemplateAddUserRequestDefaultExample.json b/examples/json/TemplateAddUserRequest.json similarity index 100% rename from examples/json/TemplateAddUserRequestDefaultExample.json rename to examples/json/TemplateAddUserRequest.json diff --git a/examples/json/TemplateAddUserResponseExample.json b/examples/json/TemplateAddUserResponse.json similarity index 100% rename from examples/json/TemplateAddUserResponseExample.json rename to examples/json/TemplateAddUserResponse.json diff --git a/examples/json/TemplateCreateEmbeddedDraftRequest.json b/examples/json/TemplateCreateEmbeddedDraftRequest.json new file mode 100644 index 000000000..68c71abe1 --- /dev/null +++ b/examples/json/TemplateCreateEmbeddedDraftRequest.json @@ -0,0 +1,36 @@ +{ + "client_id": "37dee8d8440c66d54cfa05d92c160882", + "files": [ + "./example_signature_request.pdf" + ], + "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 +} diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json deleted file mode 100644 index 10f895fe8..000000000 --- a/examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "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 -} diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json diff --git a/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json b/examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json rename to examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json diff --git a/examples/json/TemplateCreateEmbeddedDraftResponseExample.json b/examples/json/TemplateCreateEmbeddedDraftResponse.json similarity index 100% rename from examples/json/TemplateCreateEmbeddedDraftResponseExample.json rename to examples/json/TemplateCreateEmbeddedDraftResponse.json diff --git a/examples/json/TemplateCreateRequest.json b/examples/json/TemplateCreateRequest.json new file mode 100644 index 000000000..b18275f8a --- /dev/null +++ b/examples/json/TemplateCreateRequest.json @@ -0,0 +1,66 @@ +{ + "client_id": "37dee8d8440c66d54cfa05d92c160882", + "files": [ + "./example_signature_request.pdf" + ], + "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 +} diff --git a/examples/json/TemplateCreateRequestFormFieldGroupsExample.json b/examples/json/TemplateCreateRequestFormFieldGroups.json similarity index 100% rename from examples/json/TemplateCreateRequestFormFieldGroupsExample.json rename to examples/json/TemplateCreateRequestFormFieldGroups.json diff --git a/examples/json/TemplateCreateRequestFormFieldRulesExample.json b/examples/json/TemplateCreateRequestFormFieldRules.json similarity index 100% rename from examples/json/TemplateCreateRequestFormFieldRulesExample.json rename to examples/json/TemplateCreateRequestFormFieldRules.json diff --git a/examples/json/TemplateCreateRequestDefaultExample.json b/examples/json/TemplateCreateRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/TemplateCreateRequestDefaultExample.json rename to examples/json/TemplateCreateRequestFormFieldsPerDocument.json diff --git a/examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json b/examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json deleted file mode 100644 index a3709afcc..000000000 --- a/examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "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 -} diff --git a/examples/json/TemplateCreateResponseExample.json b/examples/json/TemplateCreateResponse.json similarity index 100% rename from examples/json/TemplateCreateResponseExample.json rename to examples/json/TemplateCreateResponse.json diff --git a/examples/json/TemplateFilesResponseExample.json b/examples/json/TemplateFilesResponse.json similarity index 100% rename from examples/json/TemplateFilesResponseExample.json rename to examples/json/TemplateFilesResponse.json diff --git a/examples/json/TemplateGetResponseExample.json b/examples/json/TemplateGetResponse.json similarity index 100% rename from examples/json/TemplateGetResponseExample.json rename to examples/json/TemplateGetResponse.json diff --git a/examples/json/TemplateListResponseExample.json b/examples/json/TemplateListResponse.json similarity index 100% rename from examples/json/TemplateListResponseExample.json rename to examples/json/TemplateListResponse.json diff --git a/examples/json/TemplateRemoveUserRequestDefaultExample.json b/examples/json/TemplateRemoveUserRequest.json similarity index 100% rename from examples/json/TemplateRemoveUserRequestDefaultExample.json rename to examples/json/TemplateRemoveUserRequest.json diff --git a/examples/json/TemplateRemoveUserResponseExample.json b/examples/json/TemplateRemoveUserResponse.json similarity index 100% rename from examples/json/TemplateRemoveUserResponseExample.json rename to examples/json/TemplateRemoveUserResponse.json diff --git a/examples/json/TemplateUpdateFilesRequest.json b/examples/json/TemplateUpdateFilesRequest.json new file mode 100644 index 000000000..120e168a6 --- /dev/null +++ b/examples/json/TemplateUpdateFilesRequest.json @@ -0,0 +1,5 @@ +{ + "files": [ + "./example_signature_request.pdf" + ] +} diff --git a/examples/json/TemplateUpdateFilesRequestDefaultExample.json b/examples/json/TemplateUpdateFilesRequestDefaultExample.json deleted file mode 100644 index 88c101579..000000000 --- a/examples/json/TemplateUpdateFilesRequestDefaultExample.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "file_urls": [ - "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" - ] -} diff --git a/examples/json/TemplateUpdateFilesResponseExample.json b/examples/json/TemplateUpdateFilesResponse.json similarity index 100% rename from examples/json/TemplateUpdateFilesResponseExample.json rename to examples/json/TemplateUpdateFilesResponse.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequest.json b/examples/json/UnclaimedDraftCreateEmbeddedRequest.json new file mode 100644 index 000000000..9f8c02387 --- /dev/null +++ b/examples/json/UnclaimedDraftCreateEmbeddedRequest.json @@ -0,0 +1,8 @@ +{ + "client_id": "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + "files": [ + "./example_signature_request.pdf" + ], + "requester_email_address": "jack@dropboxsign.com", + "test_mode": true +} diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json deleted file mode 100644 index ae9f61ad6..000000000 --- a/examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "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 -} diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json b/examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json b/examples/json/UnclaimedDraftCreateEmbeddedResponse.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedResponse.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json b/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json diff --git a/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json b/examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json similarity index 100% rename from examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json rename to examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json diff --git a/examples/json/UnclaimedDraftCreateRequest.json b/examples/json/UnclaimedDraftCreateRequest.json new file mode 100644 index 000000000..21707bde1 --- /dev/null +++ b/examples/json/UnclaimedDraftCreateRequest.json @@ -0,0 +1,14 @@ +{ + "files": [ + "./example_signature_request.pdf" + ], + "signers": [ + { + "email_address": "jack@example.com", + "name": "Jack", + "order": 0 + } + ], + "type": "request_signature", + "test_mode": true +} diff --git a/examples/json/UnclaimedDraftCreateRequestDefaultExample.json b/examples/json/UnclaimedDraftCreateRequestDefaultExample.json deleted file mode 100644 index 5ed2ca115..000000000 --- a/examples/json/UnclaimedDraftCreateRequestDefaultExample.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "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 -} diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json similarity index 100% rename from examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json rename to examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldRules.json similarity index 100% rename from examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json rename to examples/json/UnclaimedDraftCreateRequestFormFieldRules.json diff --git a/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json b/examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json similarity index 100% rename from examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json rename to examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json diff --git a/examples/json/UnclaimedDraftCreateResponseExample.json b/examples/json/UnclaimedDraftCreateResponse.json similarity index 100% rename from examples/json/UnclaimedDraftCreateResponseExample.json rename to examples/json/UnclaimedDraftCreateResponse.json diff --git a/examples/json/UnclaimedDraftEditAndResendExample.json b/examples/json/UnclaimedDraftEditAndResend.json similarity index 100% rename from examples/json/UnclaimedDraftEditAndResendExample.json rename to examples/json/UnclaimedDraftEditAndResend.json diff --git a/examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json b/examples/json/UnclaimedDraftEditAndResendRequest.json similarity index 100% rename from examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json rename to examples/json/UnclaimedDraftEditAndResendRequest.json diff --git a/generate-sdks b/generate-sdks index fe899ab18..de40ae11b 100755 --- a/generate-sdks +++ b/generate-sdks @@ -155,18 +155,17 @@ function copy_examples() mkdir -p "${SDK_DIR}/examples" if [[ "${SDK}" == "dotnet" ]]; then - cp -r "${DIR}/examples/"*.cs "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/dotnet/src/Dropbox.SignSandbox/"*.cs "${SDK_DIR}/examples/" elif [[ "${SDK}" == "java-v2" || "${SDK}" == "java-v1" ]]; then - cp -r "${DIR}/examples/"*.java "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/java/src/main/java/com/dropbox/sign_sandbox/"*.java "${SDK_DIR}/examples/" elif [[ "${SDK}" == "node" ]]; then - cp -r "${DIR}/examples/"*.js "${SDK_DIR}/examples/" - cp -r "${DIR}/examples/"*.ts "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/node/src/"*.ts "${SDK_DIR}/examples/" elif [[ "${SDK}" == "php" ]]; then - cp -r "${DIR}/examples/"*.php "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/php/src/"*.php "${SDK_DIR}/examples/" elif [[ "${SDK}" == "python" ]]; then - cp -r "${DIR}/examples/"*.py "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/python/src/"*.py "${SDK_DIR}/examples/" elif [[ "${SDK}" == "ruby" ]]; then - cp -r "${DIR}/examples/"*.rb "${SDK_DIR}/examples/" + cp -r "${DIR}/sandbox/ruby/src/"*.rb "${SDK_DIR}/examples/" fi } diff --git a/openapi-raw.yaml b/openapi-raw.yaml index b03c3d48d..64611ce29 100644 --- a/openapi-raw.yaml +++ b/openapi-raw.yaml @@ -27,10 +27,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: '200': description: 'successful operation' @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' 4XX: description: failed_operation content: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: '_t__AccountCreate::SEO::TITLE' @@ -155,8 +150,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' + example: + $ref: '#/components/examples/AccountGetResponse' 4XX: description: failed_operation content: @@ -165,15 +160,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -186,42 +181,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: '_t__AccountGet::SEO::TITLE' @@ -239,8 +229,8 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: '200': description: 'successful operation' @@ -256,8 +246,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' + example: + $ref: '#/components/examples/AccountUpdateResponse' 4XX: description: failed_operation content: @@ -266,17 +256,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -288,42 +278,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: '_t__AccountUpdate::SEO::TITLE' @@ -342,8 +327,8 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: '200': description: 'successful operation' @@ -359,10 +344,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' 4XX: description: failed_operation content: @@ -371,15 +356,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -391,42 +376,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: '_t__AccountVerify::SEO::TITLE' @@ -445,8 +425,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' @@ -465,8 +445,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' + example: + $ref: '#/components/examples/ApiAppCreateResponse' 4XX: description: failed_operation content: @@ -475,17 +455,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -497,42 +477,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: '_t__ApiAppCreate::SEO::TITLE' @@ -568,8 +543,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' + example: + $ref: '#/components/examples/ApiAppGetResponse' 4XX: description: failed_operation content: @@ -578,19 +553,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -602,42 +577,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: '_t__ApiAppGet::SEO::TITLE' @@ -664,8 +634,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' @@ -684,8 +654,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' + example: + $ref: '#/components/examples/ApiAppUpdateResponse' 4XX: description: failed_operation content: @@ -694,19 +664,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -718,42 +688,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: '_t__ApiAppUpdate::SEO::TITLE' @@ -791,17 +756,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -813,42 +778,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: '_t__ApiAppDelete::SEO::TITLE' @@ -890,8 +850,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' + example: + $ref: '#/components/examples/ApiAppListResponse' 4XX: description: failed_operation content: @@ -900,15 +860,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -920,42 +880,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: '_t__ApiAppList::SEO::TITLE' @@ -1005,8 +960,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' + example: + $ref: '#/components/examples/BulkSendJobGetResponse' 4XX: description: failed_operation content: @@ -1015,15 +970,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1036,42 +991,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: '_t__BulkSendJobGet::SEO::TITLE' @@ -1113,8 +1063,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' + example: + $ref: '#/components/examples/BulkSendJobListResponse' 4XX: description: failed_operation content: @@ -1123,15 +1073,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1144,42 +1094,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: '_t__BulkSendJobList::SEO::TITLE' @@ -1207,8 +1152,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: '200': description: 'successful operation' @@ -1224,8 +1169,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' 4XX: description: failed_operation content: @@ -1234,17 +1179,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1256,42 +1201,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: '_t__EmbeddedEditUrl::SEO::TITLE' @@ -1327,8 +1267,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' 4XX: description: failed_operation content: @@ -1337,21 +1277,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1363,42 +1303,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: '_t__EmbeddedSignUrl::SEO::TITLE' @@ -1434,8 +1369,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' 4XX: description: failed_operation content: @@ -1444,19 +1379,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1465,42 +1400,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: '_t__FaxGet::SEO::TITLE' @@ -1538,19 +1468,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1559,42 +1489,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: '_t__FaxDelete::SEO::TITLE' @@ -1638,21 +1563,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1661,42 +1586,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: '_t__FaxFiles::SEO::TITLE' @@ -1715,8 +1635,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: '200': description: 'successful operation' @@ -1732,8 +1652,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -1742,17 +1662,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1761,42 +1681,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: '_t__FaxLineAddUser::SEO::TITLE' @@ -1820,6 +1735,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -1919,8 +1835,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' 4XX: description: failed_operation content: @@ -1929,15 +1845,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1946,42 +1862,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: '_t__FaxLineAreaCodeGet::SEO::TITLE' @@ -2000,8 +1911,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: '200': description: 'successful operation' @@ -2017,8 +1928,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -2027,17 +1938,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2046,42 +1957,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: '_t__FaxLineCreate::SEO::TITLE' @@ -2101,6 +2007,7 @@ paths: required: true schema: type: string + example: 123-123-1234 responses: '200': description: 'successful operation' @@ -2116,8 +2023,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -2126,17 +2033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2145,42 +2052,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: '_t__FaxLineGet::SEO::TITLE' @@ -2198,8 +2100,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: '200': description: 'successful operation' @@ -2220,17 +2122,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2239,42 +2141,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: '_t__FaxLineDelete::SEO::TITLE' @@ -2293,7 +2190,7 @@ paths: description: '_t__FaxLineList::ACCOUNT_ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2301,7 +2198,7 @@ paths: schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query @@ -2309,7 +2206,7 @@ paths: schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query @@ -2331,8 +2228,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + example: + $ref: '#/components/examples/FaxLineListResponse' 4XX: description: failed_operation content: @@ -2341,15 +2238,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2358,42 +2255,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: '_t__FaxLineList::SEO::TITLE' @@ -2412,8 +2304,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: '200': description: 'successful operation' @@ -2429,8 +2321,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' 4XX: description: failed_operation content: @@ -2439,17 +2331,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2458,42 +2350,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: '_t__FaxLineRemoveUser::SEO::TITLE' @@ -2540,8 +2427,8 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' + example: + $ref: '#/components/examples/FaxListResponse' 4XX: description: failed_operation content: @@ -2550,15 +2437,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2567,42 +2454,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: '_t__FaxList::SEO::TITLE' @@ -2621,8 +2503,8 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' @@ -2641,8 +2523,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' 4XX: description: failed_operation content: @@ -2651,19 +2533,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2672,42 +2554,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: title: '_t__FaxSend::SEO::TITLE' @@ -2726,8 +2603,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: '200': description: 'successful operation' @@ -2743,8 +2620,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' 4XX: description: failed_operation content: @@ -2753,15 +2630,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2771,42 +2648,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: '_t__OAuthTokenGenerate::SEO::TITLE' @@ -2826,8 +2698,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: '200': description: 'successful operation' @@ -2843,8 +2715,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' 4XX: description: failed_operation content: @@ -2853,15 +2725,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2871,42 +2743,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: '_t__OAuthTokenRefresh::SEO::TITLE' @@ -2926,8 +2793,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: '200': description: 'successful operation' @@ -2943,8 +2810,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' + example: + $ref: '#/components/examples/ReportCreateResponse' 4XX: description: failed_operation content: @@ -2953,15 +2820,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2970,42 +2837,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: '_t__ReportCreate::SEO::TITLE' @@ -3024,8 +2886,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' @@ -3044,8 +2906,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -3054,21 +2916,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3077,42 +2939,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestBulkCreateEmbeddedWithTemplate::SEO::TITLE' @@ -3131,8 +2988,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' @@ -3151,8 +3008,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' 4XX: description: failed_operation content: @@ -3161,17 +3018,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3184,42 +3041,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestBulkSendWithTemplate::SEO::TITLE' @@ -3260,21 +3112,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3287,42 +3139,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: '_t__SignatureRequestCancel::SEO::TITLE' @@ -3341,10 +3188,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' @@ -3363,8 +3210,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' 4XX: description: failed_operation content: @@ -3373,19 +3220,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3397,42 +3244,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: '_t__SignatureRequestCreateEmbedded::SEO::TITLE' @@ -3451,8 +3293,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' @@ -3471,8 +3313,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -3481,19 +3323,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3505,42 +3347,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestCreateEmbeddedWithTemplate::SEO::TITLE' @@ -3568,10 +3405,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' @@ -3590,8 +3427,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditResponse' 4XX: description: failed_operation content: @@ -3600,21 +3437,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3627,42 +3464,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEdit.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEdit.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEdit.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEdit.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEdit.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEdit.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEdit.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEdit.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: title: '_t__SignatureRequestEdit::SEO::TITLE' @@ -3692,10 +3524,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' @@ -3714,8 +3546,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedResponse' 4XX: description: failed_operation content: @@ -3724,21 +3556,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3750,42 +3582,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbedded.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbedded.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbedded.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbedded.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbedded.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbedded.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbedded.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: title: '_t__SignatureRequestEditEmbedded::SEO::TITLE' @@ -3815,8 +3642,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' @@ -3835,8 +3662,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -3845,21 +3672,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3871,42 +3698,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestEditEmbeddedWithTemplate::SEO::TITLE' @@ -3936,8 +3758,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' @@ -3956,8 +3778,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateResponse' 4XX: description: failed_operation content: @@ -3966,21 +3788,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,42 +3815,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditWithTemplate.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditWithTemplate.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditWithTemplate.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditWithTemplate.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditWithTemplate.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditWithTemplate.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditWithTemplate.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestEditWithTemplate::SEO::TITLE' @@ -4088,23 +3905,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4117,42 +3934,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' @@ -4188,8 +4000,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' 4XX: description: failed_operation content: @@ -4198,23 +4010,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4227,42 +4039,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' @@ -4305,8 +4112,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' 4XX: description: failed_operation content: @@ -4315,23 +4122,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,42 +4151,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: title: '_t__SignatureRequestFiles::SEO::TITLE' @@ -4415,8 +4217,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + example: + $ref: '#/components/examples/SignatureRequestGetResponse' 4XX: description: failed_operation content: @@ -4425,19 +4227,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4450,42 +4252,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: title: '_t__SignatureRequestGet::SEO::TITLE' @@ -4540,8 +4337,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + example: + $ref: '#/components/examples/SignatureRequestListResponse' 4XX: description: failed_operation content: @@ -4550,17 +4347,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4573,42 +4370,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: title: '_t__SignatureRequestList::SEO::TITLE' @@ -4644,8 +4436,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' 4XX: description: failed_operation content: @@ -4654,17 +4446,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4676,42 +4468,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: title: '_t__SignatureRequestReleaseHold::SEO::TITLE' @@ -4739,8 +4526,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: '200': description: 'successful operation' @@ -4756,8 +4543,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' 4XX: description: failed_operation content: @@ -4766,23 +4553,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4795,42 +4582,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: title: '_t__SignatureRequestRemind::SEO::TITLE' @@ -4871,21 +4653,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4894,42 +4676,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: title: '_t__SignatureRequestRemove::SEO::TITLE' @@ -4948,10 +4725,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' @@ -4970,8 +4747,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendResponse' 4XX: description: failed_operation content: @@ -4980,19 +4757,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5005,42 +4782,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: title: '_t__SignatureRequestSend::SEO::TITLE' @@ -5059,8 +4831,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' @@ -5079,8 +4851,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' 4XX: description: failed_operation content: @@ -5089,17 +4861,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5112,42 +4884,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: title: '_t__SignatureRequestSendWithTemplate::SEO::TITLE' @@ -5175,8 +4942,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: '200': description: 'successful operation' @@ -5192,8 +4959,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' 4XX: description: failed_operation content: @@ -5202,17 +4969,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5224,42 +4991,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: title: '_t__SignatureRequestUpdate::SEO::TITLE' @@ -5287,10 +5049,10 @@ paths: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: '200': description: 'successful operation' @@ -5306,8 +5068,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + example: + $ref: '#/components/examples/TeamAddMemberResponse' 4XX: description: failed_operation content: @@ -5316,17 +5078,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5338,42 +5100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: title: '_t__TeamAddMember::SEO::TITLE' @@ -5392,8 +5149,8 @@ paths: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamCreateRequest' responses: '200': description: 'successful operation' @@ -5409,8 +5166,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + example: + $ref: '#/components/examples/TeamCreateResponse' 4XX: description: failed_operation content: @@ -5419,15 +5176,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5439,42 +5196,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: title: '_t__TeamCreate::SEO::TITLE' @@ -5504,15 +5256,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5524,42 +5276,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: title: '_t__TeamDelete::SEO::TITLE' @@ -5586,8 +5333,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' + example: + $ref: '#/components/examples/TeamGetResponse' 4XX: description: failed_operation content: @@ -5596,17 +5343,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5618,42 +5365,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/TeamGetExample.sh x-meta: seo: title: '_t__TeamGet::SEO::TITLE' @@ -5671,8 +5413,8 @@ paths: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: '200': description: 'successful operation' @@ -5688,8 +5430,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + example: + $ref: '#/components/examples/TeamUpdateResponse' 4XX: description: failed_operation content: @@ -5698,15 +5440,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5718,42 +5460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: title: '_t__TeamUpdate::SEO::TITLE' @@ -5789,8 +5526,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + example: + $ref: '#/components/examples/TeamGetInfoResponse' 4XX: description: failed_operation content: @@ -5799,19 +5536,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5823,42 +5560,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: title: '_t__TeamInfo::SEO::TITLE' @@ -5893,8 +5625,8 @@ paths: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' + example: + $ref: '#/components/examples/TeamInvitesResponse' 4XX: description: failed_operation content: @@ -5903,15 +5635,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5924,42 +5656,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: title: '_t__TeamInvites::SEO::TITLE' @@ -6011,8 +5738,8 @@ paths: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + example: + $ref: '#/components/examples/TeamMembersResponse' 4XX: description: failed_operation content: @@ -6021,19 +5748,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6045,42 +5772,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: title: '_t__TeamMembers::SEO::TITLE' @@ -6099,10 +5821,10 @@ paths: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: '201': description: 'successful operation' @@ -6118,8 +5840,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' 4XX: description: failed_operation content: @@ -6128,17 +5850,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6150,42 +5872,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: title: '_t__TeamRemoveMember::SEO::TITLE' @@ -6237,8 +5954,8 @@ paths: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + example: + $ref: '#/components/examples/TeamSubTeamsResponse' 4XX: description: failed_operation content: @@ -6247,19 +5964,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6271,42 +5988,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: title: '_t__TeamSubTeams::SEO::TITLE' @@ -6334,8 +6046,8 @@ paths: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: '200': description: 'successful operation' @@ -6351,8 +6063,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + example: + $ref: '#/components/examples/TemplateAddUserResponse' 4XX: description: failed_operation content: @@ -6361,17 +6073,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6383,42 +6095,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: title: '_t__TemplateAddUser::SEO::TITLE' @@ -6437,14 +6144,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' @@ -6463,8 +6170,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + example: + $ref: '#/components/examples/TemplateCreateResponse' 4XX: description: failed_operation content: @@ -6473,19 +6180,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6497,42 +6204,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: title: '_t__TemplateCreate::SEO::TITLE' @@ -6551,14 +6253,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' @@ -6577,8 +6279,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' 4XX: description: failed_operation content: @@ -6587,19 +6289,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6611,42 +6313,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: title: '_t__TemplateCreateEmbeddedDraft::SEO::TITLE' @@ -6687,19 +6384,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6711,42 +6408,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: title: '_t__TemplateDelete::SEO::TITLE' @@ -6803,23 +6495,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6831,42 +6523,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' @@ -6902,8 +6589,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' 4XX: description: failed_operation content: @@ -6912,23 +6599,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6940,42 +6627,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' @@ -7018,8 +6700,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' 4XX: description: failed_operation content: @@ -7028,23 +6710,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7056,42 +6738,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: title: '_t__TemplateFiles::SEO::TITLE' @@ -7127,8 +6804,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + example: + $ref: '#/components/examples/TemplateGetResponse' 4XX: description: failed_operation content: @@ -7137,19 +6814,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7161,42 +6838,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: title: '_t__TemplateGet::SEO::TITLE' @@ -7252,8 +6924,8 @@ paths: schema: $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + example: + $ref: '#/components/examples/TemplateListResponse' 4XX: description: failed_operation content: @@ -7262,19 +6934,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7286,42 +6958,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateListExample.sh x-meta: seo: title: '_t__TemplateList::SEO::TITLE' @@ -7349,8 +7016,8 @@ paths: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: '200': description: 'successful operation' @@ -7366,8 +7033,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' 4XX: description: failed_operation content: @@ -7376,17 +7043,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7398,42 +7065,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: title: '_t__TemplateRemoveUser::SEO::TITLE' @@ -7461,8 +7123,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' @@ -7481,8 +7143,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' 4XX: description: failed_operation content: @@ -7491,21 +7153,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7517,42 +7179,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateUpdateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateUpdateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateUpdateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateUpdateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateUpdateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: title: '_t__TemplateUpdateFiles::SEO::TITLE' @@ -7571,14 +7228,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' @@ -7597,8 +7254,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' 4XX: description: failed_operation content: @@ -7607,15 +7264,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7627,42 +7284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/UnclaimedDraftCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: title: '_t__UnclaimedDraftCreate::SEO::TITLE' @@ -7681,14 +7333,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' @@ -7707,8 +7359,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' 4XX: description: failed_operation content: @@ -7717,19 +7369,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7742,42 +7394,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: title: '_t__UnclaimedDraftCreateEmbedded::SEO::TITLE' @@ -7796,8 +7443,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' @@ -7816,8 +7463,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' 4XX: description: failed_operation content: @@ -7826,21 +7473,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7852,42 +7499,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: '_t__UnclaimedDraftCreateEmbeddedWithTemplate::SEO::TITLE' @@ -7915,8 +7557,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' responses: '200': description: 'successful operation' @@ -7932,8 +7574,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' 4XX: description: failed_operation content: @@ -7942,21 +7584,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7969,42 +7611,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftEditAndResendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftEditAndResendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftEditAndResendExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftEditAndResendExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftEditAndResendExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftEditAndResendExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: title: '_t__UnclaimedDraftEditAndResend::SEO::TITLE' @@ -13171,522 +12808,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditRequestDefaultExample.json - SignatureRequestEditRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json - SignatureRequestEditEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: '_t__AccountCreateResponseExample::SUMMARY' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: '_t__AccountCreateOAuthResponseExample::SUMMARY' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: '_t__AccountGetResponseExample::SUMMARY' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: '_t__AccountVerifyFoundResponseExample::SUMMARY' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: '_t__AccountVerifyNotFoundResponseExample::SUMMARY' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: '_t__ApiAppGetResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: '_t__ApiAppListResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: '_t__BulkSendJobGetResponseExample::SUMMARY' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: '_t__BulkSendJobListResponseExample::SUMMARY' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: '_t__EmbeddedEditUrlResponseExample::SUMMARY' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: '_t__EmbeddedSignUrlResponseExample::SUMMARY' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: '_t__Error::400' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: '_t__Error::401' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: '_t__Error::402' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: '_t__Error::403' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: '_t__Error::404' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: '_t__Error::409' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: '_t__Error::410' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: '_t__Error::422' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: '_t__Error::429' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: '_t__Error::4XX' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: '_t__FaxGetResponseExample::SUMMARY' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: '_t__FaxLineResponseExample::SUMMARY' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: '_t__FaxLineAreaCodeGetResponseExample::SUMMARY' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: '_t__FaxLineListResponseExample::SUMMARY' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: summary: '_t__FaxListResponseExample::SUMMARY' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: '_t__ReportCreateResponseExample::SUMMARY' value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: '_t__SignatureRequestGetResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: '_t__SignatureRequestListResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: '_t__AccountUpdateResponseExample::SUMMARY' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: '_t__OAuthTokenGenerateResponseExample::SUMMARY' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: '_t__OAuthTokenRefreshResponseExample::SUMMARY' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: '_t__ApiAppCreateResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: '_t__ApiAppUpdateResponseExample::SUMMARY' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: '_t__SignatureRequestCreateEmbeddedResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: '_t__SignatureRequestCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: '_t__SignatureRequestFilesResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: '_t__SignatureRequestReleaseHoldResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: '_t__SignatureRequestRemindResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: '_t__SignatureRequestSendResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: '_t__SignatureRequestSendWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: '_t__SignatureRequestUpdateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: '_t__SignatureRequestBulkSendWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: '_t__SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: '_t__TeamCreateResponseExample::SUMMARY' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: '_t__TeamMembersResponseExample::SUMMARY' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: '_t__TeamRemoveMemberResponseExample::SUMMARY' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: '_t__TeamUpdateResponseExample::SUMMARY' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: '_t__TeamDoesNotExistResponseExample::SUMMARY' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: '_t__TemplateAddUserResponseExample::SUMMARY' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: '_t__TemplateFilesResponseExample::SUMMARY' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: '_t__TemplateRemoveUserResponseExample::SUMMARY' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: '_t__UnclaimedDraftCreateEmbeddedResponseExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: '_t__UnclaimedDraftCreateEmbeddedWithTemplateResponseExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: '_t__UnclaimedDraftEditAndResendExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: '_t__TeamGetResponseExample::SUMMARY' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: '_t__TeamInfoResponseExample::SUMMARY' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: '_t__TeamInvitesResponseExample::SUMMARY' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: '_t__TeamAddMemberResponseExample::SUMMARY' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: '_t__TeamSubTeamsResponseExample::SUMMARY' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: '_t__TemplateCreateResponseExample::SUMMARY' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: '_t__TemplateCreateEmbeddedDraftResponseExample::SUMMARY' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: '_t__TemplateGetResponseExample::SUMMARY' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: '_t__TemplateListResponseExample::SUMMARY' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: '_t__TemplateUpdateFilesResponseExample::SUMMARY' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: '_t__UnclaimedDraftCreateResponseExample::SUMMARY' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: '_t__EventCallbackAccountSignatureRequestSentExample::SUMMARY' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: '_t__EventCallbackAccountTemplateCreatedExample::SUMMARY' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: '_t__EventCallbackAppAccountConfirmedExample::SUMMARY' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: '_t__EventCallbackAppSignatureRequestSentExample::SUMMARY' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: '_t__EventCallbackAppTemplateCreatedExample::SUMMARY' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: '_t__EventCallbackAccountRequest::DESCRIPTION' @@ -13696,9 +13333,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: '_t__EventCallbackAppRequest::DESCRIPTION' content: @@ -13707,11 +13344,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: '_t__Common::RateLimiting::LIMIT' @@ -13744,6 +13381,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -13807,37 +13445,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -13859,37 +13492,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 8b67ae6a9..a3615bf24 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -27,10 +27,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: '200': description: 'successful operation' @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' '4XX': description: failed_operation content: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -161,8 +156,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' + example: + $ref: '#/components/examples/AccountGetResponse' '4XX': description: failed_operation content: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,8 +235,8 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: '200': description: 'successful operation' @@ -262,8 +252,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' + example: + $ref: '#/components/examples/AccountUpdateResponse' '4XX': description: failed_operation content: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,8 +333,8 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: '200': description: 'successful operation' @@ -365,10 +350,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' '4XX': description: failed_operation content: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,8 +431,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' @@ -471,8 +451,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' + example: + $ref: '#/components/examples/ApiAppCreateResponse' '4XX': description: failed_operation content: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -574,8 +549,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' + example: + $ref: '#/components/examples/ApiAppGetResponse' '4XX': description: failed_operation content: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,8 +640,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' @@ -690,8 +660,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' + example: + $ref: '#/components/examples/ApiAppUpdateResponse' '4XX': description: failed_operation content: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -896,8 +856,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' + example: + $ref: '#/components/examples/ApiAppListResponse' '4XX': description: failed_operation content: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -1011,8 +966,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' + example: + $ref: '#/components/examples/BulkSendJobGetResponse' '4XX': description: failed_operation content: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1119,8 +1069,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' + example: + $ref: '#/components/examples/BulkSendJobListResponse' '4XX': description: failed_operation content: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,8 +1158,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: '200': description: 'successful operation' @@ -1230,8 +1175,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' '4XX': description: failed_operation content: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1333,8 +1273,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' '4XX': description: failed_operation content: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1440,8 +1375,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,42 +1406,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,42 +1592,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' @@ -1721,8 +1641,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: '200': description: 'successful operation' @@ -1738,8 +1658,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1826,6 +1741,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -1925,8 +1841,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' '4XX': description: failed_operation content: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,42 +1868,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' @@ -2006,8 +1917,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: '200': description: 'successful operation' @@ -2023,8 +1934,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2107,6 +2013,7 @@ paths: required: true schema: type: string + example: 123-123-1234 responses: '200': description: 'successful operation' @@ -2122,8 +2029,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,42 +2058,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2204,8 +2106,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: '200': description: 'successful operation' @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,7 +2196,7 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2307,7 +2204,7 @@ paths: schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query @@ -2315,7 +2212,7 @@ paths: schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query @@ -2337,8 +2234,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + example: + $ref: '#/components/examples/FaxLineListResponse' '4XX': description: failed_operation content: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2418,8 +2310,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: '200': description: 'successful operation' @@ -2435,8 +2327,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2546,8 +2433,8 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' + example: + $ref: '#/components/examples/FaxListResponse' '4XX': description: failed_operation content: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2627,8 +2509,8 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' @@ -2647,8 +2529,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,42 +2560,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: title: 'Send Fax | API Documentation | Dropbox Fax for Developers' @@ -2732,8 +2609,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: '200': description: 'successful operation' @@ -2749,8 +2626,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' '4XX': description: failed_operation content: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,8 +2704,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: '200': description: 'successful operation' @@ -2849,8 +2721,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' '4XX': description: failed_operation content: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,8 +2802,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: '200': description: 'successful operation' @@ -2952,8 +2819,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' + example: + $ref: '#/components/examples/ReportCreateResponse' '4XX': description: failed_operation content: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,8 +2898,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' @@ -3056,8 +2918,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,8 +3003,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' @@ -3166,8 +3023,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,10 +3212,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' @@ -3387,8 +3234,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,8 +3317,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' @@ -3495,8 +3337,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,42 +3371,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' @@ -3595,10 +3432,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditRequest' @@ -3617,8 +3454,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditResponse' '4XX': description: failed_operation content: @@ -3627,21 +3464,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,42 +3491,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEdit.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEdit.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEdit.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEdit.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEdit.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEdit.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEdit.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEdit.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' @@ -3719,10 +3551,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' @@ -3741,8 +3573,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedResponse' '4XX': description: failed_operation content: @@ -3751,21 +3583,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3777,42 +3609,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbedded.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbedded.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbedded.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbedded.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbedded.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbedded.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbedded.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' @@ -3842,8 +3669,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' @@ -3862,8 +3689,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3872,21 +3699,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3898,42 +3725,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' @@ -3966,8 +3788,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' @@ -3986,8 +3808,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestEditWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateResponse' '4XX': description: failed_operation content: @@ -3996,21 +3818,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4023,42 +3845,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestEditWithTemplate.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestEditWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestEditWithTemplate.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestEditWithTemplate.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestEditWithTemplate.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestEditWithTemplate.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestEditWithTemplate.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestEditWithTemplate.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' @@ -4121,23 +3938,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4150,42 +3967,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -4224,8 +4036,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -4234,23 +4046,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4263,42 +4075,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -4344,8 +4151,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -4354,23 +4161,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4383,42 +4190,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -4454,8 +4256,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + example: + $ref: '#/components/examples/SignatureRequestGetResponse' '4XX': description: failed_operation content: @@ -4464,19 +4266,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4489,42 +4291,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' @@ -4582,8 +4379,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + example: + $ref: '#/components/examples/SignatureRequestListResponse' '4XX': description: failed_operation content: @@ -4592,17 +4389,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4615,42 +4412,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: title: 'List Signature Requests | REST API | Dropbox Sign for Developers' @@ -4686,8 +4478,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' '4XX': description: failed_operation content: @@ -4696,17 +4488,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4718,42 +4510,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' @@ -4784,8 +4571,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: '200': description: 'successful operation' @@ -4801,8 +4588,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' '4XX': description: failed_operation content: @@ -4811,23 +4598,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4840,42 +4627,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' @@ -4921,21 +4703,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4944,42 +4726,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: title: 'Remove Signature Request Access | Dropbox Sign for Developers' @@ -4998,10 +4775,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' @@ -5020,8 +4797,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendResponse' '4XX': description: failed_operation content: @@ -5030,19 +4807,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5055,42 +4832,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: title: 'Send Signature Request | REST API | Dropbox Sign for Developers' @@ -5109,8 +4881,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' @@ -5129,8 +4901,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -5139,17 +4911,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5162,42 +4934,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: title: 'Send with Template | API Documentation | Dropbox Sign for Developers' @@ -5230,8 +4997,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: '200': description: 'successful operation' @@ -5247,8 +5014,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' '4XX': description: failed_operation content: @@ -5257,17 +5024,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5279,42 +5046,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: title: 'Update Signature Request | REST API | Dropbox Sign for Developers' @@ -5342,10 +5104,10 @@ paths: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: '200': description: 'successful operation' @@ -5361,8 +5123,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + example: + $ref: '#/components/examples/TeamAddMemberResponse' '4XX': description: failed_operation content: @@ -5371,17 +5133,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5393,42 +5155,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' @@ -5447,8 +5204,8 @@ paths: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamCreateRequest' responses: '200': description: 'successful operation' @@ -5464,8 +5221,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + example: + $ref: '#/components/examples/TeamCreateResponse' '4XX': description: failed_operation content: @@ -5474,15 +5231,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5494,42 +5251,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' @@ -5559,15 +5311,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5579,42 +5331,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' @@ -5641,8 +5388,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' + example: + $ref: '#/components/examples/TeamGetResponse' '4XX': description: failed_operation content: @@ -5651,17 +5398,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5673,42 +5420,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/TeamGetExample.sh x-meta: seo: title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' @@ -5726,8 +5468,8 @@ paths: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: '200': description: 'successful operation' @@ -5743,8 +5485,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + example: + $ref: '#/components/examples/TeamUpdateResponse' '4XX': description: failed_operation content: @@ -5753,15 +5495,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5773,42 +5515,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: title: 'Update Team | API Documentation | Dropbox Sign for Developers' @@ -5844,8 +5581,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + example: + $ref: '#/components/examples/TeamGetInfoResponse' '4XX': description: failed_operation content: @@ -5854,19 +5591,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5878,42 +5615,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: title: 'Get Team Info | Dropbox Sign for Developers' @@ -5948,8 +5680,8 @@ paths: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' + example: + $ref: '#/components/examples/TeamInvitesResponse' '4XX': description: failed_operation content: @@ -5958,15 +5690,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5979,42 +5711,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: title: 'List Team Invites | Dropbox Sign for Developers' @@ -6066,8 +5793,8 @@ paths: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + example: + $ref: '#/components/examples/TeamMembersResponse' '4XX': description: failed_operation content: @@ -6076,19 +5803,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6100,42 +5827,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: title: 'List Team Members | Dropbox Sign for Developers' @@ -6154,10 +5876,10 @@ paths: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: '201': description: 'successful operation' @@ -6173,8 +5895,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' '4XX': description: failed_operation content: @@ -6183,17 +5905,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6205,42 +5927,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: title: 'Remove User from Team | REST API | Dropbox Sign for Developers' @@ -6292,8 +6009,8 @@ paths: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + example: + $ref: '#/components/examples/TeamSubTeamsResponse' '4XX': description: failed_operation content: @@ -6302,19 +6019,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6326,42 +6043,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: title: 'List Sub Teams | Dropbox Sign for Developers' @@ -6389,8 +6101,8 @@ paths: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: '200': description: 'successful operation' @@ -6406,8 +6118,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + example: + $ref: '#/components/examples/TemplateAddUserResponse' '4XX': description: failed_operation content: @@ -6416,17 +6128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6438,42 +6150,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: title: 'Add User to Template | REST API | Dropbox Sign for Developers' @@ -6492,14 +6199,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' @@ -6518,8 +6225,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + example: + $ref: '#/components/examples/TemplateCreateResponse' '4XX': description: failed_operation content: @@ -6528,19 +6235,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6552,42 +6259,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: title: 'Create Template | Dropbox Sign for Developers' @@ -6606,14 +6308,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' @@ -6632,8 +6334,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' '4XX': description: failed_operation content: @@ -6642,19 +6344,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6666,42 +6368,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: title: 'Create Embedded Template Draft | Dropbox Sign for Developers' @@ -6742,19 +6439,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6766,42 +6463,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: title: 'Delete Template | API Documentation | Dropbox Sign for Developers' @@ -6861,23 +6553,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6889,42 +6581,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6963,8 +6650,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -6973,23 +6660,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7001,42 +6688,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -7082,8 +6764,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -7092,23 +6774,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7120,42 +6802,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -7191,8 +6868,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + example: + $ref: '#/components/examples/TemplateGetResponse' '4XX': description: failed_operation content: @@ -7201,19 +6878,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7225,42 +6902,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: title: 'Get Template | API Documentation | Dropbox Sign for Developers' @@ -7319,8 +6991,8 @@ paths: schema: $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + example: + $ref: '#/components/examples/TemplateListResponse' '4XX': description: failed_operation content: @@ -7329,19 +7001,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7353,42 +7025,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateListExample.sh x-meta: seo: title: 'List Templates | API Documentation | Dropbox Sign for Developers' @@ -7416,8 +7083,8 @@ paths: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: '200': description: 'successful operation' @@ -7433,8 +7100,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' '4XX': description: failed_operation content: @@ -7443,17 +7110,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7465,42 +7132,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: title: 'Remove User from Template | REST API | Dropbox Sign for Developers' @@ -7540,8 +7202,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' @@ -7560,8 +7222,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' '4XX': description: failed_operation content: @@ -7570,21 +7232,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7596,42 +7258,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateUpdateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateUpdateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateUpdateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateUpdateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateUpdateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: title: 'Update Template Files | REST API | Dropbox Sign for Developers' @@ -7650,14 +7307,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' @@ -7676,8 +7333,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' '4XX': description: failed_operation content: @@ -7686,15 +7343,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7706,42 +7363,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/UnclaimedDraftCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' @@ -7763,14 +7415,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' @@ -7789,8 +7441,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -7799,19 +7451,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7824,42 +7476,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' @@ -7881,8 +7528,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' @@ -7901,8 +7548,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -7911,21 +7558,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7937,42 +7584,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' @@ -8003,8 +7645,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' responses: '200': description: 'successful operation' @@ -8020,8 +7662,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' '4XX': description: failed_operation content: @@ -8030,21 +7672,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -8057,42 +7699,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftEditAndResendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftEditAndResendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftEditAndResendExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftEditAndResendExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftEditAndResendExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftEditAndResendExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' @@ -14089,522 +13726,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditRequestDefaultExample.json - SignatureRequestEditRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json - SignatureRequestEditEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -14616,9 +14253,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -14629,11 +14266,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -14670,6 +14307,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -14697,37 +14335,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -14750,37 +14383,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/openapi.yaml b/openapi.yaml index 5643bcbfb..e8f8b5b24 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -27,10 +27,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: '200': description: 'successful operation' @@ -46,10 +46,10 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' '4XX': description: failed_operation content: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -161,8 +156,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' + example: + $ref: '#/components/examples/AccountGetResponse' '4XX': description: failed_operation content: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,8 +235,8 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: '200': description: 'successful operation' @@ -262,8 +252,8 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' + example: + $ref: '#/components/examples/AccountUpdateResponse' '4XX': description: failed_operation content: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,8 +333,8 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: '200': description: 'successful operation' @@ -365,10 +350,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' '4XX': description: failed_operation content: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,8 +431,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' @@ -471,8 +451,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' + example: + $ref: '#/components/examples/ApiAppCreateResponse' '4XX': description: failed_operation content: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -574,8 +549,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' + example: + $ref: '#/components/examples/ApiAppGetResponse' '4XX': description: failed_operation content: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,8 +640,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' @@ -690,8 +660,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' + example: + $ref: '#/components/examples/ApiAppUpdateResponse' '4XX': description: failed_operation content: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -896,8 +856,8 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' + example: + $ref: '#/components/examples/ApiAppListResponse' '4XX': description: failed_operation content: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -1011,8 +966,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' + example: + $ref: '#/components/examples/BulkSendJobGetResponse' '4XX': description: failed_operation content: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1119,8 +1069,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' + example: + $ref: '#/components/examples/BulkSendJobListResponse' '4XX': description: failed_operation content: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,8 +1158,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: '200': description: 'successful operation' @@ -1230,8 +1175,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' '4XX': description: failed_operation content: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1333,8 +1273,8 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' '4XX': description: failed_operation content: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1440,8 +1375,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,42 +1406,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,42 +1592,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' @@ -1721,8 +1641,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: '200': description: 'successful operation' @@ -1738,8 +1658,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1826,6 +1741,7 @@ paths: - CA - US - UK + example: US - name: state in: query @@ -1925,8 +1841,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' '4XX': description: failed_operation content: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,42 +1868,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' @@ -2006,8 +1917,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: '200': description: 'successful operation' @@ -2023,8 +1934,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2107,6 +2013,7 @@ paths: required: true schema: type: string + example: 123-123-1234 responses: '200': description: 'successful operation' @@ -2122,8 +2029,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,42 +2058,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2204,8 +2106,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: '200': description: 'successful operation' @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,7 +2196,7 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query @@ -2307,7 +2204,7 @@ paths: schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query @@ -2315,7 +2212,7 @@ paths: schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query @@ -2337,8 +2234,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' + example: + $ref: '#/components/examples/FaxLineListResponse' '4XX': description: failed_operation content: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2418,8 +2310,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: '200': description: 'successful operation' @@ -2435,8 +2327,8 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' + example: + $ref: '#/components/examples/FaxLineResponse' '4XX': description: failed_operation content: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2546,8 +2433,8 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' + example: + $ref: '#/components/examples/FaxListResponse' '4XX': description: failed_operation content: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2627,8 +2509,8 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' @@ -2647,8 +2529,8 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' + example: + $ref: '#/components/examples/FaxGetResponse' '4XX': description: failed_operation content: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,42 +2560,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: title: 'Send Fax | API Documentation | Dropbox Fax for Developers' @@ -2732,8 +2609,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: '200': description: 'successful operation' @@ -2749,8 +2626,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' '4XX': description: failed_operation content: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,8 +2704,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: '200': description: 'successful operation' @@ -2849,8 +2721,8 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' '4XX': description: failed_operation content: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,8 +2802,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: '200': description: 'successful operation' @@ -2952,8 +2819,8 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' + example: + $ref: '#/components/examples/ReportCreateResponse' '4XX': description: failed_operation content: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,8 +2898,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' @@ -3056,8 +2918,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,8 +3003,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' @@ -3166,8 +3023,8 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,10 +3212,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' @@ -3387,8 +3234,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,8 +3317,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' @@ -3495,8 +3337,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,42 +3371,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' @@ -3625,23 +3462,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,42 +3491,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -3728,8 +3560,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -3738,23 +3570,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3767,42 +3599,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -3848,8 +3675,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' '4XX': description: failed_operation content: @@ -3858,23 +3685,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3887,42 +3714,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: title: 'Download Files | API Documentation | Dropbox Sign for Developers' @@ -3958,8 +3780,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' + example: + $ref: '#/components/examples/SignatureRequestGetResponse' '4XX': description: failed_operation content: @@ -3968,19 +3790,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,42 +3815,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' @@ -4086,8 +3903,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' + example: + $ref: '#/components/examples/SignatureRequestListResponse' '4XX': description: failed_operation content: @@ -4096,17 +3913,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4119,42 +3936,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: title: 'List Signature Requests | REST API | Dropbox Sign for Developers' @@ -4190,8 +4002,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' '4XX': description: failed_operation content: @@ -4200,17 +4012,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4222,42 +4034,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' @@ -4288,8 +4095,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: '200': description: 'successful operation' @@ -4305,8 +4112,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' '4XX': description: failed_operation content: @@ -4315,23 +4122,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,42 +4151,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' @@ -4425,21 +4227,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4448,42 +4250,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: title: 'Remove Signature Request Access | Dropbox Sign for Developers' @@ -4502,10 +4299,10 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendRequest' @@ -4524,8 +4321,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendResponse' '4XX': description: failed_operation content: @@ -4534,19 +4331,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4559,42 +4356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: title: 'Send Signature Request | REST API | Dropbox Sign for Developers' @@ -4613,8 +4405,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' @@ -4633,8 +4425,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' '4XX': description: failed_operation content: @@ -4643,17 +4435,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4666,42 +4458,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: title: 'Send with Template | API Documentation | Dropbox Sign for Developers' @@ -4734,8 +4521,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestUpdateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: '200': description: 'successful operation' @@ -4751,8 +4538,8 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' '4XX': description: failed_operation content: @@ -4761,17 +4548,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4783,42 +4570,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: title: 'Update Signature Request | REST API | Dropbox Sign for Developers' @@ -4846,10 +4628,10 @@ paths: schema: $ref: '#/components/schemas/TeamAddMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: '200': description: 'successful operation' @@ -4865,8 +4647,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' + example: + $ref: '#/components/examples/TeamAddMemberResponse' '4XX': description: failed_operation content: @@ -4875,17 +4657,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4897,42 +4679,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' @@ -4951,8 +4728,8 @@ paths: schema: $ref: '#/components/schemas/TeamCreateRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamCreateRequest' responses: '200': description: 'successful operation' @@ -4968,8 +4745,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' + example: + $ref: '#/components/examples/TeamCreateResponse' '4XX': description: failed_operation content: @@ -4978,15 +4755,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4998,42 +4775,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' @@ -5063,15 +4835,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5083,42 +4855,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' @@ -5145,8 +4912,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' + example: + $ref: '#/components/examples/TeamGetResponse' '4XX': description: failed_operation content: @@ -5155,17 +4922,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5177,42 +4944,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/TeamGetExample.sh x-meta: seo: title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' @@ -5230,8 +4992,8 @@ paths: schema: $ref: '#/components/schemas/TeamUpdateRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: '200': description: 'successful operation' @@ -5247,8 +5009,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' + example: + $ref: '#/components/examples/TeamUpdateResponse' '4XX': description: failed_operation content: @@ -5257,15 +5019,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5277,42 +5039,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: title: 'Update Team | API Documentation | Dropbox Sign for Developers' @@ -5348,8 +5105,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' + example: + $ref: '#/components/examples/TeamGetInfoResponse' '4XX': description: failed_operation content: @@ -5358,19 +5115,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5382,42 +5139,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: title: 'Get Team Info | Dropbox Sign for Developers' @@ -5452,8 +5204,8 @@ paths: schema: $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' + example: + $ref: '#/components/examples/TeamInvitesResponse' '4XX': description: failed_operation content: @@ -5462,15 +5214,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5483,42 +5235,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: title: 'List Team Invites | Dropbox Sign for Developers' @@ -5570,8 +5317,8 @@ paths: schema: $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' + example: + $ref: '#/components/examples/TeamMembersResponse' '4XX': description: failed_operation content: @@ -5580,19 +5327,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5604,42 +5351,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: title: 'List Team Members | Dropbox Sign for Developers' @@ -5658,10 +5400,10 @@ paths: schema: $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: '201': description: 'successful operation' @@ -5677,8 +5419,8 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' '4XX': description: failed_operation content: @@ -5687,17 +5429,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5709,42 +5451,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: title: 'Remove User from Team | REST API | Dropbox Sign for Developers' @@ -5796,8 +5533,8 @@ paths: schema: $ref: '#/components/schemas/TeamSubTeamsResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' + example: + $ref: '#/components/examples/TeamSubTeamsResponse' '4XX': description: failed_operation content: @@ -5806,19 +5543,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5830,42 +5567,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: title: 'List Sub Teams | Dropbox Sign for Developers' @@ -5893,8 +5625,8 @@ paths: schema: $ref: '#/components/schemas/TemplateAddUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: '200': description: 'successful operation' @@ -5910,8 +5642,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' + example: + $ref: '#/components/examples/TemplateAddUserResponse' '4XX': description: failed_operation content: @@ -5920,17 +5652,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5942,42 +5674,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: title: 'Add User to Template | REST API | Dropbox Sign for Developers' @@ -5996,14 +5723,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateRequest' @@ -6022,8 +5749,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' + example: + $ref: '#/components/examples/TemplateCreateResponse' '4XX': description: failed_operation content: @@ -6032,19 +5759,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6056,42 +5783,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: title: 'Create Template | Dropbox Sign for Developers' @@ -6110,14 +5832,14 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' @@ -6136,8 +5858,8 @@ paths: schema: $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' '4XX': description: failed_operation content: @@ -6146,19 +5868,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6170,42 +5892,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: title: 'Create Embedded Template Draft | Dropbox Sign for Developers' @@ -6246,19 +5963,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6270,42 +5987,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: title: 'Delete Template | API Documentation | Dropbox Sign for Developers' @@ -6365,23 +6077,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6393,42 +6105,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6467,8 +6174,8 @@ paths: schema: $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -6477,23 +6184,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6505,42 +6212,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6586,8 +6288,8 @@ paths: schema: $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateFilesResponse' '4XX': description: failed_operation content: @@ -6596,23 +6298,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 422_example: - $ref: '#/components/examples/Error422ResponseExample' + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6624,42 +6326,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' @@ -6695,8 +6392,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' + example: + $ref: '#/components/examples/TemplateGetResponse' '4XX': description: failed_operation content: @@ -6705,19 +6402,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6729,42 +6426,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: title: 'Get Template | API Documentation | Dropbox Sign for Developers' @@ -6823,8 +6515,8 @@ paths: schema: $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' + example: + $ref: '#/components/examples/TemplateListResponse' '4XX': description: failed_operation content: @@ -6833,19 +6525,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6857,42 +6549,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateListExample.sh x-meta: seo: title: 'List Templates | API Documentation | Dropbox Sign for Developers' @@ -6920,8 +6607,8 @@ paths: schema: $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: '200': description: 'successful operation' @@ -6937,8 +6624,8 @@ paths: schema: $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' '4XX': description: failed_operation content: @@ -6947,17 +6634,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6969,42 +6656,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: title: 'Remove User from Template | REST API | Dropbox Sign for Developers' @@ -7044,8 +6726,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' multipart/form-data: schema: $ref: '#/components/schemas/TemplateUpdateFilesRequest' @@ -7064,8 +6746,8 @@ paths: schema: $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' '4XX': description: failed_operation content: @@ -7074,21 +6756,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7100,42 +6782,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateUpdateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateUpdateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateUpdateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateUpdateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateUpdateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateUpdateFilesExample.sh x-meta: seo: title: 'Update Template Files | REST API | Dropbox Sign for Developers' @@ -7154,14 +6831,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateRequest' @@ -7180,8 +6857,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' '4XX': description: failed_operation content: @@ -7190,15 +6867,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7210,42 +6887,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/UnclaimedDraftCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' @@ -7267,14 +6939,14 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' @@ -7293,8 +6965,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' '4XX': description: failed_operation content: @@ -7303,19 +6975,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7328,42 +7000,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' @@ -7385,8 +7052,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' @@ -7405,8 +7072,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' '4XX': description: failed_operation content: @@ -7415,21 +7082,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7441,42 +7108,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' @@ -7507,8 +7169,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' responses: '200': description: 'successful operation' @@ -7524,8 +7186,8 @@ paths: schema: $ref: '#/components/schemas/UnclaimedDraftCreateResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' '4XX': description: failed_operation content: @@ -7534,21 +7196,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7561,42 +7223,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/UnclaimedDraftEditAndResendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftEditAndResendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftEditAndResendExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftEditAndResendExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftEditAndResendExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftEditAndResendExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftEditAndResendExample.sh x-meta: seo: title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' @@ -13571,522 +13228,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditRequestDefaultExample.json - SignatureRequestEditRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestDefaultExample.json - SignatureRequestEditEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSignersExample.json - SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestEditWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestEditWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -14098,9 +13755,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -14111,11 +13768,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -14152,6 +13809,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -14228,37 +13886,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -14281,37 +13934,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/sandbox/.gitignore b/sandbox/.gitignore index 36ef23211..bae462a8a 100644 --- a/sandbox/.gitignore +++ b/sandbox/.gitignore @@ -1,45 +1 @@ -dotnet/* -!dotnet/.gitignore -!dotnet/hellosign_sandbox.csproj -!dotnet/NuGet.Config -!dotnet/Program.cs -!dotnet/src -!dotnet/test_fixtures - -java-v1/* -!java-v1/pom.xml -!java-v1/src -java-v1/src/main/java/com/dropbox/sign_sandbox/* -!java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java -!java-v1/test_fixtures - -java-v2/* -!java-v2/pom.xml -!java-v2/src -java-v2/src/main/java/com/dropbox/sign_sandbox/* -!java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java -!java-v2/test_fixtures - -node/* -!node/Example.ts -!node/package.json -!node/tests -!node/test_fixtures - -php/* -!php/composer.json -!php/Example.php -!php/test -!php/test_fixtures - -python/* -!python/Example.py -!python/requirements.txt -!python/tests -!python/test_fixtures - -ruby/* -!ruby/Example.rb -!ruby/Gemfile -!ruby/spec -!ruby/test_fixtures +**/artifacts/ diff --git a/sandbox/dotnet/Dropbox.SignSandbox.sln b/sandbox/dotnet/Dropbox.SignSandbox.sln new file mode 100644 index 000000000..359701322 --- /dev/null +++ b/sandbox/dotnet/Dropbox.SignSandbox.sln @@ -0,0 +1,21 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 2012 +VisualStudioVersion = 12.0.0.0 +MinimumVisualStudioVersion = 10.0.0.1 +Project("{7045D429-F203-4317-A29F-FB9FD34B7FF9}") = "Dropbox.SignSandbox", "src\Dropbox.SignSandbox\Dropbox.SignSandbox.csproj", "{F8C8232D-7020-4603-8E04-18D060AE530B}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {F8C8232D-7020-4603-8E04-18D060AE530B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F8C8232D-7020-4603-8E04-18D060AE530B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F8C8232D-7020-4603-8E04-18D060AE530B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F8C8232D-7020-4603-8E04-18D060AE530B}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj deleted file mode 100644 index 4f8b41f9d..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/Dropbox.SignSandbox.Test.csproj +++ /dev/null @@ -1,24 +0,0 @@ - - - - Dropbox.SignSandbox.Test - Dropbox.SignSandbox.Test - net6.0 - false - Dropbox.SignSandbox.Test - - - - - - - - - - - - - - - - diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs b/sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs deleted file mode 100644 index 2350a526b..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox.Test/SignatureRequestTests.cs +++ /dev/null @@ -1,168 +0,0 @@ -using System; -using System.Collections.Generic; -using System.IO; -using System.Reflection; -using Xunit; -using Dropbox.Sign; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; - -namespace Dropbox.SignSandbox.Test -{ - public class TestHelper - { - public static JObject GetJsonContents(string fileName) - { - using (var r = new StreamReader( $"./../../../../../{fileName}")) - { - dynamic json = JsonConvert.DeserializeObject(r.ReadToEnd()); - Assert.NotNull(json); - - return json; - } - } - - public static JObject GetConfig() - { - dynamic configCustom = GetJsonContents("src/Dropbox.SignSandbox.Test/.config.json"); - dynamic configDist = GetJsonContents("src/Dropbox.SignSandbox.Test/.config.dist.json"); - - var mergeSettings = new JsonMergeSettings - { - MergeArrayHandling = MergeArrayHandling.Union - }; - - configDist.Merge(configCustom, mergeSettings); - - return configDist; - } - } - - public class SignatureRequestTests - { - [Fact] - public void SendTest() - { - dynamic config_merged = TestHelper.GetConfig(); - - var config = new Sign.Client.Configuration(); - config.Username = config_merged["API_KEY"]; - config.BasePath = config_merged["BASE_URL"]; - - var signatureRequestApi = new Sign.Api.SignatureRequestApi(config); - - var data = TestHelper.GetJsonContents("test_fixtures/SignatureRequestSendRequest.json"); - - var sendRequest = Sign.Model.SignatureRequestSendRequest.Init(data.ToString()); - - sendRequest.Files = new List { - new FileStream( - "./../../../../../test_fixtures/pdf-sample.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var sendResponse = signatureRequestApi.SignatureRequestSend(sendRequest); - - Assert.Equal( - sendRequest.FormFieldsPerDocument[0].ApiId, - sendResponse.SignatureRequest.CustomFields[0].ApiId - ); - - Assert.Equal( - sendRequest.Signers[0].EmailAddress, - sendResponse.SignatureRequest.Signatures[0].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[1].EmailAddress, - sendResponse.SignatureRequest.Signatures[1].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[2].EmailAddress, - sendResponse.SignatureRequest.Signatures[2].SignerEmailAddress - ); - - var getResponse = signatureRequestApi.SignatureRequestGet(sendResponse.SignatureRequest.SignatureRequestId); - - Assert.Equal( - sendResponse.SignatureRequest.SignatureRequestId, - getResponse.SignatureRequest.SignatureRequestId - ); - } - - [Fact] - public void CreateEmbeddedTest() - { - dynamic config_merged = TestHelper.GetConfig(); - - var config = new Sign.Client.Configuration(); - config.Username = config_merged["API_KEY"]; - config.BasePath = config_merged["BASE_URL"]; - - var signatureRequestApi = new Sign.Api.SignatureRequestApi(config); - - var data = TestHelper.GetJsonContents("test_fixtures/SignatureRequestSendRequest.json"); - data["client_id"] = config_merged["CLIENT_ID"]; - - var sendRequest = Sign.Model.SignatureRequestCreateEmbeddedRequest.Init(data.ToString()); - - sendRequest.Files = new List { - new FileStream( - "./../../../../../test_fixtures/pdf-sample.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var sendResponse = signatureRequestApi.SignatureRequestCreateEmbedded(sendRequest); - - Assert.Equal( - sendRequest.Signers[0].EmailAddress, - sendResponse.SignatureRequest.Signatures[0].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[1].EmailAddress, - sendResponse.SignatureRequest.Signatures[1].SignerEmailAddress - ); - Assert.Equal( - sendRequest.Signers[2].EmailAddress, - sendResponse.SignatureRequest.Signatures[2].SignerEmailAddress - ); - - var embeddedApi = new Sign.Api.EmbeddedApi(config); - - var getResponse = embeddedApi.EmbeddedSignUrl(sendResponse.SignatureRequest.Signatures[0].SignatureId); - - Assert.NotEmpty(getResponse.Embedded.SignUrl); - } - - [Fact] - public void SendWithoutFillErrorTest() - { - dynamic config_merged = TestHelper.GetConfig(); - - var config = new Sign.Client.Configuration(); - config.Username = config_merged["API_KEY"]; - config.BasePath = config_merged["BASE_URL"]; - - var signatureRequestApi = new Sign.Api.SignatureRequestApi(config); - - var data = TestHelper.GetJsonContents("test_fixtures/SignatureRequestSendRequest.json"); - - var sendRequest = Sign.Model.SignatureRequestSendRequest.Init(data.ToString()); - - try - { - signatureRequestApi.SignatureRequestSend(sendRequest); - Assert.True(false); - } - catch (Sign.Client.ApiException e) - { - Assert.Equal("file", e.ErrorContent.Error.ErrorPath); - } - } - } -} \ No newline at end of file diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs new file mode 100644 index 000000000..373d6a20f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs new file mode 100644 index 000000000..1976cb18e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountCreateOauthExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountCreateOauthExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountCreateRequest = new AccountCreateRequest( + emailAddress: "newuser@dropboxsign.com", + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465" + ); + + try + { + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs new file mode 100644 index 000000000..83d94716e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new AccountApi(config).AccountGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs new file mode 100644 index 000000000..f62bb1125 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountUpdateExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountUpdateRequest = new AccountUpdateRequest( + callbackUrl: "https://www.example.com/callback", + locale: "en-US" + ); + + try + { + var response = new AccountApi(config).AccountUpdate( + accountUpdateRequest: accountUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs new file mode 100644 index 000000000..cba51330d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/AccountVerifyExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class AccountVerifyExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var accountVerifyRequest = new AccountVerifyRequest( + emailAddress: "some_user@dropboxsign.com" + ); + + try + { + var response = new AccountApi(config).AccountVerify( + accountVerifyRequest: accountVerifyRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling AccountApi#AccountVerify: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs new file mode 100644 index 000000000..277e40121 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppCreateExample.cs @@ -0,0 +1,61 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppCreateRequest = new ApiAppCreateRequest( + name: "My Production App", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppCreate( + apiAppCreateRequest: apiAppCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs new file mode 100644 index 000000000..87235a6a3 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new ApiAppApi(config).ApiAppDelete( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs new file mode 100644 index 000000000..8bbf80af4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppGet( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs new file mode 100644 index 000000000..be9060253 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new ApiAppApi(config).ApiAppList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs new file mode 100644 index 000000000..3eb03a1bf --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ApiAppUpdateExample.cs @@ -0,0 +1,63 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ApiAppUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var oauth = new SubOAuth( + callbackUrl: "https://example.com/oauth", + scopes: [ + SubOAuth.ScopesEnum.BasicAccountInfo, + SubOAuth.ScopesEnum.RequestSignature, + ] + ); + + var whiteLabelingOptions = new SubWhiteLabelingOptions( + primaryButtonColor: "#00b3e6", + primaryButtonTextColor: "#ffffff" + ); + + var apiAppUpdateRequest = new ApiAppUpdateRequest( + callbackUrl: "https://example.com/dropboxsign", + name: "New Name", + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), + oauth: oauth, + whiteLabelingOptions: whiteLabelingOptions + ); + + try + { + var response = new ApiAppApi(config).ApiAppUpdate( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9", + apiAppUpdateRequest: apiAppUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ApiAppApi#ApiAppUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs new file mode 100644 index 000000000..baa383c93 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobGet( + bulkSendJobId: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs new file mode 100644 index 000000000..d84e42e04 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/BulkSendJobListExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class BulkSendJobListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new BulkSendJobApi(config).BulkSendJobList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj index 1adb5f2bf..decd15400 100644 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/Dropbox.SignSandbox.csproj @@ -1,8 +1,8 @@ - false - net6.0 + false + net9.0 Dropbox.SignSandbox Dropbox.SignSandbox Library @@ -10,9 +10,10 @@ false annotations false + latestmajor - + diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs new file mode 100644 index 000000000..f951e1751 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedEditUrlExample.cs @@ -0,0 +1,45 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedEditUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var mergeFields = new List(); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest( + ccRoles: [ + "", + ], + mergeFields: mergeFields + ); + + try + { + var response = new EmbeddedApi(config).EmbeddedEditUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + embeddedEditUrlRequest: embeddedEditUrlRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedEditUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs new file mode 100644 index 000000000..a800f0b04 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/EmbeddedSignUrlExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class EmbeddedSignUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new EmbeddedApi(config).EmbeddedSignUrl( + signatureId: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedSignUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs new file mode 100644 index 000000000..b642a7ff1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/Entry.cs @@ -0,0 +1,8 @@ +namespace Dropbox.SignSandbox; + +public class Entry +{ + public static void Main() + { + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs new file mode 100644 index 000000000..c8610a8fe --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/EventCallbackExample.cs @@ -0,0 +1,44 @@ +using System.Collections.Generic; +using Newtonsoft.Json; +using Dropbox.Sign.Model; +using Dropbox.Sign; + +namespace Dropbox.SignSandbox; + +public class EventCallbackExample +{ + public static void Run() + { + // use your API key + var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; + + // callbackData represents data we send to you + var callbackData = new Dictionary() + { + ["event"] = new Dictionary() + { + ["event_type"] = "account_confirmed", + ["event_time"] = "1669926463", + ["event_hash"] = "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + ["event_metadata"] = new Dictionary() + { + ["related_signature_id"] = null, + ["reported_for_account_id"] = "6421d70b9bd45059fa207d03ab8d1b96515b472c", + ["reported_for_app_id"] = null, + ["event_message"] = null, + } + } + }; + + var callbackEvent = EventCallbackRequest.Init(JsonConvert.SerializeObject(callbackData)); + + // verify that a callback came from HelloSign.com + if (EventCallbackHelper.IsValid(apiKey, callbackEvent)) + { + // one of "account_callback" or "api_app_callback" + var callbackType = EventCallbackHelper.GetCallbackType(callbackEvent); + + // do your magic below! + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs new file mode 100644 index 000000000..aa39f496d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxDeleteExample.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class 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); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs new file mode 100644 index 000000000..278b90f8b --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxFilesExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxFiles( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs new file mode 100644 index 000000000..8a15843d1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxGet( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs new file mode 100644 index 000000000..cb9c642f7 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAddUserExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class 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); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs new file mode 100644 index 000000000..b2b60876b --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineAreaCodeGetExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineAreaCodeGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAreaCodeGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs new file mode 100644 index 000000000..802ea4045 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineCreateRequest = new FaxLineCreateRequest( + areaCode: 209, + country: FaxLineCreateRequest.CountryEnum.US + ); + + try + { + var response = new FaxLineApi(config).FaxLineCreate( + faxLineCreateRequest: faxLineCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs new file mode 100644 index 000000000..42faed216 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineDeleteExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineDeleteRequest = new FaxLineDeleteRequest( + number: "[FAX_NUMBER]" + ); + + try + { + new FaxLineApi(config).FaxLineDelete( + faxLineDeleteRequest: faxLineDeleteRequest + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs new file mode 100644 index 000000000..690a65360 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineGetExample.cs @@ -0,0 +1,34 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineGet( + number: "123-123-1234" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs new file mode 100644 index 000000000..cbd75903e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineListExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxLineApi(config).FaxLineList( + accountId: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + pageSize: 20, + showTeamLines: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs new file mode 100644 index 000000000..809b89a4e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxLineRemoveUserExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxLineRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest( + number: "[FAX_NUMBER]", + emailAddress: "member@dropboxsign.com" + ); + + try + { + var response = new FaxLineApi(config).FaxLineRemoveUser( + faxLineRemoveUserRequest: faxLineRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxLineApi#FaxLineRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs new file mode 100644 index 000000000..64450619d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxListExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + var response = new FaxApi(config).FaxList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs new file mode 100644 index 000000000..e6a2270be --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/FaxSendExample.cs @@ -0,0 +1,51 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class FaxSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var faxSendRequest = new FaxSendRequest( + recipient: "16690000001", + sender: "16690000000", + testMode: true, + coverPageTo: "Jill Fax", + coverPageFrom: "Faxer Faxerson", + coverPageMessage: "I'm sending you a fax!", + title: "This is what the fax is about!", + files: new List + { + new FileStream( + path: "./example_fax.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new FaxApi(config).FaxSend( + faxSendRequest: faxSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling FaxApi#FaxSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs new file mode 100644 index 000000000..7d8da2fca --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenGenerateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenGenerateExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest( + clientId: "cc91c61d00f8bb2ece1428035716b", + clientSecret: "1d14434088507ffa390e6f5528465", + code: "1b0d28d90c86c141", + state: "900e06e2", + grantType: "authorization_code" + ); + + try + { + var response = new OAuthApi(config).OauthTokenGenerate( + oAuthTokenGenerateRequest: oAuthTokenGenerateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenGenerate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs new file mode 100644 index 000000000..21c40d14c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/OauthTokenRefreshExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class OauthTokenRefreshExample +{ + public static void Run() + { + var config = new Configuration(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest( + grantType: "refresh_token", + refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + ); + + try + { + var response = new OAuthApi(config).OauthTokenRefresh( + oAuthTokenRefreshRequest: oAuthTokenRefreshRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling OAuthApi#OauthTokenRefresh: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs deleted file mode 100644 index ad6fb38e6..000000000 --- a/sandbox/dotnet/src/Dropbox.SignSandbox/Program.cs +++ /dev/null @@ -1,39 +0,0 @@ -using System; - -using Dropbox.Sign.Api; -using Dropbox.Sign.Client; -using Dropbox.Sign.Model; - -namespace Dropbox.SignSandbox -{ - public class Example - { - public static void Main() - { - var config = new Configuration(); - // Configure HTTP basic authorization: api_key - config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiInstance = new AccountApi(config); - - var data = new AccountCreateRequest( - emailAddress: "newuser@dropboxsign.com" - ); - - try - { - var result = apiInstance.AccountCreate(data); - Console.WriteLine(result); - } - catch (ApiException e) - { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); - Console.WriteLine("Status Code: " + e.ErrorCode); - Console.WriteLine(e.StackTrace); - } - } - } -} \ No newline at end of file diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs new file mode 100644 index 000000000..769bd3a18 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/ReportCreateExample.cs @@ -0,0 +1,43 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class ReportCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var reportCreateRequest = new ReportCreateRequest( + startDate: "09/01/2020", + endDate: "09/01/2020", + reportType: [ + ReportCreateRequest.ReportTypeEnum.UserActivity, + ReportCreateRequest.ReportTypeEnum.DocumentStatus, + ] + ); + + try + { + var response = new ReportApi(config).ReportCreate( + reportCreateRequest: reportCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling ReportApi#ReportCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..9fd344a94 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + clientId: "1a659d9ad95bccd307ecad78d72192f8", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest: signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs new file mode 100644 index 000000000..3c95fdb32 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestBulkSendWithTemplateExample.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); + + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" + ); + + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "ABC Corp" + ); + + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" + ); + + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers + ); + + var signerList2 = new SubBulkSignerList( + customFields: signerList2CustomFields, + signers: signerList2Signers + ); + + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest( + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest: signatureRequestBulkSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs new file mode 100644 index 000000000..4d18209eb --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCancelExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCancelExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new SignatureRequestApi(config).SignatureRequestCancel( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCancel: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs new file mode 100644 index 000000000..7f9786caf --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedExample.cs @@ -0,0 +1,82 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..40cbcbc51 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.cs @@ -0,0 +1,110 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..d40f34240 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,66 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs new file mode 100644 index 000000000..356603bf6 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedExample.cs @@ -0,0 +1,83 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs new file mode 100644 index 000000000..3be9c8142 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedGroupedSignersExample.cs @@ -0,0 +1,111 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..fff755e13 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditEmbeddedWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedWithTemplateRequest: signatureRequestEditEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs new file mode 100644 index 000000000..b3542b75f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditExample.cs @@ -0,0 +1,93 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs new file mode 100644 index 000000000..35a41afa4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditGroupedSignersExample.cs @@ -0,0 +1,121 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestEditRequest = new SignatureRequestEditRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs new file mode 100644 index 000000000..172f24b6c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestEditWithTemplateExample.cs @@ -0,0 +1,90 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestEditWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditWithTemplateRequest: signatureRequestEditWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs new file mode 100644 index 000000000..60f837089 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsDataUri( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs new file mode 100644 index 000000000..f3bfe667a --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFilesAsFileUrl( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs new file mode 100644 index 000000000..879127eda --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestFiles( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + fileType: "pdf" + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs new file mode 100644 index 000000000..388861f1f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestGet( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs new file mode 100644 index 000000000..d5b2bfb9d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs new file mode 100644 index 000000000..9b64cd74c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestReleaseHoldExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestReleaseHoldExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new SignatureRequestApi(config).SignatureRequestReleaseHold( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestReleaseHold: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs new file mode 100644 index 000000000..bef1acbf1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemindExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemindExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest( + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestRemind( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestRemindRequest: signatureRequestRemindRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemind: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs new file mode 100644 index 000000000..f0b9cf86e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestRemoveExample.cs @@ -0,0 +1,32 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemoveExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + + try + { + new SignatureRequestApi(config).SignatureRequestRemove( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemove: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs new file mode 100644 index 000000000..2958c264c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com", + order: 1 + ); + + var signers = new List + { + signers1, + signers2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + signers: signers + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs new file mode 100644 index 000000000..8263d9170 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendGroupedSignersExample.cs @@ -0,0 +1,120 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var groupedSigners2Signers1 = new SubSignatureRequestSigner( + name: "Bob", + emailAddress: "bob@example.com" + ); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner( + name: "Charlie", + emailAddress: "charlie@example.com" + ); + + var groupedSigners2Signers = new List + { + groupedSigners2Signers1, + groupedSigners2Signers2, + }; + + var groupedSigners1Signers1 = new SubSignatureRequestSigner( + name: "Jack", + emailAddress: "jack@example.com" + ); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner( + name: "Jill", + emailAddress: "jill@example.com" + ); + + var groupedSigners1Signers = new List + { + groupedSigners1Signers1, + groupedSigners1Signers2, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners( + group: "Group #1", + order: 0, + signers: groupedSigners1Signers + ); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners( + group: "Group #2", + order: 1, + signers: groupedSigners2Signers + ); + + var groupedSigners = new List + { + groupedSigners1, + groupedSigners2, + }; + + var signatureRequestSendRequest = new SignatureRequestSendRequest( + message: "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject: "The NDA we talked about", + testMode: true, + title: "NDA with Acme Co.", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccEmailAddresses: [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata: JsonSerializer.Deserialize>(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + fieldOptions: fieldOptions, + signingOptions: signingOptions, + groupedSigners: groupedSigners + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs new file mode 100644 index 000000000..024b92ce8 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestSendWithTemplateExample.cs @@ -0,0 +1,89 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); + + var signers1 = new SubSignatureRequestTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@example.com" + ); + + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( + name: "Cost", + editor: "Client", + required: true, + value: "$20,000" + ); + + var customFields = new List + { + customFields1, + }; + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message: "Glad we could come to an agreement.", + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers, + ccs: ccs, + customFields: customFields + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest: signatureRequestSendWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSendWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs new file mode 100644 index 000000000..7d9551620 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/SignatureRequestUpdateExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class SignatureRequestUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest( + signatureId: "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + emailAddress: "john@example.com" + ); + + try + { + var response = new SignatureRequestApi(config).SignatureRequestUpdate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestUpdateRequest: signatureRequestUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs new file mode 100644 index 000000000..fe700fca7 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberAccountIdExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs new file mode 100644 index 000000000..3529c6ee0 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamAddMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamAddMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamAddMemberRequest = new TeamAddMemberRequest( + emailAddress: "george@example.com" + ); + + try + { + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs new file mode 100644 index 000000000..794c4627d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamCreateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamCreateRequest = new TeamCreateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamCreate( + teamCreateRequest: teamCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs new file mode 100644 index 000000000..b5c7a83b4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamDeleteExample.cs @@ -0,0 +1,31 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +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); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs new file mode 100644 index 000000000..3a79cd2a4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamGetExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamGet(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs new file mode 100644 index 000000000..a761bce3c --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInfoExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInfoExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInfo( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInfo: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs new file mode 100644 index 000000000..90454cbac --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamInvitesExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamInvitesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamInvites(); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamInvites: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs new file mode 100644 index 000000000..72213f8a7 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamMembersExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamMembersExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamMembers( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamMembers: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs new file mode 100644 index 000000000..0c6ae21a3 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberAccountIdExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberAccountIdExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + accountId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs new file mode 100644 index 000000000..23aeff1ff --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamRemoveMemberExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( + emailAddress: "teammate@dropboxsign.com", + newOwnerEmailAddress: "new_teammate@dropboxsign.com" + ); + + try + { + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs new file mode 100644 index 000000000..1760310a5 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamSubTeamsExample.cs @@ -0,0 +1,37 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamSubTeamsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TeamApi(config).TeamSubTeams( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamSubTeams: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs new file mode 100644 index 000000000..355811ee4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TeamUpdateExample.cs @@ -0,0 +1,39 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TeamUpdateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var teamUpdateRequest = new TeamUpdateRequest( + name: "New Team Name" + ); + + try + { + var response = new TeamApi(config).TeamUpdate( + teamUpdateRequest: teamUpdateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TeamApi#TeamUpdate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs new file mode 100644 index 000000000..dc4107a2f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateAddUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateAddUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateAddUserRequest = new TemplateAddUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateAddUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateAddUserRequest: templateAddUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateAddUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs new file mode 100644 index 000000000..e26574c52 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftExample.cs @@ -0,0 +1,92 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs new file mode 100644 index 000000000..2603e2c47 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs new file mode 100644 index 000000000..6d7a8e39b --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..cb3fd770d --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields, + signerRoles: signerRoles + ); + + try + { + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs new file mode 100644 index 000000000..09fad4bd6 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateExample.cs @@ -0,0 +1,129 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + ccRoles: [ + "Manager", + ], + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b8c56e791 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldGroupsExample.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldGroups: formFieldGroups, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..6e2224ff4 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldRulesExample.cs @@ -0,0 +1,159 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + formFieldRules: formFieldRules, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..503e80645 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,125 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 + ); + + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var mergeFields1 = new SubMergeField( + name: "Full Name", + type: SubMergeField.TypeEnum.Text + ); + + var mergeFields2 = new SubMergeField( + name: "Is Registered?", + type: SubMergeField.TypeEnum.Checkbox + ); + + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var templateCreateRequest = new TemplateCreateRequest( + clientId: "37dee8d8440c66d54cfa05d92c160882", + message: "For your approval", + subject: "Please sign this document", + testMode: true, + title: "Test Template", + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + ccRoles: [ + "Manager", + ], + fieldOptions: fieldOptions, + signerRoles: signerRoles, + formFieldsPerDocument: formFieldsPerDocument, + mergeFields: mergeFields + ); + + try + { + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs new file mode 100644 index 000000000..5a49ea03f --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateDeleteExample.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateDeleteExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + new TemplateApi(config).TemplateDelete( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateDelete: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs new file mode 100644 index 000000000..5c946b84a --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsDataUriExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsDataUriExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsDataUri( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsDataUri: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs new file mode 100644 index 000000000..3b5bc98f1 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesAsFileUrlExample.cs @@ -0,0 +1,36 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsFileUrlExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFilesAsFileUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + forceDownload: 1 + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsFileUrl: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs new file mode 100644 index 000000000..96e9237ee --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateFilesExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + fileType: null + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); + fileStream.Close(); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs new file mode 100644 index 000000000..067300032 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateGetExample.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateGetExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateGet( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateGet: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs new file mode 100644 index 000000000..b41f357ce --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateListExample.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateListExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + try + { + var response = new TemplateApi(config).TemplateList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateList: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs new file mode 100644 index 000000000..66bcbfe53 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateRemoveUserExample.cs @@ -0,0 +1,40 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateRemoveUserExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateRemoveUserRequest = new TemplateRemoveUserRequest( + emailAddress: "george@dropboxsign.com" + ); + + try + { + var response = new TemplateApi(config).TemplateRemoveUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateRemoveUserRequest: templateRemoveUserRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateRemoveUser: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs new file mode 100644 index 000000000..1fe2ccf5e --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/TemplateUpdateFilesExample.cs @@ -0,0 +1,46 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class TemplateUpdateFilesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest( + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new TemplateApi(config).TemplateUpdateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateUpdateFilesRequest: templateUpdateFilesRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling TemplateApi#TemplateUpdateFiles: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs new file mode 100644 index 000000000..4637922b5 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedExample.cs @@ -0,0 +1,48 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs new file mode 100644 index 000000000..58e77d162 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.cs @@ -0,0 +1,95 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs new file mode 100644 index 000000000..367136511 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.cs @@ -0,0 +1,115 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..f9b29f003 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.cs @@ -0,0 +1,81 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs new file mode 100644 index 000000000..2fea6ff83 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs @@ -0,0 +1,67 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@dropboxsign.com" + ); + + var ccs = new List + { + ccs1, + }; + + var signers1 = new SubUnclaimedDraftTemplateSigner( + role: "Client", + name: "George", + emailAddress: "george@example.com" + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requesterEmailAddress: "jack@dropboxsign.com", + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + testMode: false, + ccs: ccs, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest: unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbeddedWithTemplate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs new file mode 100644 index 000000000..e5080a671 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateExample.cs @@ -0,0 +1,59 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var signers1 = new SubUnclaimedDraftSigner( + name: "Jack", + emailAddress: "jack@example.com", + order: 0 + ); + + var signers = new List + { + signers1, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signers: signers + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs new file mode 100644 index 000000000..b5ae35929 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldGroupsExample.cs @@ -0,0 +1,94 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldGroups1 = new SubFormFieldGroup( + groupId: "RadioItemGroup1", + groupLabel: "Radio Item Group 1", + requirement: "require_0-1" + ); + + var formFieldGroups = new List + { + formFieldGroups1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 328, + group: "RadioItemGroup1", + isChecked: true, + name: "", + page: 1 + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "radio", + required: false, + signer: "0", + width: 18, + height: 18, + x: 112, + y: 370, + group: "RadioItemGroup1", + isChecked: false, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldGroups: formFieldGroups, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs new file mode 100644 index 000000000..dabc20ce6 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldRulesExample.cs @@ -0,0 +1,114 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger( + id: "uniqueIdHere_1", + varOperator: SubFormFieldRuleTrigger.OperatorEnum.Is, + value: "foo" + ); + + var formFieldRules1Triggers = new List + { + formFieldRules1Triggers1, + }; + + var formFieldRules1Actions1 = new SubFormFieldRuleAction( + hidden: true, + type: SubFormFieldRuleAction.TypeEnum.FieldVisibility, + fieldId: "uniqueIdHere_2" + ); + + var formFieldRules1Actions = new List + { + formFieldRules1Actions1, + }; + + var formFieldRules1 = new SubFormFieldRule( + id: "rule_1", + triggerOperator: "AND", + triggers: formFieldRules1Triggers, + actions: formFieldRules1Actions + ); + + var formFieldRules = new List + { + formFieldRules1, + }; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "0", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldRules: formFieldRules, + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs new file mode 100644 index 000000000..86eae8aea --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.cs @@ -0,0 +1,80 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText( + documentIndex: 0, + apiId: "uniqueIdHere_1", + type: "text", + required: true, + signer: "1", + width: 100, + height: 16, + x: 112, + y: 328, + name: "", + page: 1, + placeholder: "", + validationType: SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly + ); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature( + documentIndex: 0, + apiId: "uniqueIdHere_2", + type: "signature", + required: true, + signer: "0", + width: 120, + height: 30, + x: 530, + y: 415, + name: "", + page: 1 + ); + + var formFieldsPerDocument = new List + { + formFieldsPerDocument1, + formFieldsPerDocument2, + }; + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( + type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, + testMode: false, + fileUrls: [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + formFieldsPerDocument: formFieldsPerDocument + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs new file mode 100644 index 000000000..459364b01 --- /dev/null +++ b/sandbox/dotnet/src/Dropbox.SignSandbox/UnclaimedDraftEditAndResendExample.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; + +using Dropbox.Sign.Api; +using Dropbox.Sign.Client; +using Dropbox.Sign.Model; + +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftEditAndResendExample +{ + public static void Run() + { + var config = new Configuration(); + config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + testMode: false + ); + + try + { + var response = new UnclaimedDraftApi(config).UnclaimedDraftEditAndResend( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimedDraftEditAndResendRequest: unclaimedDraftEditAndResendRequest + ); + + Console.WriteLine(response); + } + catch (ApiException e) + { + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftEditAndResend: " + e.Message); + Console.WriteLine("Status Code: " + e.ErrorCode); + Console.WriteLine(e.StackTrace); + } + } +} diff --git a/sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/dotnet/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json b/sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/dotnet/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/dotnet/test_fixtures/pdf-sample.pdf b/sandbox/dotnet/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/dotnet/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sandbox/java-v1/pom.xml b/sandbox/java-v1/pom.xml deleted file mode 100644 index 326905ec6..000000000 --- a/sandbox/java-v1/pom.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - 4.0.0 - - com.dropbox.sign_sandbox - DropboxSignSandbox - 1.0-SNAPSHOT - - - 9 - 9 - UTF-8 - - - - - com.dropbox.sign - dropbox-sign - ^1.0.0-beta - system - ${pom.basedir}/artifacts/dropbox-sign.jar - - - junit - junit - 4.13.1 - test - - - junit - junit - 4.13.1 - test - - - - diff --git a/sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java b/sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java deleted file mode 100644 index 1579ee556..000000000 --- a/sandbox/java-v1/src/main/java/com/dropbox/sign_sandbox/Main.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiClient; -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Main { - public static void main(String[] args) { - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - ApiClient apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - AccountApi api = new AccountApi(apiClient); - - AccountCreateRequest data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = api.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling Dropbox Sign API"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json b/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore b/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java b/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java deleted file mode 100644 index d0df6afe9..000000000 --- a/sandbox/java-v1/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java +++ /dev/null @@ -1,148 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiClient; -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.JSON; -import com.dropbox.sign.api.EmbeddedApi; -import com.dropbox.sign.api.SignatureRequestApi; -import com.dropbox.sign.model.*; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.ObjectReader; -import org.junit.Assert; -import org.junit.Test; - -import java.io.File; -import java.nio.file.Files; -import java.nio.file.Paths; - -public class SignatureRequestTest { - public static JsonNode getConfig() throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - - JsonNode configCustom = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.json") - )); - JsonNode configDist = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.dist.json") - )); - - ObjectReader updater = objectMapper.readerForUpdating(configDist); - - return updater.readValue(configCustom); - } - - public static JsonNode getJsonContents(String filename) throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - return objectMapper.readTree(Files.newInputStream( - Paths.get("test_fixtures/" + filename) - )); - } - - @Test - public void testSend() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestSend(sendRequest); - - Assert.assertEquals( - sendRequest.getFormFieldsPerDocument().get(0).getApiId(), - sendResponse.getSignatureRequest().getCustomFields().get(0).getApiId() - ); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - SignatureRequestGetResponse getResponse = signatureRequestApi.signatureRequestGet( - sendResponse.getSignatureRequest().getSignatureRequestId() - ); - - Assert.assertEquals( - sendResponse.getSignatureRequest().getSignatureRequestId(), - getResponse.getSignatureRequest().getSignatureRequestId() - ); - } - - @Test - public void testCreateEmbedded() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestCreateEmbeddedRequest.json"); - - SignatureRequestCreateEmbeddedRequest sendRequest = SignatureRequestCreateEmbeddedRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - sendRequest.clientId(config.findPath("CLIENT_ID").textValue()); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestCreateEmbedded(sendRequest); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - EmbeddedApi embeddedApi = new EmbeddedApi(apiClient); - - EmbeddedSignUrlResponse getResponse = embeddedApi.embeddedSignUrl( - sendResponse.getSignatureRequest().getSignatures().get(0).getSignatureId() - ); - - Assert.assertNotNull(getResponse.getEmbedded().getSignUrl()); - } - - @Test - public void testSendWithoutFileError() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - - try { - signatureRequestApi.signatureRequestSend(sendRequest); - Assert.fail(); - } catch (ApiException e) { - Assert.assertEquals("file", e.getErrorResponse().getError().getErrorPath()); - } - } -} diff --git a/sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/java-v1/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json b/sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/java-v1/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v1/test_fixtures/pdf-sample.pdf b/sandbox/java-v1/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/java-v1/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sandbox/java-v2/pom.xml b/sandbox/java-v2/pom.xml deleted file mode 100644 index 67f2456ad..000000000 --- a/sandbox/java-v2/pom.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - 4.0.0 - - com.dropbox.sign_sandbox - DropboxSignSandbox - 1.0-SNAPSHOT - - - 11 - 11 - UTF-8 - - - - - com.dropbox.sign - dropbox-sign - ^2.0.0-beta - system - ${pom.basedir}/artifacts/dropbox-sign.jar - - - junit - junit - 4.13.1 - test - - - - diff --git a/sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java b/sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java deleted file mode 100644 index 16673775c..000000000 --- a/sandbox/java-v2/src/main/java/com/dropbox/sign_sandbox/Main.java +++ /dev/null @@ -1,37 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var oauth2 = (HttpBearerAuth) apiClient - .getAuthentication("oauth2"); - oauth2.setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var api = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = api.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling Dropbox Sign API"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} diff --git a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json b/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore b/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java b/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java deleted file mode 100644 index d0df6afe9..000000000 --- a/sandbox/java-v2/src/test/com/dropbox/sign_sandbox/SignatureRequestTest.java +++ /dev/null @@ -1,148 +0,0 @@ -package com.dropbox.sign_sandbox; - -import com.dropbox.sign.ApiClient; -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.JSON; -import com.dropbox.sign.api.EmbeddedApi; -import com.dropbox.sign.api.SignatureRequestApi; -import com.dropbox.sign.model.*; -import com.fasterxml.jackson.databind.JsonNode; -import com.fasterxml.jackson.databind.ObjectMapper; -import com.fasterxml.jackson.databind.ObjectReader; -import org.junit.Assert; -import org.junit.Test; - -import java.io.File; -import java.nio.file.Files; -import java.nio.file.Paths; - -public class SignatureRequestTest { - public static JsonNode getConfig() throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - - JsonNode configCustom = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.json") - )); - JsonNode configDist = objectMapper.readTree(Files.newInputStream( - Paths.get("src/test/com/dropbox/sign_sandbox/.config.dist.json") - )); - - ObjectReader updater = objectMapper.readerForUpdating(configDist); - - return updater.readValue(configCustom); - } - - public static JsonNode getJsonContents(String filename) throws Exception { - ObjectMapper objectMapper = JSON.getDefault().getMapper(); - return objectMapper.readTree(Files.newInputStream( - Paths.get("test_fixtures/" + filename) - )); - } - - @Test - public void testSend() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestSend(sendRequest); - - Assert.assertEquals( - sendRequest.getFormFieldsPerDocument().get(0).getApiId(), - sendResponse.getSignatureRequest().getCustomFields().get(0).getApiId() - ); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - SignatureRequestGetResponse getResponse = signatureRequestApi.signatureRequestGet( - sendResponse.getSignatureRequest().getSignatureRequestId() - ); - - Assert.assertEquals( - sendResponse.getSignatureRequest().getSignatureRequestId(), - getResponse.getSignatureRequest().getSignatureRequestId() - ); - } - - @Test - public void testCreateEmbedded() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestCreateEmbeddedRequest.json"); - - SignatureRequestCreateEmbeddedRequest sendRequest = SignatureRequestCreateEmbeddedRequest.init(data.toString()); - sendRequest.addFilesItem(new File("test_fixtures/pdf-sample.pdf")); - sendRequest.clientId(config.findPath("CLIENT_ID").textValue()); - - SignatureRequestGetResponse sendResponse = signatureRequestApi.signatureRequestCreateEmbedded(sendRequest); - - Assert.assertEquals( - sendRequest.getSigners().get(0).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(0).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(1).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(1).getSignerEmailAddress() - ); - Assert.assertEquals( - sendRequest.getSigners().get(2).getEmailAddress(), - sendResponse.getSignatureRequest().getSignatures().get(2).getSignerEmailAddress() - ); - - EmbeddedApi embeddedApi = new EmbeddedApi(apiClient); - - EmbeddedSignUrlResponse getResponse = embeddedApi.embeddedSignUrl( - sendResponse.getSignatureRequest().getSignatures().get(0).getSignatureId() - ); - - Assert.assertNotNull(getResponse.getEmbedded().getSignUrl()); - } - - @Test - public void testSendWithoutFileError() throws Exception { - JsonNode config = getConfig(); - - ApiClient apiClient = Configuration.getDefaultApiClient() - .setApiKey(config.findPath("API_KEY").textValue()) - .setBasePath(config.findPath("BASE_URL").textValue()); - - SignatureRequestApi signatureRequestApi = new SignatureRequestApi(apiClient); - - JsonNode data = getJsonContents("SignatureRequestSendRequest.json"); - SignatureRequestSendRequest sendRequest = SignatureRequestSendRequest.init(data.toString()); - - try { - signatureRequestApi.signatureRequestSend(sendRequest); - Assert.fail(); - } catch (ApiException e) { - Assert.assertEquals("file", e.getErrorResponse().getError().getErrorPath()); - } - } -} diff --git a/sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/java-v2/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json b/sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/java-v2/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/java-v2/test_fixtures/pdf-sample.pdf b/sandbox/java-v2/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/java-v2/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sandbox/java/.gitignore b/sandbox/java/.gitignore new file mode 100644 index 000000000..4e6b64722 --- /dev/null +++ b/sandbox/java/.gitignore @@ -0,0 +1,7 @@ +.gradle +.idea +build +gradle +gradlew +gradlew.bat +target diff --git a/sandbox/java/DropboxSignSandbox.iml b/sandbox/java/DropboxSignSandbox.iml new file mode 100644 index 000000000..1d69dfd4f --- /dev/null +++ b/sandbox/java/DropboxSignSandbox.iml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/sandbox/java/build.gradle b/sandbox/java/build.gradle new file mode 100644 index 000000000..c9961ae6e --- /dev/null +++ b/sandbox/java/build.gradle @@ -0,0 +1,109 @@ +apply plugin: 'idea' +apply plugin: 'eclipse' +apply plugin: 'java' +apply plugin: 'com.diffplug.spotless' + +group = 'com.dropbox.sign_sandbox' +version = '1.0.0' + +buildscript { + repositories { + mavenCentral() + } + dependencies { + classpath 'com.android.tools.build:gradle:2.3.+' + classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1' + classpath 'com.diffplug.spotless:spotless-plugin-gradle:6.11.0' + } +} + +repositories { + mavenCentral() +} +sourceSets { + main.java.srcDirs = ['src/main/java'] +} + +apply plugin: 'java' +apply plugin: 'maven-publish' + +publishing { + publications { + maven(MavenPublication) { + artifactId = 'dropbox-sign' + from components.java + } + } +} + +task execute(type:JavaExec) { + main = System.getProperty('mainClass') + classpath = sourceSets.main.runtimeClasspath +} + +ext { + jakarta_annotation_version = "1.3.5" +} + +dependencies { + implementation fileTree(dir: 'artifacts', include: ['dropbox-sign.jar']) + implementation 'io.swagger:swagger-annotations:1.6.8' + implementation "com.google.code.findbugs:jsr305:3.0.2" + implementation 'com.squareup.okhttp3:okhttp:4.12.0' + implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0' + implementation 'com.google.code.gson:gson:2.9.1' + implementation 'io.gsonfire:gson-fire:1.9.0' + implementation 'jakarta.ws.rs:jakarta.ws.rs-api:2.1.6' + implementation 'org.openapitools:jackson-databind-nullable:0.2.6' + implementation group: 'org.apache.oltu.oauth2', name: 'org.apache.oltu.oauth2.client', version: '1.0.2' + implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.17.0' + implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version" + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.3' + testImplementation 'org.mockito:mockito-core:3.12.4' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.3' +} + +javadoc { + options.tags = [ "http.response.details:a:Http Response Details" ] +} + +// Use spotless plugin to automatically format code, remove unused import, etc +// To apply changes directly to the file, run `gradlew spotlessApply` +// Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle +spotless { + // comment out below to run spotless as part of the `check` task + enforceCheck false + + format 'misc', { + // define the files (e.g. '*.gradle', '*.md') to apply `misc` to + target '.gitignore' + + // define the steps to apply to those files + trimTrailingWhitespace() + indentWithSpaces() // Takes an integer argument if you don't like 4 + endWithNewline() + } + java { + // don't need to set target, it is inferred from java + + // apply a specific flavor of google-java-format + googleJavaFormat('1.8').aosp().reflowLongStrings() + + removeUnusedImports() + importOrder() + } +} + +test { + // Enable JUnit 5 (Gradle 4.6+). + useJUnitPlatform() + + // Always run tests, even when nothing changed. + dependsOn 'cleanTest' + + // Show test results. + testLogging { + events "passed", "skipped", "failed" + } + +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java new file mode 100644 index 000000000..a9b8c52d2 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java new file mode 100644 index 000000000..5cfc13531 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountCreateOauthExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateOauthExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + accountCreateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + accountCreateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java new file mode 100644 index 000000000..3a90b0375 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java new file mode 100644 index 000000000..ac9c0d227 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountUpdateExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java new file mode 100644 index 000000000..6d6f22f72 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/AccountVerifyExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountVerifyExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountVerify"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java new file mode 100644 index 000000000..9422376ae --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppCreateExample.java @@ -0,0 +1,60 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java new file mode 100644 index 000000000..f9f7c5c9f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java new file mode 100644 index 000000000..6a8330449 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java new file mode 100644 index 000000000..5f023c890 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java new file mode 100644 index 000000000..19eb17192 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ApiAppUpdateExample.java @@ -0,0 +1,62 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java new file mode 100644 index 000000000..a90b43560 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java new file mode 100644 index 000000000..fc5d223e3 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/BulkSendJobListExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java new file mode 100644 index 000000000..81139263b --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedEditUrlExample.java @@ -0,0 +1,49 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedEditUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java new file mode 100644 index 000000000..8b58ba353 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EmbeddedSignUrlExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedSignUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedSignUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java new file mode 100644 index 000000000..37d245133 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/EventCallbackExample.java @@ -0,0 +1,39 @@ +import com.dropbox.sign.EventCallbackHelper; +import com.dropbox.sign.model.EventCallbackRequest; +import com.fasterxml.jackson.databind.ObjectMapper; + +import java.util.HashMap; + +public class EventCallbackExample { + public static void main(String[] args) throws Exception { + // use your API key + var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; + + // callbackData represents data we send to you + var callbackData = new HashMap<>() {{ + put("event", new HashMap<>() {{ + put("event_type", "account_confirmed"); + put("event_time", "1669926463"); + put("event_hash", "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f"); + put("event_metadata", new HashMap<>() {{ + put("related_signature_id", null); + put("reported_for_account_id", "6421d70b9bd45059fa207d03ab8d1b96515b472c"); + put("reported_for_app_id", null); + put("event_message", null); + }}); + }}); + }}; + + var callbackEvent = EventCallbackRequest.init( + new ObjectMapper().writeValueAsString(callbackData) + ); + + // verify that a callback came from HelloSign.com + if (EventCallbackHelper.isValid(apiKey, callbackEvent)) { + // one of "account_callback" or "api_app_callback" + var callbackType = EventCallbackHelper.getCallbackType(callbackEvent); + + // do your magic below! + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java new file mode 100644 index 000000000..ac5fc888d --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxDeleteExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java new file mode 100644 index 000000000..1d2e62fac --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxFilesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java new file mode 100644 index 000000000..3db05bd4b --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java new file mode 100644 index 000000000..f3883223f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAddUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java new file mode 100644 index 000000000..0f2055863 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineAreaCodeGetExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java new file mode 100644 index 000000000..d1a1fa689 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java new file mode 100644 index 000000000..348833fba --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineDeleteExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java new file mode 100644 index 000000000..8f9cd3169 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineGetExample.java @@ -0,0 +1,39 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java new file mode 100644 index 000000000..7ce8cf1cf --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineListExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java new file mode 100644 index 000000000..568d08d5d --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxLineRemoveUserExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java new file mode 100644 index 000000000..1ca7c0a54 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxListExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java new file mode 100644 index 000000000..62696b80d --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/FaxSendExample.java @@ -0,0 +1,51 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java new file mode 100644 index 000000000..c8c8cea26 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/Main.java @@ -0,0 +1,6 @@ +package com.dropbox.sign_sandbox; + +public class Main { + public static void main(String[] args) { + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java new file mode 100644 index 000000000..7c51af01f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenGenerateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenGenerate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java new file mode 100644 index 000000000..5b2133b0e --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/OauthTokenRefreshExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenRefresh"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java new file mode 100644 index 000000000..ecd726bcb --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/ReportCreateExample.java @@ -0,0 +1,47 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ReportApi#reportCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..fcfbef591 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java new file mode 100644 index 000000000..fb9baba01 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestBulkSendWithTemplateExample.java @@ -0,0 +1,107 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java new file mode 100644 index 000000000..a1e436802 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCancelExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCancelExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCancel"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java new file mode 100644 index 000000000..ee5f5bb2a --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedExample.java @@ -0,0 +1,78 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..0228be4a6 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -0,0 +1,104 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..5957ccba0 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java new file mode 100644 index 000000000..8370a232e --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedExample.java @@ -0,0 +1,79 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java new file mode 100644 index 000000000..8859b04f8 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -0,0 +1,105 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..77c294dea --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -0,0 +1,68 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java new file mode 100644 index 000000000..c0423f9b9 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditExample.java @@ -0,0 +1,88 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java new file mode 100644 index 000000000..693b72c6c --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditGroupedSignersExample.java @@ -0,0 +1,114 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java new file mode 100644 index 000000000..bcb4128d6 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestEditWithTemplateExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestEditWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java new file mode 100644 index 000000000..765fb93ce --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java new file mode 100644 index 000000000..62e253779 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java new file mode 100644 index 000000000..758d2997b --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java new file mode 100644 index 000000000..b93d099d6 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java new file mode 100644 index 000000000..76f018548 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java new file mode 100644 index 000000000..521794ef1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestReleaseHoldExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestReleaseHoldExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestReleaseHold"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java new file mode 100644 index 000000000..23830d9d3 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemindExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemindExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemind"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java new file mode 100644 index 000000000..d205e388a --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestRemoveExample.java @@ -0,0 +1,37 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemove"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java new file mode 100644 index 000000000..2a57da157 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendExample.java @@ -0,0 +1,87 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java new file mode 100644 index 000000000..14d6d0fba --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendGroupedSignersExample.java @@ -0,0 +1,113 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendGroupedSignersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java new file mode 100644 index 000000000..fe3a4ce83 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestSendWithTemplateExample.java @@ -0,0 +1,86 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java new file mode 100644 index 000000000..ef9873326 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/SignatureRequestUpdateExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java new file mode 100644 index 000000000..cdeea5ec5 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberAccountIdExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java new file mode 100644 index 000000000..788cc3bd0 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamAddMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java new file mode 100644 index 000000000..0b72d53e2 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamCreateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java new file mode 100644 index 000000000..f39d1324c --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamDeleteExample.java @@ -0,0 +1,36 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TeamApi(config).teamDelete(); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java new file mode 100644 index 000000000..4356bb8a9 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamGetExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java new file mode 100644 index 000000000..8b5718628 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInfoExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInfoExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInfo"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java new file mode 100644 index 000000000..204109825 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamInvitesExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInvitesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInvites"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java new file mode 100644 index 000000000..bc709c951 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamMembersExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamMembersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamMembers"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java new file mode 100644 index 000000000..85c46ee65 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberAccountIdExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberAccountIdExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java new file mode 100644 index 000000000..40938583f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamRemoveMemberExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java new file mode 100644 index 000000000..f0ee98cf1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamSubTeamsExample.java @@ -0,0 +1,42 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamSubTeamsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamSubTeams"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java new file mode 100644 index 000000000..54f6bf2a1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TeamUpdateExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamUpdate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java new file mode 100644 index 000000000..144cb00ef --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateAddUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateAddUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java new file mode 100644 index 000000000..cb8c9ce12 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftExample.java @@ -0,0 +1,85 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java new file mode 100644 index 000000000..61c6fc967 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldGroups(formFieldGroups); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java new file mode 100644 index 000000000..7bb877263 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldRules(formFieldRules); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..38e8fccbc --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java new file mode 100644 index 000000000..b8b8e5150 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..08612bd26 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldGroupsExample.java @@ -0,0 +1,131 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldGroups(formFieldGroups); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java new file mode 100644 index 000000000..a3c621aee --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldRulesExample.java @@ -0,0 +1,147 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldRules(formFieldRules); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..397046a78 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,119 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java new file mode 100644 index 000000000..b9d0b77ad --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateDeleteExample.java @@ -0,0 +1,38 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateDelete"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java new file mode 100644 index 000000000..6ef950fe3 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsDataUriExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsDataUri"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java new file mode 100644 index 000000000..3ac688da1 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesAsFileUrlExample.java @@ -0,0 +1,41 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsFileUrl"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java new file mode 100644 index 000000000..90c2975b2 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateFilesExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java new file mode 100644 index 000000000..affbf4d04 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateGetExample.java @@ -0,0 +1,40 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateGet"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java new file mode 100644 index 000000000..45250a456 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateListExample.java @@ -0,0 +1,43 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateList"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java new file mode 100644 index 000000000..d3d157b24 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateRemoveUserExample.java @@ -0,0 +1,44 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateRemoveUser"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java new file mode 100644 index 000000000..865668461 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/TemplateUpdateFilesExample.java @@ -0,0 +1,46 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateUpdateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateUpdateFiles"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java new file mode 100644 index 000000000..0dfd50d88 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedExample.java @@ -0,0 +1,48 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java new file mode 100644 index 000000000..f597e3e18 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java @@ -0,0 +1,94 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java new file mode 100644 index 000000000..d2483f32f --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java @@ -0,0 +1,110 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..f425a3d36 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java @@ -0,0 +1,82 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java new file mode 100644 index 000000000..174c678a4 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,67 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java new file mode 100644 index 000000000..219de1f5a --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateExample.java @@ -0,0 +1,57 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java new file mode 100644 index 000000000..e30a749bb --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldGroupsExample.java @@ -0,0 +1,93 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldGroupsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java new file mode 100644 index 000000000..49de71fbe --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldRulesExample.java @@ -0,0 +1,109 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldRulesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java new file mode 100644 index 000000000..b048a8ba9 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,81 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java new file mode 100644 index 000000000..4866e6524 --- /dev/null +++ b/sandbox/java/src/main/java/com/dropbox/sign_sandbox/UnclaimedDraftEditAndResendExample.java @@ -0,0 +1,45 @@ +package com.dropbox.sign_sandbox; + +import com.dropbox.sign.ApiException; +import com.dropbox.sign.Configuration; +import com.dropbox.sign.api.*; +import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; + +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class UnclaimedDraftEditAndResendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} diff --git a/sandbox/node/.gitignore b/sandbox/node/.gitignore new file mode 100644 index 000000000..bf28e3a64 --- /dev/null +++ b/sandbox/node/.gitignore @@ -0,0 +1,32 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.js + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# local env files +.env.local +.env.development.local +.env.test.local +.env.production.local + +package-lock.json diff --git a/sandbox/node/Example.ts b/sandbox/node/Example.ts deleted file mode 100644 index af5e5b01d..000000000 --- a/sandbox/node/Example.ts +++ /dev/null @@ -1,21 +0,0 @@ -import * as DropboxSign from "@dropbox/sign"; - -const api = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -api.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// api.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountCreateRequest = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = api.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); diff --git a/sandbox/node/package.json b/sandbox/node/package.json index 8506e51c3..11d5ee311 100644 --- a/sandbox/node/package.json +++ b/sandbox/node/package.json @@ -1,21 +1,15 @@ { "name": "@dropbox/sign-sandbox", "version": "1.0.0", - "description": "", - "main": "Example.ts", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "dependencies": { "@dropbox/sign": "file:./artifacts/dropbox-sign-sdk.tgz", - "@types/jest": "^29.5.7", - "@types/node": "^20.8.10", - "jest": "^29.7.0", - "ts-jest": "^29.1.1", - "ts-node": "^10.9.1", - "typescript": "^4.0 || ^5.0" + "@types/node": "^22.12", + "ts-node": "^10.9", + "typescript": "^5.0" }, "type": "module", - "author": "", "license": "ISC" } diff --git a/sandbox/node/src/AccountCreateExample.ts b/sandbox/node/src/AccountCreateExample.ts new file mode 100644 index 000000000..f5b490085 --- /dev/null +++ b/sandbox/node/src/AccountCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountCreateOauthExample.ts b/sandbox/node/src/AccountCreateOauthExample.ts new file mode 100644 index 000000000..0554d4d79 --- /dev/null +++ b/sandbox/node/src/AccountCreateOauthExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; +accountCreateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +accountCreateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; + +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountGetExample.ts b/sandbox/node/src/AccountGetExample.ts new file mode 100644 index 000000000..6bc7ae2de --- /dev/null +++ b/sandbox/node/src/AccountGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.accountGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountUpdateExample.ts b/sandbox/node/src/AccountUpdateExample.ts new file mode 100644 index 000000000..8a546ee0e --- /dev/null +++ b/sandbox/node/src/AccountUpdateExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountUpdateRequest = new models.AccountUpdateRequest(); +accountUpdateRequest.callbackUrl = "https://www.example.com/callback"; +accountUpdateRequest.locale = "en-US"; + +apiCaller.accountUpdate( + accountUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/AccountVerifyExample.ts b/sandbox/node/src/AccountVerifyExample.ts new file mode 100644 index 000000000..417ffce6d --- /dev/null +++ b/sandbox/node/src/AccountVerifyExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const accountVerifyRequest = new models.AccountVerifyRequest(); +accountVerifyRequest.emailAddress = "some_user@dropboxsign.com"; + +apiCaller.accountVerify( + accountVerifyRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling AccountApi#accountVerify:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppCreateExample.ts b/sandbox/node/src/ApiAppCreateExample.ts new file mode 100644 index 000000000..be9234816 --- /dev/null +++ b/sandbox/node/src/ApiAppCreateExample.ts @@ -0,0 +1,36 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppCreateRequest = new models.ApiAppCreateRequest(); +apiAppCreateRequest.name = "My Production App"; +apiAppCreateRequest.domains = [ + "example.com", +]; +apiAppCreateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppCreateRequest.oauth = oauth; +apiAppCreateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppCreate( + apiAppCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppDeleteExample.ts b/sandbox/node/src/ApiAppDeleteExample.ts new file mode 100644 index 000000000..1ffefb975 --- /dev/null +++ b/sandbox/node/src/ApiAppDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppGetExample.ts b/sandbox/node/src/ApiAppGetExample.ts new file mode 100644 index 000000000..4899769af --- /dev/null +++ b/sandbox/node/src/ApiAppGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppListExample.ts b/sandbox/node/src/ApiAppListExample.ts new file mode 100644 index 000000000..7304a9d1c --- /dev/null +++ b/sandbox/node/src/ApiAppListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.apiAppList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ApiAppUpdateExample.ts b/sandbox/node/src/ApiAppUpdateExample.ts new file mode 100644 index 000000000..fa8937223 --- /dev/null +++ b/sandbox/node/src/ApiAppUpdateExample.ts @@ -0,0 +1,38 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppUpdateRequest = new models.ApiAppUpdateRequest(); +apiAppUpdateRequest.callbackUrl = "https://example.com/dropboxsign"; +apiAppUpdateRequest.name = "New Name"; +apiAppUpdateRequest.domains = [ + "example.com", +]; +apiAppUpdateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppUpdateRequest.oauth = oauth; +apiAppUpdateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/BulkSendJobGetExample.ts b/sandbox/node/src/BulkSendJobGetExample.ts new file mode 100644 index 000000000..9c3e43eb9 --- /dev/null +++ b/sandbox/node/src/BulkSendJobGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/BulkSendJobListExample.ts b/sandbox/node/src/BulkSendJobListExample.ts new file mode 100644 index 000000000..4f8b1b33b --- /dev/null +++ b/sandbox/node/src/BulkSendJobListExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.BulkSendJobApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.bulkSendJobList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling BulkSendJobApi#bulkSendJobList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/EmbeddedEditUrlExample.ts b/sandbox/node/src/EmbeddedEditUrlExample.ts new file mode 100644 index 000000000..bca3980cf --- /dev/null +++ b/sandbox/node/src/EmbeddedEditUrlExample.ts @@ -0,0 +1,26 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const mergeFields = [ +]; + +const embeddedEditUrlRequest = new models.EmbeddedEditUrlRequest(); +embeddedEditUrlRequest.ccRoles = [ + "", +]; +embeddedEditUrlRequest.mergeFields = mergeFields; + +apiCaller.embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedEditUrl:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/EmbeddedSignUrlExample.ts b/sandbox/node/src/EmbeddedSignUrlExample.ts new file mode 100644 index 000000000..ec7da0536 --- /dev/null +++ b/sandbox/node/src/EmbeddedSignUrlExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", // signatureId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling EmbeddedApi#embeddedSignUrl:"); + console.log(error.body); +}); diff --git a/examples/EventCallback.ts b/sandbox/node/src/EventCallbackExample.ts similarity index 100% rename from examples/EventCallback.ts rename to sandbox/node/src/EventCallbackExample.ts diff --git a/sandbox/node/src/FaxDeleteExample.ts b/sandbox/node/src/FaxDeleteExample.ts new file mode 100644 index 000000000..3afd7a63b --- /dev/null +++ b/sandbox/node/src/FaxDeleteExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).catch(error => { + console.log("Exception when calling FaxApi#faxDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxFilesExample.ts b/sandbox/node/src/FaxFilesExample.ts new file mode 100644 index 000000000..d4360710d --- /dev/null +++ b/sandbox/node/src/FaxFilesExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxGetExample.ts b/sandbox/node/src/FaxGetExample.ts new file mode 100644 index 000000000..56a87dbe7 --- /dev/null +++ b/sandbox/node/src/FaxGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineAddUserExample.ts b/sandbox/node/src/FaxLineAddUserExample.ts new file mode 100644 index 000000000..468fe36a6 --- /dev/null +++ b/sandbox/node/src/FaxLineAddUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineAddUserRequest = new models.FaxLineAddUserRequest(); +faxLineAddUserRequest.number = "[FAX_NUMBER]"; +faxLineAddUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineAddUser( + faxLineAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAddUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineAreaCodeGetExample.ts b/sandbox/node/src/FaxLineAreaCodeGetExample.ts new file mode 100644 index 000000000..0abb378b3 --- /dev/null +++ b/sandbox/node/src/FaxLineAreaCodeGetExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineAreaCodeGet( + "US", // country + undefined, // state + undefined, // province + undefined, // city +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineAreaCodeGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineCreateExample.ts b/sandbox/node/src/FaxLineCreateExample.ts new file mode 100644 index 000000000..b9398b2fa --- /dev/null +++ b/sandbox/node/src/FaxLineCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineCreateRequest = new models.FaxLineCreateRequest(); +faxLineCreateRequest.areaCode = 209; +faxLineCreateRequest.country = models.FaxLineCreateRequest.CountryEnum.Us; + +apiCaller.faxLineCreate( + faxLineCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineDeleteExample.ts b/sandbox/node/src/FaxLineDeleteExample.ts new file mode 100644 index 000000000..72b2279a3 --- /dev/null +++ b/sandbox/node/src/FaxLineDeleteExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineDeleteRequest = new models.FaxLineDeleteRequest(); +faxLineDeleteRequest.number = "[FAX_NUMBER]"; + +apiCaller.faxLineDelete( + faxLineDeleteRequest, +).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineGetExample.ts b/sandbox/node/src/FaxLineGetExample.ts new file mode 100644 index 000000000..e5ee2fd0f --- /dev/null +++ b/sandbox/node/src/FaxLineGetExample.ts @@ -0,0 +1,15 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineGet( + "123-123-1234", // number +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineListExample.ts b/sandbox/node/src/FaxLineListExample.ts new file mode 100644 index 000000000..aa547afce --- /dev/null +++ b/sandbox/node/src/FaxLineListExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + undefined, // showTeamLines +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxLineRemoveUserExample.ts b/sandbox/node/src/FaxLineRemoveUserExample.ts new file mode 100644 index 000000000..e73b8c7c5 --- /dev/null +++ b/sandbox/node/src/FaxLineRemoveUserExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxLineRemoveUserRequest = new models.FaxLineRemoveUserRequest(); +faxLineRemoveUserRequest.number = "[FAX_NUMBER]"; +faxLineRemoveUserRequest.emailAddress = "member@dropboxsign.com"; + +apiCaller.faxLineRemoveUser( + faxLineRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineRemoveUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxListExample.ts b/sandbox/node/src/FaxListExample.ts new file mode 100644 index 000000000..70b904d6f --- /dev/null +++ b/sandbox/node/src/FaxListExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.faxList( + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/FaxSendExample.ts b/sandbox/node/src/FaxSendExample.ts new file mode 100644 index 000000000..0b39faee5 --- /dev/null +++ b/sandbox/node/src/FaxSendExample.ts @@ -0,0 +1,27 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxSendRequest = new models.FaxSendRequest(); +faxSendRequest.recipient = "16690000001"; +faxSendRequest.sender = "16690000000"; +faxSendRequest.testMode = true; +faxSendRequest.coverPageTo = "Jill Fax"; +faxSendRequest.coverPageFrom = "Faxer Faxerson"; +faxSendRequest.coverPageMessage = "I'm sending you a fax!"; +faxSendRequest.title = "This is what the fax is about!"; +faxSendRequest.files = [ + fs.createReadStream("./example_fax.pdf"), +]; + +apiCaller.faxSend( + faxSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling FaxApi#faxSend:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/OauthTokenGenerateExample.ts b/sandbox/node/src/OauthTokenGenerateExample.ts new file mode 100644 index 000000000..ace0df01d --- /dev/null +++ b/sandbox/node/src/OauthTokenGenerateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenGenerateRequest = new models.OAuthTokenGenerateRequest(); +oAuthTokenGenerateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +oAuthTokenGenerateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; +oAuthTokenGenerateRequest.code = "1b0d28d90c86c141"; +oAuthTokenGenerateRequest.state = "900e06e2"; +oAuthTokenGenerateRequest.grantType = "authorization_code"; + +apiCaller.oauthTokenGenerate( + oAuthTokenGenerateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenGenerate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/OauthTokenRefreshExample.ts b/sandbox/node/src/OauthTokenRefreshExample.ts new file mode 100644 index 000000000..fa9973e6f --- /dev/null +++ b/sandbox/node/src/OauthTokenRefreshExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenRefreshRequest = new models.OAuthTokenRefreshRequest(); +oAuthTokenRefreshRequest.grantType = "refresh_token"; +oAuthTokenRefreshRequest.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; + +apiCaller.oauthTokenRefresh( + oAuthTokenRefreshRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling OAuthApi#oauthTokenRefresh:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/ReportCreateExample.ts b/sandbox/node/src/ReportCreateExample.ts new file mode 100644 index 000000000..57bf8127d --- /dev/null +++ b/sandbox/node/src/ReportCreateExample.ts @@ -0,0 +1,23 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ReportApi(); +apiCaller.username = "YOUR_API_KEY"; + +const reportCreateRequest = new models.ReportCreateRequest(); +reportCreateRequest.startDate = "09/01/2020"; +reportCreateRequest.endDate = "09/01/2020"; +reportCreateRequest.reportType = [ + models.ReportCreateRequest.ReportTypeEnum.UserActivity, + models.ReportCreateRequest.ReportTypeEnum.DocumentStatus, +]; + +apiCaller.reportCreate( + reportCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling ReportApi#reportCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..d8b5b2ef9 --- /dev/null +++ b/sandbox/node/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkCreateEmbeddedWithTemplateRequest = new models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); +signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId = "1a659d9ad95bccd307ecad78d72192f8"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList = signerList; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts b/sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts new file mode 100644 index 000000000..f2fff90b1 --- /dev/null +++ b/sandbox/node/src/SignatureRequestBulkSendWithTemplateExample.ts @@ -0,0 +1,83 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkSendWithTemplateRequest = new models.SignatureRequestBulkSendWithTemplateRequest(); +signatureRequestBulkSendWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkSendWithTemplateRequest.testMode = true; +signatureRequestBulkSendWithTemplateRequest.signerList = signerList; +signatureRequestBulkSendWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCancelExample.ts b/sandbox/node/src/SignatureRequestCancelExample.ts new file mode 100644 index 000000000..d6207b3bd --- /dev/null +++ b/sandbox/node/src/SignatureRequestCancelExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCancel:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts new file mode 100644 index 000000000..15c30c113 --- /dev/null +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedExample.ts @@ -0,0 +1,54 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..6fcc1bab3 --- /dev/null +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedGroupedSignersExample.ts @@ -0,0 +1,80 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..399f0c491 --- /dev/null +++ b/sandbox/node/src/SignatureRequestCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestCreateEmbeddedWithTemplateRequest = new models.SignatureRequestCreateEmbeddedWithTemplateRequest(); +signatureRequestCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts new file mode 100644 index 000000000..6affce8fb --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditEmbeddedExample.ts @@ -0,0 +1,55 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts new file mode 100644 index 000000000..c65767fed --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditEmbeddedGroupedSignersExample.ts @@ -0,0 +1,81 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts b/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..6da9e8e05 --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditEmbeddedWithTemplateExample.ts @@ -0,0 +1,44 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestEditEmbeddedWithTemplateRequest = new models.SignatureRequestEditEmbeddedWithTemplateRequest(); +signatureRequestEditEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestEditEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditEmbeddedWithTemplateRequest.testMode = true; +signatureRequestEditEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditExample.ts b/sandbox/node/src/SignatureRequestEditExample.ts new file mode 100644 index 000000000..43aca782d --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.signers = signers; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts new file mode 100644 index 000000000..fe5e19645 --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditGroupedSignersExample.ts @@ -0,0 +1,88 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestEditWithTemplateExample.ts b/sandbox/node/src/SignatureRequestEditWithTemplateExample.ts new file mode 100644 index 000000000..650ce2ff1 --- /dev/null +++ b/sandbox/node/src/SignatureRequestEditWithTemplateExample.ts @@ -0,0 +1,63 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestEditWithTemplateRequest = new models.SignatureRequestEditWithTemplateRequest(); +signatureRequestEditWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestEditWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditWithTemplateRequest.testMode = true; +signatureRequestEditWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditWithTemplateRequest.signers = signers; +signatureRequestEditWithTemplateRequest.ccs = ccs; +signatureRequestEditWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts b/sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts new file mode 100644 index 000000000..58630aeaa --- /dev/null +++ b/sandbox/node/src/SignatureRequestFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts b/sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts new file mode 100644 index 000000000..5ca65d932 --- /dev/null +++ b/sandbox/node/src/SignatureRequestFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestFilesExample.ts b/sandbox/node/src/SignatureRequestFilesExample.ts new file mode 100644 index 000000000..88762904f --- /dev/null +++ b/sandbox/node/src/SignatureRequestFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf", // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestGetExample.ts b/sandbox/node/src/SignatureRequestGetExample.ts new file mode 100644 index 000000000..05ea209b6 --- /dev/null +++ b/sandbox/node/src/SignatureRequestGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestListExample.ts b/sandbox/node/src/SignatureRequestListExample.ts new file mode 100644 index 000000000..20d63eddb --- /dev/null +++ b/sandbox/node/src/SignatureRequestListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestReleaseHoldExample.ts b/sandbox/node/src/SignatureRequestReleaseHoldExample.ts new file mode 100644 index 000000000..3dca1e10d --- /dev/null +++ b/sandbox/node/src/SignatureRequestReleaseHoldExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestReleaseHold:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestRemindExample.ts b/sandbox/node/src/SignatureRequestRemindExample.ts new file mode 100644 index 000000000..fa558c1d6 --- /dev/null +++ b/sandbox/node/src/SignatureRequestRemindExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestRemindRequest = new models.SignatureRequestRemindRequest(); +signatureRequestRemindRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemind:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestRemoveExample.ts b/sandbox/node/src/SignatureRequestRemoveExample.ts new file mode 100644 index 000000000..7f76eb5a2 --- /dev/null +++ b/sandbox/node/src/SignatureRequestRemoveExample.ts @@ -0,0 +1,13 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +apiCaller.signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemove:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestSendExample.ts b/sandbox/node/src/SignatureRequestSendExample.ts new file mode 100644 index 000000000..c742336fa --- /dev/null +++ b/sandbox/node/src/SignatureRequestSendExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.signers = signers; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts b/sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts new file mode 100644 index 000000000..d7414588a --- /dev/null +++ b/sandbox/node/src/SignatureRequestSendGroupedSignersExample.ts @@ -0,0 +1,87 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const groupedSigners2Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers1.name = "Bob"; +groupedSigners2Signers1.emailAddress = "bob@example.com"; + +const groupedSigners2Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners2Signers2.name = "Charlie"; +groupedSigners2Signers2.emailAddress = "charlie@example.com"; + +const groupedSigners2Signers = [ + groupedSigners2Signers1, + groupedSigners2Signers2, +]; + +const groupedSigners1Signers1 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers1.name = "Jack"; +groupedSigners1Signers1.emailAddress = "jack@example.com"; + +const groupedSigners1Signers2 = new models.SubSignatureRequestSigner(); +groupedSigners1Signers2.name = "Jill"; +groupedSigners1Signers2.emailAddress = "jill@example.com"; + +const groupedSigners1Signers = [ + groupedSigners1Signers1, + groupedSigners1Signers2, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const groupedSigners1 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners1.group = "Group #1"; +groupedSigners1.order = 0; +groupedSigners1.signers = groupedSigners1Signers; + +const groupedSigners2 = new models.SubSignatureRequestGroupedSigners(); +groupedSigners2.group = "Group #2"; +groupedSigners2.order = 1; +groupedSigners2.signers = groupedSigners2Signers; + +const groupedSigners = [ + groupedSigners1, + groupedSigners2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.groupedSigners = groupedSigners; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts b/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts new file mode 100644 index 000000000..181e37a35 --- /dev/null +++ b/sandbox/node/src/SignatureRequestSendWithTemplateExample.ts @@ -0,0 +1,62 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestSendWithTemplateRequest = new models.SignatureRequestSendWithTemplateRequest(); +signatureRequestSendWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestSendWithTemplateRequest.testMode = true; +signatureRequestSendWithTemplateRequest.signingOptions = signingOptions; +signatureRequestSendWithTemplateRequest.signers = signers; +signatureRequestSendWithTemplateRequest.ccs = ccs; +signatureRequestSendWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/SignatureRequestUpdateExample.ts b/sandbox/node/src/SignatureRequestUpdateExample.ts new file mode 100644 index 000000000..fa02e0345 --- /dev/null +++ b/sandbox/node/src/SignatureRequestUpdateExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signatureRequestUpdateRequest = new models.SignatureRequestUpdateRequest(); +signatureRequestUpdateRequest.signatureId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +signatureRequestUpdateRequest.emailAddress = "john@example.com"; + +apiCaller.signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamAddMemberAccountIdExample.ts b/sandbox/node/src/TeamAddMemberAccountIdExample.ts new file mode 100644 index 000000000..6aedbc340 --- /dev/null +++ b/sandbox/node/src/TeamAddMemberAccountIdExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamAddMemberExample.ts b/sandbox/node/src/TeamAddMemberExample.ts new file mode 100644 index 000000000..0ffde9292 --- /dev/null +++ b/sandbox/node/src/TeamAddMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.emailAddress = "george@example.com"; + +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamAddMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamCreateExample.ts b/sandbox/node/src/TeamCreateExample.ts new file mode 100644 index 000000000..22ad05f83 --- /dev/null +++ b/sandbox/node/src/TeamCreateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamCreateRequest = new models.TeamCreateRequest(); +teamCreateRequest.name = "New Team Name"; + +apiCaller.teamCreate( + teamCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamDeleteExample.ts b/sandbox/node/src/TeamDeleteExample.ts new file mode 100644 index 000000000..c37216b0c --- /dev/null +++ b/sandbox/node/src/TeamDeleteExample.ts @@ -0,0 +1,12 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamDelete().catch(error => { + console.log("Exception when calling TeamApi#teamDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamGetExample.ts b/sandbox/node/src/TeamGetExample.ts new file mode 100644 index 000000000..65d8758fc --- /dev/null +++ b/sandbox/node/src/TeamGetExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamGet().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamInfoExample.ts b/sandbox/node/src/TeamInfoExample.ts new file mode 100644 index 000000000..d0050e94c --- /dev/null +++ b/sandbox/node/src/TeamInfoExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInfo:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamInvitesExample.ts b/sandbox/node/src/TeamInvitesExample.ts new file mode 100644 index 000000000..7debb4877 --- /dev/null +++ b/sandbox/node/src/TeamInvitesExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamInvites().then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamInvites:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamMembersExample.ts b/sandbox/node/src/TeamMembersExample.ts new file mode 100644 index 000000000..17479dbda --- /dev/null +++ b/sandbox/node/src/TeamMembersExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamMembers:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamRemoveMemberAccountIdExample.ts b/sandbox/node/src/TeamRemoveMemberAccountIdExample.ts new file mode 100644 index 000000000..e170817b3 --- /dev/null +++ b/sandbox/node/src/TeamRemoveMemberAccountIdExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.accountId = "f57db65d3f933b5316d398057a36176831451a35"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamRemoveMemberExample.ts b/sandbox/node/src/TeamRemoveMemberExample.ts new file mode 100644 index 000000000..efd33d694 --- /dev/null +++ b/sandbox/node/src/TeamRemoveMemberExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.emailAddress = "teammate@dropboxsign.com"; +teamRemoveMemberRequest.newOwnerEmailAddress = "new_teammate@dropboxsign.com"; + +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamRemoveMember:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamSubTeamsExample.ts b/sandbox/node/src/TeamSubTeamsExample.ts new file mode 100644 index 000000000..e6ef9c8da --- /dev/null +++ b/sandbox/node/src/TeamSubTeamsExample.ts @@ -0,0 +1,18 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20, // pageSize +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamSubTeams:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TeamUpdateExample.ts b/sandbox/node/src/TeamUpdateExample.ts new file mode 100644 index 000000000..0e32bcdd4 --- /dev/null +++ b/sandbox/node/src/TeamUpdateExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const teamUpdateRequest = new models.TeamUpdateRequest(); +teamUpdateRequest.name = "New Team Name"; + +apiCaller.teamUpdate( + teamUpdateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TeamApi#teamUpdate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateAddUserExample.ts b/sandbox/node/src/TemplateAddUserExample.ts new file mode 100644 index 000000000..f801c3e65 --- /dev/null +++ b/sandbox/node/src/TemplateAddUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateAddUserRequest = new models.TemplateAddUserRequest(); +templateAddUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateAddUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts new file mode 100644 index 000000000..6371fcd18 --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftExample.ts @@ -0,0 +1,61 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts new file mode 100644 index 000000000..5bdb6384f --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldGroups = formFieldGroups; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts new file mode 100644 index 000000000..ce20fc91d --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldRules = formFieldRules; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..0ce2cbcd4 --- /dev/null +++ b/sandbox/node/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateExample.ts b/sandbox/node/src/TemplateCreateExample.ts new file mode 100644 index 000000000..c17b780a9 --- /dev/null +++ b/sandbox/node/src/TemplateCreateExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts b/sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..e12c74953 --- /dev/null +++ b/sandbox/node/src/TemplateCreateFormFieldGroupsExample.ts @@ -0,0 +1,107 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldGroups = formFieldGroups; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateFormFieldRulesExample.ts b/sandbox/node/src/TemplateCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..31a949aea --- /dev/null +++ b/sandbox/node/src/TemplateCreateFormFieldRulesExample.ts @@ -0,0 +1,123 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.formFieldRules = formFieldRules; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts b/sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..d580e665b --- /dev/null +++ b/sandbox/node/src/TemplateCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,95 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateDeleteExample.ts b/sandbox/node/src/TemplateDeleteExample.ts new file mode 100644 index 000000000..3f0aae438 --- /dev/null +++ b/sandbox/node/src/TemplateDeleteExample.ts @@ -0,0 +1,14 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateDelete( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).catch(error => { + console.log("Exception when calling TemplateApi#templateDelete:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateFilesAsDataUriExample.ts b/sandbox/node/src/TemplateFilesAsDataUriExample.ts new file mode 100644 index 000000000..40a8e2ac0 --- /dev/null +++ b/sandbox/node/src/TemplateFilesAsDataUriExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsDataUri:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateFilesAsFileUrlExample.ts b/sandbox/node/src/TemplateFilesAsFileUrlExample.ts new file mode 100644 index 000000000..e80f1ad91 --- /dev/null +++ b/sandbox/node/src/TemplateFilesAsFileUrlExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1, // forceDownload +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFilesAsFileUrl:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateFilesExample.ts b/sandbox/node/src/TemplateFilesExample.ts new file mode 100644 index 000000000..923f16d56 --- /dev/null +++ b/sandbox/node/src/TemplateFilesExample.ts @@ -0,0 +1,17 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + undefined, // fileType +).then(response => { + fs.createWriteStream('./file_response').write(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateGetExample.ts b/sandbox/node/src/TemplateGetExample.ts new file mode 100644 index 000000000..b4fcdda6c --- /dev/null +++ b/sandbox/node/src/TemplateGetExample.ts @@ -0,0 +1,16 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateGet( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateGet:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateListExample.ts b/sandbox/node/src/TemplateListExample.ts new file mode 100644 index 000000000..e678a6c26 --- /dev/null +++ b/sandbox/node/src/TemplateListExample.ts @@ -0,0 +1,19 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +apiCaller.templateList( + undefined, // accountId + 1, // page + 20, // pageSize + undefined, // query +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateList:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateRemoveUserExample.ts b/sandbox/node/src/TemplateRemoveUserExample.ts new file mode 100644 index 000000000..f896f81e1 --- /dev/null +++ b/sandbox/node/src/TemplateRemoveUserExample.ts @@ -0,0 +1,20 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateRemoveUserRequest = new models.TemplateRemoveUserRequest(); +templateRemoveUserRequest.emailAddress = "george@dropboxsign.com"; + +apiCaller.templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateRemoveUser:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/TemplateUpdateFilesExample.ts b/sandbox/node/src/TemplateUpdateFilesExample.ts new file mode 100644 index 000000000..139a53fff --- /dev/null +++ b/sandbox/node/src/TemplateUpdateFilesExample.ts @@ -0,0 +1,22 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateUpdateFilesRequest = new models.TemplateUpdateFilesRequest(); +templateUpdateFilesRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling TemplateApi#templateUpdateFiles:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts new file mode 100644 index 000000000..d17be1564 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedExample.ts @@ -0,0 +1,24 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = true; +unclaimedDraftCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts new file mode 100644 index 000000000..bb10352f4 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.ts @@ -0,0 +1,70 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts new file mode 100644 index 000000000..8223f693e --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.ts @@ -0,0 +1,86 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..66efc0596 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.ts @@ -0,0 +1,58 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = false; +unclaimedDraftCreateEmbeddedRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts b/sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts new file mode 100644 index 000000000..8e78741d8 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts @@ -0,0 +1,43 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@dropboxsign.com"; + +const ccs = [ + ccs1, +]; + +const signers1 = new models.SubUnclaimedDraftTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateEmbeddedWithTemplateRequest = new models.UnclaimedDraftCreateEmbeddedWithTemplateRequest(); +unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode = false; +unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs = ccs; +unclaimedDraftCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateExample.ts b/sandbox/node/src/UnclaimedDraftCreateExample.ts new file mode 100644 index 000000000..dc23f50d2 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateExample.ts @@ -0,0 +1,33 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signers1 = new models.SubUnclaimedDraftSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = true; +unclaimedDraftCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +unclaimedDraftCreateRequest.signers = signers; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts b/sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts new file mode 100644 index 000000000..f3e47da2c --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateFormFieldGroupsExample.ts @@ -0,0 +1,69 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldGroups1 = new models.SubFormFieldGroup(); +formFieldGroups1.groupId = "RadioItemGroup1"; +formFieldGroups1.groupLabel = "Radio Item Group 1"; +formFieldGroups1.requirement = "require_0-1"; + +const formFieldGroups = [ + formFieldGroups1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "radio"; +formFieldsPerDocument1.required = false; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 18; +formFieldsPerDocument1.height = 18; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.group = "RadioItemGroup1"; +formFieldsPerDocument1.isChecked = true; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentRadio(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "radio"; +formFieldsPerDocument2.required = false; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 18; +formFieldsPerDocument2.height = 18; +formFieldsPerDocument2.x = 112; +formFieldsPerDocument2.y = 370; +formFieldsPerDocument2.group = "RadioItemGroup1"; +formFieldsPerDocument2.isChecked = false; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldGroups = formFieldGroups; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts b/sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts new file mode 100644 index 000000000..c4abba3b1 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateFormFieldRulesExample.ts @@ -0,0 +1,85 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldRules1Triggers1 = new models.SubFormFieldRuleTrigger(); +formFieldRules1Triggers1.id = "uniqueIdHere_1"; +formFieldRules1Triggers1.operator = models.SubFormFieldRuleTrigger.OperatorEnum.Is; +formFieldRules1Triggers1.value = "foo"; + +const formFieldRules1Triggers = [ + formFieldRules1Triggers1, +]; + +const formFieldRules1Actions1 = new models.SubFormFieldRuleAction(); +formFieldRules1Actions1.hidden = true; +formFieldRules1Actions1.type = models.SubFormFieldRuleAction.TypeEnum.FieldVisibility; +formFieldRules1Actions1.fieldId = "uniqueIdHere_2"; + +const formFieldRules1Actions = [ + formFieldRules1Actions1, +]; + +const formFieldRules1 = new models.SubFormFieldRule(); +formFieldRules1.id = "rule_1"; +formFieldRules1.triggerOperator = "AND"; +formFieldRules1.triggers = formFieldRules1Triggers; +formFieldRules1.actions = formFieldRules1Actions; + +const formFieldRules = [ + formFieldRules1, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "0"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldRules = formFieldRules; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts b/sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts new file mode 100644 index 000000000..b5e61ab5a --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.ts @@ -0,0 +1,57 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = false; +unclaimedDraftCreateRequest.fileUrls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +]; +unclaimedDraftCreateRequest.formFieldsPerDocument = formFieldsPerDocument; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); + console.log(error.body); +}); diff --git a/sandbox/node/src/UnclaimedDraftEditAndResendExample.ts b/sandbox/node/src/UnclaimedDraftEditAndResendExample.ts new file mode 100644 index 000000000..16a998390 --- /dev/null +++ b/sandbox/node/src/UnclaimedDraftEditAndResendExample.ts @@ -0,0 +1,21 @@ +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftEditAndResendRequest = new models.UnclaimedDraftEditAndResendRequest(); +unclaimedDraftEditAndResendRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftEditAndResendRequest.testMode = false; + +apiCaller.unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest, +).then(response => { + console.log(response.body); +}).catch(error => { + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend:"); + console.log(error.body); +}); diff --git a/sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/node/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/node/test_fixtures/SignatureRequestSendRequest.json b/sandbox/node/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/node/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/node/test_fixtures/pdf-sample.pdf b/sandbox/node/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/node/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sandbox/node/tests/.config.dist.json b/sandbox/node/tests/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/node/tests/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/node/tests/.gitignore b/sandbox/node/tests/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/node/tests/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/node/tests/signatureRequest.test.ts b/sandbox/node/tests/signatureRequest.test.ts deleted file mode 100644 index 73579a528..000000000 --- a/sandbox/node/tests/signatureRequest.test.ts +++ /dev/null @@ -1,140 +0,0 @@ -import "jest"; -import * as DropboxSign from "@dropbox/sign"; -import * as fs from "fs"; - -describe("signatureRequest", () => { - let config: { - BASE_URL: string, - API_KEY: string, - CLIENT_ID: string, - USE_XDEBUG: boolean, - }; - - let headers = {}; - - beforeEach(() => { - const config_custom = require("./.config.json"); - const config_dist = require("./.config.dist.json"); - config = { ...config_dist, ...config_custom }; - - if (config["USE_XDEBUG"]) { - headers = { - "Cookie": "XDEBUG_SESSION=xdebug", - }; - } - }); - - test("testSend", () => { - const signature_request_api = new DropboxSign.SignatureRequestApi(); - signature_request_api.username = config.API_KEY; - signature_request_api.basePath = config.BASE_URL; - signature_request_api.defaultHeaders = headers; - - const data: Partial = require( - "./../test_fixtures/SignatureRequestSendRequest.json", - ); - data["files"] = [fs.createReadStream(__dirname + "/../test_fixtures/pdf-sample.pdf")]; - - const send_request = DropboxSign.SignatureRequestSendRequest.init(data); - - return signature_request_api.signatureRequestSend( - send_request, - ).then(send_response => { - const signature_request = send_response.body.signatureRequest; - - expect(send_request.formFieldsPerDocument![0].apiId) - .toBe(signature_request.customFields![0].apiId); - - expect(send_request.signers![0].emailAddress) - .toBe(signature_request.signatures![0].signerEmailAddress); - expect(send_request.signers![1].emailAddress) - .toBe(signature_request.signatures![1].signerEmailAddress); - expect(send_request.signers![2].emailAddress) - .toBe(signature_request.signatures![2].signerEmailAddress); - - return signature_request_api.signatureRequestGet( - signature_request.signatureRequestId!, - ).then(get_response => { - expect(signature_request.signatureRequestId) - .toBe(get_response.body.signatureRequest.signatureRequestId); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }); - - test("testCreateEmbedded", () => { - const signature_request_api = new DropboxSign.SignatureRequestApi(); - signature_request_api.username = config.API_KEY; - signature_request_api.basePath = config.BASE_URL; - signature_request_api.defaultHeaders = headers; - - const data: Partial = require( - "./../test_fixtures/SignatureRequestCreateEmbeddedRequest.json" - ); - data["files"] = [fs.createReadStream(__dirname + "/../test_fixtures/pdf-sample.pdf")]; - data["clientId"] = config.CLIENT_ID; - - const send_request = DropboxSign.SignatureRequestCreateEmbeddedRequest.init(data); - - return signature_request_api.signatureRequestCreateEmbedded( - send_request, - ).then(send_response => { - const signature_request = send_response.body.signatureRequest; - - expect(send_request.signers![0].emailAddress) - .toBe(signature_request.signatures![0].signerEmailAddress); - expect(send_request.signers![1].emailAddress) - .toBe(signature_request.signatures![1].signerEmailAddress); - expect(send_request.signers![2].emailAddress) - .toBe(signature_request.signatures![2].signerEmailAddress); - - const embedded_api = new DropboxSign.EmbeddedApi(); - embedded_api.username = config.API_KEY; - embedded_api.basePath = config.BASE_URL; - embedded_api.defaultHeaders = headers; - - return embedded_api.embeddedSignUrl( - signature_request.signatures![0].signatureId!, - ).then(get_response => { - expect(get_response.body.embedded.signUrl).toBeTruthy(); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }).catch(error => { - throw new Error(`Should not have thrown: ${error.body}`); - }); - }); - - test.concurrent("testSendWithoutFileError", async () => { - const config_custom = require("./.config.json"); - const config_dist = require("./.config.dist.json"); - config = { ...config_dist, ...config_custom }; - let headers = {}; - - if (config["USE_XDEBUG"]) { - headers = { - "Cookie": "XDEBUG_SESSION=xdebug", - }; - } - - const signature_request_api = new DropboxSign.SignatureRequestApi(); - signature_request_api.username = config.API_KEY; - signature_request_api.basePath = config.BASE_URL; - signature_request_api.defaultHeaders = headers; - - const data: Partial = require( - "./../test_fixtures/SignatureRequestSendRequest.json", - ); - - const request = DropboxSign.SignatureRequestSendRequest.init(data); - - return signature_request_api.signatureRequestSend(request).then(response => { - expect(response).toBeFalsy(); - }).catch((error: DropboxSign.HttpError) => { - expect(error.body.error.errorPath).toEqual("file"); - }); - }); -}); diff --git a/sandbox/node/tsconfig.json b/sandbox/node/tsconfig.json new file mode 100644 index 000000000..d7a0cd511 --- /dev/null +++ b/sandbox/node/tsconfig.json @@ -0,0 +1,32 @@ +{ + "compilerOptions": { + "module": "commonjs", + "noImplicitAny": false, + "suppressImplicitAnyIndexErrors": true, + "target": "ES6", + "allowSyntheticDefaultImports": true, + "esModuleInterop": true, + "strict": true, + "moduleResolution": "node", + "removeComments": true, + "sourceMap": true, + "noLib": false, + "declaration": true, + "emitDeclarationOnly": true, + "lib": [ + "dom", + "es6", + "es5", + "dom.iterable", + "scripthost" + ], + "typeRoots": [ + "node_modules/@types" + ], + "resolveJsonModule": true + }, + "exclude": [ + "*.tgz", + "node_modules" + ] +} diff --git a/sandbox/php/.gitignore b/sandbox/php/.gitignore new file mode 100644 index 000000000..987e2a253 --- /dev/null +++ b/sandbox/php/.gitignore @@ -0,0 +1,2 @@ +composer.lock +vendor diff --git a/sandbox/php/Example.php b/sandbox/php/Example.php deleted file mode 100644 index 39de49e79..000000000 --- a/sandbox/php/Example.php +++ /dev/null @@ -1,25 +0,0 @@ -setUsername("YOUR_API_KEY"); - -// or, configure Bearer (JWT) authorization: oauth2 -// $config->setAccessToken("YOUR_ACCESS_TOKEN"); - -$api = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); - -try { - $result = $api->accountCreate($data); - print_r($result); -} catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); -} diff --git a/sandbox/php/composer.json b/sandbox/php/composer.json index ab722a292..163ae9dac 100644 --- a/sandbox/php/composer.json +++ b/sandbox/php/composer.json @@ -2,7 +2,7 @@ "name": "dropbox/sign-sandbox", "autoload": { "psr-4": { - "Dropbox\\SignSandbox\\Tests\\": "test" + "Dropbox\\SignSandbox\\": "src" } }, "require": { diff --git a/sandbox/php/src/AccountCreateExample.php b/sandbox/php/src/AccountCreateExample.php new file mode 100644 index 000000000..736fb3cc6 --- /dev/null +++ b/sandbox/php/src/AccountCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountCreateOauthExample.php b/sandbox/php/src/AccountCreateOauthExample.php new file mode 100644 index 000000000..0c4898be2 --- /dev/null +++ b/sandbox/php/src/AccountCreateOauthExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com") + ->setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountGetExample.php b/sandbox/php/src/AccountGetExample.php new file mode 100644 index 000000000..96b594d7e --- /dev/null +++ b/sandbox/php/src/AccountGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountUpdateExample.php b/sandbox/php/src/AccountUpdateExample.php new file mode 100644 index 000000000..64a1ad38d --- /dev/null +++ b/sandbox/php/src/AccountUpdateExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest()) + ->setCallbackUrl("https://www.example.com/callback") + ->setLocale("en-US"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate( + account_update_request: $account_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/AccountVerifyExample.php b/sandbox/php/src/AccountVerifyExample.php new file mode 100644 index 000000000..acdee34e7 --- /dev/null +++ b/sandbox/php/src/AccountVerifyExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest()) + ->setEmailAddress("some_user@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify( + account_verify_request: $account_verify_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppCreateExample.php b/sandbox/php/src/ApiAppCreateExample.php new file mode 100644 index 000000000..7ec68a6f5 --- /dev/null +++ b/sandbox/php/src/ApiAppCreateExample.php @@ -0,0 +1,42 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_create_request = (new Dropbox\Sign\Model\ApiAppCreateRequest()) + ->setName("My Production App") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppCreate( + api_app_create_request: $api_app_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppDeleteExample.php b/sandbox/php/src/ApiAppDeleteExample.php new file mode 100644 index 000000000..0734efaf9 --- /dev/null +++ b/sandbox/php/src/ApiAppDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppDelete( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppGetExample.php b/sandbox/php/src/ApiAppGetExample.php new file mode 100644 index 000000000..f4dcc571b --- /dev/null +++ b/sandbox/php/src/ApiAppGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppGet( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppListExample.php b/sandbox/php/src/ApiAppListExample.php new file mode 100644 index 000000000..6e9a8e5cb --- /dev/null +++ b/sandbox/php/src/ApiAppListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ApiAppUpdateExample.php b/sandbox/php/src/ApiAppUpdateExample.php new file mode 100644 index 000000000..30c22c4eb --- /dev/null +++ b/sandbox/php/src/ApiAppUpdateExample.php @@ -0,0 +1,44 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$oauth = (new Dropbox\Sign\Model\SubOAuth()) + ->setCallbackUrl("https://example.com/oauth") + ->setScopes([ + Dropbox\Sign\Model\SubOAuth::SCOPES_BASIC_ACCOUNT_INFO, + Dropbox\Sign\Model\SubOAuth::SCOPES_REQUEST_SIGNATURE, + ]); + +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") + ->setPrimaryButtonTextColor("#ffffff"); + +$api_app_update_request = (new Dropbox\Sign\Model\ApiAppUpdateRequest()) + ->setCallbackUrl("https://example.com/dropboxsign") + ->setName("New Name") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); + +try { + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppUpdate( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request: $api_app_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ApiAppApi#apiAppUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/BulkSendJobGetExample.php b/sandbox/php/src/BulkSendJobGetExample.php new file mode 100644 index 000000000..8b74043d9 --- /dev/null +++ b/sandbox/php/src/BulkSendJobGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobGet( + bulk_send_job_id: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/BulkSendJobListExample.php b/sandbox/php/src/BulkSendJobListExample.php new file mode 100644 index 000000000..9a566d561 --- /dev/null +++ b/sandbox/php/src/BulkSendJobListExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling BulkSendJobApi#bulkSendJobList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/EmbeddedEditUrlExample.php b/sandbox/php/src/EmbeddedEditUrlExample.php new file mode 100644 index 000000000..cae4929eb --- /dev/null +++ b/sandbox/php/src/EmbeddedEditUrlExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$merge_fields = [ +]; + +$embedded_edit_url_request = (new Dropbox\Sign\Model\EmbeddedEditUrlRequest()) + ->setCcRoles([ + "", + ]) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedEditUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request: $embedded_edit_url_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedEditUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/EmbeddedSignUrlExample.php b/sandbox/php/src/EmbeddedSignUrlExample.php new file mode 100644 index 000000000..b055ac6ed --- /dev/null +++ b/sandbox/php/src/EmbeddedSignUrlExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedSignUrl( + signature_id: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling EmbeddedApi#embeddedSignUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/EventCallbackExample.php b/sandbox/php/src/EventCallbackExample.php new file mode 100644 index 000000000..4a21d5cbf --- /dev/null +++ b/sandbox/php/src/EventCallbackExample.php @@ -0,0 +1,35 @@ + [ + "event_type" => "account_confirmed", + "event_time" => "1669926463", + "event_hash" => "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + "event_metadata" => [ + "related_signature_id" => null, + "reported_for_account_id" => "6421d70b9bd45059fa207d03ab8d1b96515b472c", + "reported_for_app_id" => null, + "event_message" => null, + ], + ], +]; + +$callback_event = Dropbox\Sign\Model\EventCallbackRequest::init($callback_data); + +// verify that a callback came from HelloSign.com +if (Dropbox\Sign\EventCallbackHelper::isValid($api_key, $callback_event)) { + // one of "account_callback" or "api_app_callback" + $callback_type = Dropbox\Sign\EventCallbackHelper::getCallbackType($callback_event); + + // do your magic below! +} diff --git a/sandbox/php/src/FaxDeleteExample.php b/sandbox/php/src/FaxDeleteExample.php new file mode 100644 index 000000000..96ba3c0d7 --- /dev/null +++ b/sandbox/php/src/FaxDeleteExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\FaxApi(config: $config))->faxDelete( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxFilesExample.php b/sandbox/php/src/FaxFilesExample.php new file mode 100644 index 000000000..01322d769 --- /dev/null +++ b/sandbox/php/src/FaxFilesExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxFiles( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxGetExample.php b/sandbox/php/src/FaxGetExample.php new file mode 100644 index 000000000..50bb7c865 --- /dev/null +++ b/sandbox/php/src/FaxGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxGet( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineAddUserExample.php b/sandbox/php/src/FaxLineAddUserExample.php new file mode 100644 index 000000000..cca56e766 --- /dev/null +++ b/sandbox/php/src/FaxLineAddUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_add_user_request = (new Dropbox\Sign\Model\FaxLineAddUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAddUser( + fax_line_add_user_request: $fax_line_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAddUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineAreaCodeGetExample.php b/sandbox/php/src/FaxLineAreaCodeGetExample.php new file mode 100644 index 000000000..dfd46d313 --- /dev/null +++ b/sandbox/php/src/FaxLineAreaCodeGetExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineAreaCodeGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineCreateExample.php b/sandbox/php/src/FaxLineCreateExample.php new file mode 100644 index 000000000..0a5ef5ec6 --- /dev/null +++ b/sandbox/php/src/FaxLineCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_create_request = (new Dropbox\Sign\Model\FaxLineCreateRequest()) + ->setAreaCode(209) + ->setCountry(Dropbox\Sign\Model\FaxLineCreateRequest::COUNTRY_US); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineCreate( + fax_line_create_request: $fax_line_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineDeleteExample.php b/sandbox/php/src/FaxLineDeleteExample.php new file mode 100644 index 000000000..080db2960 --- /dev/null +++ b/sandbox/php/src/FaxLineDeleteExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_delete_request = (new Dropbox\Sign\Model\FaxLineDeleteRequest()) + ->setNumber("[FAX_NUMBER]"); + +try { + (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineDelete( + fax_line_delete_request: $fax_line_delete_request, + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineGetExample.php b/sandbox/php/src/FaxLineGetExample.php new file mode 100644 index 000000000..70004942a --- /dev/null +++ b/sandbox/php/src/FaxLineGetExample.php @@ -0,0 +1,21 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineGet( + number: "123-123-1234", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineListExample.php b/sandbox/php/src/FaxLineListExample.php new file mode 100644 index 000000000..995c0d949 --- /dev/null +++ b/sandbox/php/src/FaxLineListExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineList( + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxLineRemoveUserExample.php b/sandbox/php/src/FaxLineRemoveUserExample.php new file mode 100644 index 000000000..95d117971 --- /dev/null +++ b/sandbox/php/src/FaxLineRemoveUserExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); + +$fax_line_remove_user_request = (new Dropbox\Sign\Model\FaxLineRemoveUserRequest()) + ->setNumber("[FAX_NUMBER]") + ->setEmailAddress("member@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineRemoveUser( + fax_line_remove_user_request: $fax_line_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxLineApi#faxLineRemoveUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxListExample.php b/sandbox/php/src/FaxListExample.php new file mode 100644 index 000000000..c0d432351 --- /dev/null +++ b/sandbox/php/src/FaxListExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxList( + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/FaxSendExample.php b/sandbox/php/src/FaxSendExample.php new file mode 100644 index 000000000..707e8ce25 --- /dev/null +++ b/sandbox/php/src/FaxSendExample.php @@ -0,0 +1,32 @@ +setUsername("YOUR_API_KEY"); + +$fax_send_request = (new Dropbox\Sign\Model\FaxSendRequest()) + ->setRecipient("16690000001") + ->setSender("16690000000") + ->setTestMode(true) + ->setCoverPageTo("Jill Fax") + ->setCoverPageFrom("Faxer Faxerson") + ->setCoverPageMessage("I'm sending you a fax!") + ->setTitle("This is what the fax is about!") + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxSend( + fax_send_request: $fax_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling FaxApi#faxSend: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/OauthTokenGenerateExample.php b/sandbox/php/src/OauthTokenGenerateExample.php new file mode 100644 index 000000000..9b2df4a08 --- /dev/null +++ b/sandbox/php/src/OauthTokenGenerateExample.php @@ -0,0 +1,27 @@ +setClientId("cc91c61d00f8bb2ece1428035716b") + ->setClientSecret("1d14434088507ffa390e6f5528465") + ->setCode("1b0d28d90c86c141") + ->setState("900e06e2") + ->setGrantType("authorization_code"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenGenerate( + o_auth_token_generate_request: $o_auth_token_generate_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenGenerate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/OauthTokenRefreshExample.php b/sandbox/php/src/OauthTokenRefreshExample.php new file mode 100644 index 000000000..519db72d1 --- /dev/null +++ b/sandbox/php/src/OauthTokenRefreshExample.php @@ -0,0 +1,24 @@ +setGrantType("refresh_token") + ->setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + +try { + $response = (new Dropbox\Sign\Api\OAuthApi(config: $config))->oauthTokenRefresh( + o_auth_token_refresh_request: $o_auth_token_refresh_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling OAuthApi#oauthTokenRefresh: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/ReportCreateExample.php b/sandbox/php/src/ReportCreateExample.php new file mode 100644 index 000000000..18d8d09ea --- /dev/null +++ b/sandbox/php/src/ReportCreateExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); + +$report_create_request = (new Dropbox\Sign\Model\ReportCreateRequest()) + ->setStartDate("09/01/2020") + ->setEndDate("09/01/2020") + ->setReportType([ + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_USER_ACTIVITY, + Dropbox\Sign\Model\ReportCreateRequest::REPORT_TYPE_DOCUMENT_STATUS, + ]); + +try { + $response = (new Dropbox\Sign\Api\ReportApi(config: $config))->reportCreate( + report_create_request: $report_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling ReportApi#reportCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..1727df311 --- /dev/null +++ b/sandbox/php/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest()) + ->setClientId("1a659d9ad95bccd307ecad78d72192f8") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkCreateEmbeddedWithTemplate( + signature_request_bulk_create_embedded_with_template_request: $signature_request_bulk_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php b/sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php new file mode 100644 index 000000000..7574361ff --- /dev/null +++ b/sandbox/php/src/SignatureRequestBulkSendWithTemplateExample.php @@ -0,0 +1,89 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signer_list_2_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("123 LLC"); + +$signer_list_2_custom_fields = [ + $signer_list_2_custom_fields_1, +]; + +$signer_list_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("Mary") + ->setEmailAddress("mary@example.com") + ->setPin("gd9as5b"); + +$signer_list_2_signers = [ + $signer_list_2_signers_1, +]; + +$signer_list_1_custom_fields_1 = (new Dropbox\Sign\Model\SubBulkSignerListCustomField()) + ->setName("company") + ->setValue("ABC Corp"); + +$signer_list_1_custom_fields = [ + $signer_list_1_custom_fields_1, +]; + +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com") + ->setPin("d79a3td"); + +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; + +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); + +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); + +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$signature_request_bulk_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest()) + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestBulkSendWithTemplate( + signature_request_bulk_send_with_template_request: $signature_request_bulk_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCancelExample.php b/sandbox/php/src/SignatureRequestCancelExample.php new file mode 100644 index 000000000..969a67683 --- /dev/null +++ b/sandbox/php/src/SignatureRequestCancelExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCancel( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCancel: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php new file mode 100644 index 000000000..61d74044e --- /dev/null +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedExample.php @@ -0,0 +1,59 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..f7ea5d39a --- /dev/null +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedGroupedSignersExample.php @@ -0,0 +1,86 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_create_embedded_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbedded( + signature_request_create_embedded_request: $signature_request_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..3ff0454e8 --- /dev/null +++ b/sandbox/php/src/SignatureRequestCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCreateEmbeddedWithTemplate( + signature_request_create_embedded_with_template_request: $signature_request_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedExample.php new file mode 100644 index 000000000..868c62562 --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditEmbeddedExample.php @@ -0,0 +1,60 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php new file mode 100644 index 000000000..08ebeac0a --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditEmbeddedGroupedSignersExample.php @@ -0,0 +1,87 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_embedded_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbedded( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request: $signature_request_edit_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php b/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..640f35dfc --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditEmbeddedWithTemplateExample.php @@ -0,0 +1,50 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditEmbeddedWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request: $signature_request_edit_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditExample.php b/sandbox/php/src/SignatureRequestEditExample.php new file mode 100644 index 000000000..92d3747c5 --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditGroupedSignersExample.php b/sandbox/php/src/SignatureRequestEditGroupedSignersExample.php new file mode 100644 index 000000000..af25d631a --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditGroupedSignersExample.php @@ -0,0 +1,96 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_edit_request = (new Dropbox\Sign\Model\SignatureRequestEditRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEdit( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request: $signature_request_edit_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestEditWithTemplateExample.php b/sandbox/php/src/SignatureRequestEditWithTemplateExample.php new file mode 100644 index 000000000..aa8391c3e --- /dev/null +++ b/sandbox/php/src/SignatureRequestEditWithTemplateExample.php @@ -0,0 +1,69 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_edit_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestEditWithTemplate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request: $signature_request_edit_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestFilesAsDataUriExample.php b/sandbox/php/src/SignatureRequestFilesAsDataUriExample.php new file mode 100644 index 000000000..0d8d71902 --- /dev/null +++ b/sandbox/php/src/SignatureRequestFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsDataUri( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php b/sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php new file mode 100644 index 000000000..feb6ac055 --- /dev/null +++ b/sandbox/php/src/SignatureRequestFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsFileUrl( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestFilesExample.php b/sandbox/php/src/SignatureRequestFilesExample.php new file mode 100644 index 000000000..b11f5ae30 --- /dev/null +++ b/sandbox/php/src/SignatureRequestFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFiles( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type: "pdf", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestGetExample.php b/sandbox/php/src/SignatureRequestGetExample.php new file mode 100644 index 000000000..dfb79eda9 --- /dev/null +++ b/sandbox/php/src/SignatureRequestGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestGet( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestListExample.php b/sandbox/php/src/SignatureRequestListExample.php new file mode 100644 index 000000000..c11043fcf --- /dev/null +++ b/sandbox/php/src/SignatureRequestListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestReleaseHoldExample.php b/sandbox/php/src/SignatureRequestReleaseHoldExample.php new file mode 100644 index 000000000..dcbbd1b31 --- /dev/null +++ b/sandbox/php/src/SignatureRequestReleaseHoldExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestReleaseHold( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestReleaseHold: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestRemindExample.php b/sandbox/php/src/SignatureRequestRemindExample.php new file mode 100644 index 000000000..10b5086a4 --- /dev/null +++ b/sandbox/php/src/SignatureRequestRemindExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_remind_request = (new Dropbox\Sign\Model\SignatureRequestRemindRequest()) + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemind( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request: $signature_request_remind_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemind: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestRemoveExample.php b/sandbox/php/src/SignatureRequestRemoveExample.php new file mode 100644 index 000000000..87ecc7e6f --- /dev/null +++ b/sandbox/php/src/SignatureRequestRemoveExample.php @@ -0,0 +1,19 @@ +setUsername("YOUR_API_KEY"); + +try { + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemove( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestRemove: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestSendExample.php b/sandbox/php/src/SignatureRequestSendExample.php new file mode 100644 index 000000000..f922a579e --- /dev/null +++ b/sandbox/php/src/SignatureRequestSendExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com") + ->setOrder(1); + +$signers = [ + $signers_1, + $signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setFiles([ + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestSendGroupedSignersExample.php b/sandbox/php/src/SignatureRequestSendGroupedSignersExample.php new file mode 100644 index 000000000..bec0368b8 --- /dev/null +++ b/sandbox/php/src/SignatureRequestSendGroupedSignersExample.php @@ -0,0 +1,95 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$grouped_signers_2_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Bob") + ->setEmailAddress("bob@example.com"); + +$grouped_signers_2_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Charlie") + ->setEmailAddress("charlie@example.com"); + +$grouped_signers_2_signers = [ + $grouped_signers_2_signers_1, + $grouped_signers_2_signers_2, +]; + +$grouped_signers_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com"); + +$grouped_signers_1_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) + ->setName("Jill") + ->setEmailAddress("jill@example.com"); + +$grouped_signers_1_signers = [ + $grouped_signers_1_signers_1, + $grouped_signers_1_signers_2, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$grouped_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #1") + ->setOrder(0) + ->setSigners($grouped_signers_1_signers); + +$grouped_signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestGroupedSigners()) + ->setGroup("Group #2") + ->setOrder(1) + ->setSigners($grouped_signers_2_signers); + +$grouped_signers = [ + $grouped_signers_1, + $grouped_signers_2, +]; + +$signature_request_send_request = (new Dropbox\Sign\Model\SignatureRequestSendRequest()) + ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.") + ->setSubject("The NDA we talked about") + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcEmailAddresses([ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ]) + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setGroupedSigners($grouped_signers); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSend( + signature_request_send_request: $signature_request_send_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestSendWithTemplateExample.php b/sandbox/php/src/SignatureRequestSendWithTemplateExample.php new file mode 100644 index 000000000..7c9963cf3 --- /dev/null +++ b/sandbox/php/src/SignatureRequestSendWithTemplateExample.php @@ -0,0 +1,68 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); + +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@example.com"); + +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") + ->setEditor("Client") + ->setRequired(true) + ->setValue('$20,000'); + +$custom_fields = [ + $custom_fields_1, +]; + +$signature_request_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setMessage("Glad we could come to an agreement.") + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestSendWithTemplate( + signature_request_send_with_template_request: $signature_request_send_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/SignatureRequestUpdateExample.php b/sandbox/php/src/SignatureRequestUpdateExample.php new file mode 100644 index 000000000..818add598 --- /dev/null +++ b/sandbox/php/src/SignatureRequestUpdateExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signature_request_update_request = (new Dropbox\Sign\Model\SignatureRequestUpdateRequest()) + ->setSignatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f") + ->setEmailAddress("john@example.com"); + +try { + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestUpdate( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request: $signature_request_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling SignatureRequestApi#signatureRequestUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamAddMemberAccountIdExample.php b/sandbox/php/src/TeamAddMemberAccountIdExample.php new file mode 100644 index 000000000..f864f4437 --- /dev/null +++ b/sandbox/php/src/TeamAddMemberAccountIdExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamAddMemberExample.php b/sandbox/php/src/TeamAddMemberExample.php new file mode 100644 index 000000000..441e34dbe --- /dev/null +++ b/sandbox/php/src/TeamAddMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setEmailAddress("george@example.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamAddMember( + team_add_member_request: $team_add_member_request, + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamCreateExample.php b/sandbox/php/src/TeamCreateExample.php new file mode 100644 index 000000000..aabcac028 --- /dev/null +++ b/sandbox/php/src/TeamCreateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_create_request = (new Dropbox\Sign\Model\TeamCreateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamCreate( + team_create_request: $team_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamDeleteExample.php b/sandbox/php/src/TeamDeleteExample.php new file mode 100644 index 000000000..9c429b748 --- /dev/null +++ b/sandbox/php/src/TeamDeleteExample.php @@ -0,0 +1,18 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TeamApi(config: $config))->teamDelete(); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamGetExample.php b/sandbox/php/src/TeamGetExample.php new file mode 100644 index 000000000..79c6e054d --- /dev/null +++ b/sandbox/php/src/TeamGetExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamGet(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamInfoExample.php b/sandbox/php/src/TeamInfoExample.php new file mode 100644 index 000000000..c908d5182 --- /dev/null +++ b/sandbox/php/src/TeamInfoExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInfo( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInfo: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamInvitesExample.php b/sandbox/php/src/TeamInvitesExample.php new file mode 100644 index 000000000..db9459376 --- /dev/null +++ b/sandbox/php/src/TeamInvitesExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInvites(); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamInvites: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamMembersExample.php b/sandbox/php/src/TeamMembersExample.php new file mode 100644 index 000000000..79c0343b1 --- /dev/null +++ b/sandbox/php/src/TeamMembersExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamMembers( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamMembers: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamRemoveMemberAccountIdExample.php b/sandbox/php/src/TeamRemoveMemberAccountIdExample.php new file mode 100644 index 000000000..90d902633 --- /dev/null +++ b/sandbox/php/src/TeamRemoveMemberAccountIdExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setAccountId("f57db65d3f933b5316d398057a36176831451a35"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamRemoveMemberExample.php b/sandbox/php/src/TeamRemoveMemberExample.php new file mode 100644 index 000000000..3212aa335 --- /dev/null +++ b/sandbox/php/src/TeamRemoveMemberExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setEmailAddress("teammate@dropboxsign.com") + ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamRemoveMember( + team_remove_member_request: $team_remove_member_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamSubTeamsExample.php b/sandbox/php/src/TeamSubTeamsExample.php new file mode 100644 index 000000000..ae7a990e2 --- /dev/null +++ b/sandbox/php/src/TeamSubTeamsExample.php @@ -0,0 +1,24 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamSubTeams( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + page_size: 20, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamSubTeams: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TeamUpdateExample.php b/sandbox/php/src/TeamUpdateExample.php new file mode 100644 index 000000000..3338af6e6 --- /dev/null +++ b/sandbox/php/src/TeamUpdateExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$team_update_request = (new Dropbox\Sign\Model\TeamUpdateRequest()) + ->setName("New Team Name"); + +try { + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamUpdate( + team_update_request: $team_update_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TeamApi#teamUpdate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateAddUserExample.php b/sandbox/php/src/TemplateAddUserExample.php new file mode 100644 index 000000000..a76613a1d --- /dev/null +++ b/sandbox/php/src/TemplateAddUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_add_user_request = (new Dropbox\Sign\Model\TemplateAddUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateAddUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request: $template_add_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateAddUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftExample.php new file mode 100644 index 000000000..bf035f3cb --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftExample.php @@ -0,0 +1,66 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php new file mode 100644 index 000000000..120c310df --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php new file mode 100644 index 000000000..5456b67fc --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..6dc4c93c7 --- /dev/null +++ b/sandbox/php/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$template_create_embedded_draft_request = (new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreateEmbeddedDraft( + template_create_embedded_draft_request: $template_create_embedded_draft_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateExample.php b/sandbox/php/src/TemplateCreateExample.php new file mode 100644 index 000000000..93b6dedd0 --- /dev/null +++ b/sandbox/php/src/TemplateCreateExample.php @@ -0,0 +1,100 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateFormFieldGroupsExample.php b/sandbox/php/src/TemplateCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..1c0e02063 --- /dev/null +++ b/sandbox/php/src/TemplateCreateFormFieldGroupsExample.php @@ -0,0 +1,113 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldGroups($form_field_groups) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateFormFieldRulesExample.php b/sandbox/php/src/TemplateCreateFormFieldRulesExample.php new file mode 100644 index 000000000..74009f900 --- /dev/null +++ b/sandbox/php/src/TemplateCreateFormFieldRulesExample.php @@ -0,0 +1,129 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setFormFieldRules($form_field_rules) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php b/sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..a4f60e965 --- /dev/null +++ b/sandbox/php/src/TemplateCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,101 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); + +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") + ->setOrder(0); + +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") + ->setOrder(1); + +$signer_roles = [ + $signer_roles_1, + $signer_roles_2, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); + +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") + ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); + +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; + +$template_create_request = (new Dropbox\Sign\Model\TemplateCreateRequest()) + ->setClientId("37dee8d8440c66d54cfa05d92c160882") + ->setMessage("For your approval") + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setCcRoles([ + "Manager", + ]) + ->setFieldOptions($field_options) + ->setSignerRoles($signer_roles) + ->setFormFieldsPerDocument($form_fields_per_document) + ->setMergeFields($merge_fields); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateDeleteExample.php b/sandbox/php/src/TemplateDeleteExample.php new file mode 100644 index 000000000..63c7a6a72 --- /dev/null +++ b/sandbox/php/src/TemplateDeleteExample.php @@ -0,0 +1,20 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateDelete( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateDelete: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateFilesAsDataUriExample.php b/sandbox/php/src/TemplateFilesAsDataUriExample.php new file mode 100644 index 000000000..df19ef818 --- /dev/null +++ b/sandbox/php/src/TemplateFilesAsDataUriExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsDataUri( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsDataUri: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateFilesAsFileUrlExample.php b/sandbox/php/src/TemplateFilesAsFileUrlExample.php new file mode 100644 index 000000000..d4fb8f53c --- /dev/null +++ b/sandbox/php/src/TemplateFilesAsFileUrlExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsFileUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + force_download: 1, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFilesAsFileUrl: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateFilesExample.php b/sandbox/php/src/TemplateFilesExample.php new file mode 100644 index 000000000..c9d7d5307 --- /dev/null +++ b/sandbox/php/src/TemplateFilesExample.php @@ -0,0 +1,23 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + file_type: null, + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateGetExample.php b/sandbox/php/src/TemplateGetExample.php new file mode 100644 index 000000000..3625ff5a4 --- /dev/null +++ b/sandbox/php/src/TemplateGetExample.php @@ -0,0 +1,22 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateGet( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateGet: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateListExample.php b/sandbox/php/src/TemplateListExample.php new file mode 100644 index 000000000..536c2a630 --- /dev/null +++ b/sandbox/php/src/TemplateListExample.php @@ -0,0 +1,25 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateRemoveUserExample.php b/sandbox/php/src/TemplateRemoveUserExample.php new file mode 100644 index 000000000..ecd5770f4 --- /dev/null +++ b/sandbox/php/src/TemplateRemoveUserExample.php @@ -0,0 +1,26 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_remove_user_request = (new Dropbox\Sign\Model\TemplateRemoveUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateRemoveUser( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request: $template_remove_user_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateRemoveUser: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/TemplateUpdateFilesExample.php b/sandbox/php/src/TemplateUpdateFilesExample.php new file mode 100644 index 000000000..26470da0f --- /dev/null +++ b/sandbox/php/src/TemplateUpdateFilesExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$template_update_files_request = (new Dropbox\Sign\Model\TemplateUpdateFilesRequest()) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateUpdateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request: $template_update_files_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling TemplateApi#templateUpdateFiles: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php new file mode 100644 index 000000000..4ad74cf2c --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedExample.php @@ -0,0 +1,29 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(true) + ->setFiles([ + ]); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php new file mode 100644 index 000000000..c56719913 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.php @@ -0,0 +1,76 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php new file mode 100644 index 000000000..2280c7252 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.php @@ -0,0 +1,92 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..249c7eacb --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.php @@ -0,0 +1,64 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbedded( + unclaimed_draft_create_embedded_request: $unclaimed_draft_create_embedded_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php b/sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php new file mode 100644 index 000000000..d51e60ee7 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.php @@ -0,0 +1,49 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@dropboxsign.com"); + +$ccs = [ + $ccs_1, +]; + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_embedded_with_template_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setRequesterEmailAddress("jack@dropboxsign.com") + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setTestMode(false) + ->setCcs($ccs) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreateEmbeddedWithTemplate( + unclaimed_draft_create_embedded_with_template_request: $unclaimed_draft_create_embedded_with_template_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateExample.php b/sandbox/php/src/UnclaimedDraftCreateExample.php new file mode 100644 index 000000000..8aa132af0 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateExample.php @@ -0,0 +1,38 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftSigner()) + ->setName("Jack") + ->setEmailAddress("jack@example.com") + ->setOrder(0); + +$signers = [ + $signers_1, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(true) + ->setFiles([ + ]) + ->setSigners($signers); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php b/sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php new file mode 100644 index 000000000..92ec35b20 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateFormFieldGroupsExample.php @@ -0,0 +1,75 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_groups_1 = (new Dropbox\Sign\Model\SubFormFieldGroup()) + ->setGroupId("RadioItemGroup1") + ->setGroupLabel("Radio Item Group 1") + ->setRequirement("require_0-1"); + +$form_field_groups = [ + $form_field_groups_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(328) + ->setGroup("RadioItemGroup1") + ->setIsChecked(true) + ->setName("") + ->setPage(1); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentRadio()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("radio") + ->setRequired(false) + ->setSigner("0") + ->setWidth(18) + ->setHeight(18) + ->setX(112) + ->setY(370) + ->setGroup("RadioItemGroup1") + ->setIsChecked(false) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldGroups($form_field_groups) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php b/sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php new file mode 100644 index 000000000..a58ad4d10 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateFormFieldRulesExample.php @@ -0,0 +1,91 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_field_rules_1_triggers_1 = (new Dropbox\Sign\Model\SubFormFieldRuleTrigger()) + ->setId("uniqueIdHere_1") + ->setOperator(Dropbox\Sign\Model\SubFormFieldRuleTrigger::OPERATOR_IS) + ->setValue("foo"); + +$form_field_rules_1_triggers = [ + $form_field_rules_1_triggers_1, +]; + +$form_field_rules_1_actions_1 = (new Dropbox\Sign\Model\SubFormFieldRuleAction()) + ->setHidden(true) + ->setType(Dropbox\Sign\Model\SubFormFieldRuleAction::TYPE_FIELD_VISIBILITY) + ->setFieldId("uniqueIdHere_2"); + +$form_field_rules_1_actions = [ + $form_field_rules_1_actions_1, +]; + +$form_field_rules_1 = (new Dropbox\Sign\Model\SubFormFieldRule()) + ->setId("rule_1") + ->setTriggerOperator("AND") + ->setTriggers($form_field_rules_1_triggers) + ->setActions($form_field_rules_1_actions); + +$form_field_rules = [ + $form_field_rules_1, +]; + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("0") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldRules($form_field_rules) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php b/sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php new file mode 100644 index 000000000..93e3b015a --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.php @@ -0,0 +1,63 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$form_fields_per_document_1 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentText()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_1") + ->setType("text") + ->setRequired(true) + ->setSigner("1") + ->setWidth(100) + ->setHeight(16) + ->setX(112) + ->setY(328) + ->setName("") + ->setPage(1) + ->setPlaceholder("") + ->setValidationType(Dropbox\Sign\Model\SubFormFieldsPerDocumentText::VALIDATION_TYPE_NUMBERS_ONLY); + +$form_fields_per_document_2 = (new Dropbox\Sign\Model\SubFormFieldsPerDocumentSignature()) + ->setDocumentIndex(0) + ->setApiId("uniqueIdHere_2") + ->setType("signature") + ->setRequired(true) + ->setSigner("0") + ->setWidth(120) + ->setHeight(30) + ->setX(530) + ->setY(415) + ->setName("") + ->setPage(1); + +$form_fields_per_document = [ + $form_fields_per_document_1, + $form_fields_per_document_2, +]; + +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) + ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) + ->setTestMode(false) + ->setFileUrls([ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ]) + ->setFormFieldsPerDocument($form_fields_per_document); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftCreate( + unclaimed_draft_create_request: $unclaimed_draft_create_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; +} diff --git a/sandbox/php/src/UnclaimedDraftEditAndResendExample.php b/sandbox/php/src/UnclaimedDraftEditAndResendExample.php new file mode 100644 index 000000000..f82ea4946 --- /dev/null +++ b/sandbox/php/src/UnclaimedDraftEditAndResendExample.php @@ -0,0 +1,27 @@ +setUsername("YOUR_API_KEY"); +// $config->setAccessToken("YOUR_ACCESS_TOKEN"); + +$unclaimed_draft_edit_and_resend_request = (new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTestMode(false); + +try { + $response = (new Dropbox\Sign\Api\UnclaimedDraftApi(config: $config))->unclaimedDraftEditAndResend( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request: $unclaimed_draft_edit_and_resend_request, + ); + + print_r($response); +} catch (Dropbox\Sign\ApiException $e) { + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend: {$e->getMessage()}"; +} diff --git a/sandbox/php/test/.config.dist.json b/sandbox/php/test/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/php/test/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/php/test/.gitignore b/sandbox/php/test/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/php/test/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/php/test/SignatureRequestTest.php b/sandbox/php/test/SignatureRequestTest.php deleted file mode 100644 index 052808b36..000000000 --- a/sandbox/php/test/SignatureRequestTest.php +++ /dev/null @@ -1,151 +0,0 @@ -client_id = $config['CLIENT_ID']; - - $this->config = new Sign\Configuration(); - $this->config->setUsername($config['API_KEY']); - $this->config->setHost($config['BASE_URL']); - - if ($config['USE_XDEBUG']) { - $cookies = CookieJar::fromArray( - ['XDEBUG_SESSION' => 'xdebug'], - parse_url($config['BASE_URL'], PHP_URL_HOST), - ); - - $this->config->setOptions(['cookies' => $cookies]); - } - } - - public function testSend(): void - { - $signature_request_api = new Sign\Api\SignatureRequestApi($this->config); - - $data = json_decode( - file_get_contents(self::FIXTURES_DIR . '/SignatureRequestSendRequest.json'), - true, - ); - $file = new SplFileObject(self::FIXTURES_DIR . '/pdf-sample.pdf'); - $data['files'] = [$file]; - - $send_request = Sign\Model\SignatureRequestSendRequest::init($data); - - $send_response = $signature_request_api->signatureRequestSend($send_request); - - $this->assertEquals( - $send_request->getFormFieldsPerDocument()[0]->getApiId(), - $send_response->getSignatureRequest()->getCustomFields()[0]->getApiId(), - ); - - $this->assertEquals( - $send_request->getSigners()[0]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[0]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[1]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[1]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[2]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[2]->getSignerEmailAddress(), - ); - - $get_response = $signature_request_api->signatureRequestGet( - $send_response->getSignatureRequest()->getSignatureRequestId(), - ); - - $this->assertSame( - $send_response->getSignatureRequest()->getSignatureRequestId(), - $get_response->getSignatureRequest()->getSignatureRequestId(), - ); - } - - public function testCreateEmbedded(): void - { - $signature_request_api = new Sign\Api\SignatureRequestApi($this->config); - - $data = json_decode( - file_get_contents(self::FIXTURES_DIR . '/SignatureRequestCreateEmbeddedRequest.json'), - true, - ); - $file = new SplFileObject(self::FIXTURES_DIR . '/pdf-sample.pdf'); - $data['files'] = [$file]; - $data['client_id'] = $this->client_id; - - $send_request = Sign\Model\SignatureRequestCreateEmbeddedRequest::init($data); - - $send_response = $signature_request_api->signatureRequestCreateEmbedded($send_request); - - $this->assertEquals( - $send_request->getSigners()[0]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[0]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[1]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[1]->getSignerEmailAddress(), - ); - $this->assertEquals( - $send_request->getSigners()[2]->getEmailAddress(), - $send_response->getSignatureRequest()->getSignatures()[2]->getSignerEmailAddress(), - ); - - $embedded_api = new Sign\Api\EmbeddedApi($this->config); - - $get_response = $embedded_api->embeddedSignUrl( - $send_response->getSignatureRequest()->getSignatures()[0]->getSignatureId(), - ); - - $this->assertNotEmpty($get_response->getEmbedded()->getSignUrl()); - } - - public function testSendWithoutFileError(): void - { - $signature_request_api = new Sign\Api\SignatureRequestApi($this->config); - - $data = json_decode( - file_get_contents(self::FIXTURES_DIR . '/SignatureRequestSendRequest.json'), - true, - ); - - $request = Sign\Model\SignatureRequestSendRequest::init($data); - - try { - $response = $signature_request_api->signatureRequestSend($request); - - $this->fail('Should have thrown: ' . print_r($response, true)); - } catch (Sign\ApiException $e) { - $error = $e->getResponseObject(); - - $this->assertEquals('file', $error->getError()->getErrorPath()); - } - } -} diff --git a/sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/php/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/php/test_fixtures/SignatureRequestSendRequest.json b/sandbox/php/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/php/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/php/test_fixtures/pdf-sample.pdf b/sandbox/php/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/php/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sandbox/python/.gitignore b/sandbox/python/.gitignore new file mode 100644 index 000000000..a415184a1 --- /dev/null +++ b/sandbox/python/.gitignore @@ -0,0 +1,2 @@ +venv +.venv diff --git a/sandbox/python/Example.py b/sandbox/python/Example.py deleted file mode 100644 index 6777ecd48..000000000 --- a/sandbox/python/Example.py +++ /dev/null @@ -1,25 +0,0 @@ -from pprint import pprint - -from dropbox_sign import \ - ApiClient, ApiException, Configuration, apis, models - -configuration = Configuration( - # Configure HTTP basic authorization: api_key - username="YOUR_API_KEY", - - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", -) - -with ApiClient(configuration) as api_client: - api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( - email_address="newuser@dropboxsign.com", - ) - - try: - response = api.account_create(data) - pprint(response) - except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) diff --git a/sandbox/python/src/AccountCreateExample.py b/sandbox/python/src/AccountCreateExample.py new file mode 100644 index 000000000..f911a898b --- /dev/null +++ b/sandbox/python/src/AccountCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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) diff --git a/sandbox/python/src/AccountCreateOauthExample.py b/sandbox/python/src/AccountCreateOauthExample.py new file mode 100644 index 000000000..8930f04d6 --- /dev/null +++ b/sandbox/python/src/AccountCreateOauthExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + account_create_request = models.AccountCreateRequest( + email_address="newuser@dropboxsign.com", + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + ) + + try: + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_create: %s\n" % e) diff --git a/sandbox/python/src/AccountGetExample.py b/sandbox/python/src/AccountGetExample.py new file mode 100644 index 000000000..d7e910dd6 --- /dev/null +++ b/sandbox/python/src/AccountGetExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.AccountApi(api_client).account_get() + + pprint(response) + except ApiException as e: + print("Exception when calling AccountApi#account_get: %s\n" % e) diff --git a/sandbox/python/src/AccountUpdateExample.py b/sandbox/python/src/AccountUpdateExample.py new file mode 100644 index 000000000..5ef5466ea --- /dev/null +++ b/sandbox/python/src/AccountUpdateExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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) diff --git a/sandbox/python/src/AccountVerifyExample.py b/sandbox/python/src/AccountVerifyExample.py new file mode 100644 index 000000000..65bdb8018 --- /dev/null +++ b/sandbox/python/src/AccountVerifyExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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) diff --git a/sandbox/python/src/ApiAppCreateExample.py b/sandbox/python/src/ApiAppCreateExample.py new file mode 100644 index 000000000..345edd053 --- /dev/null +++ b/sandbox/python/src/ApiAppCreateExample.py @@ -0,0 +1,43 @@ +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) diff --git a/sandbox/python/src/ApiAppDeleteExample.py b/sandbox/python/src/ApiAppDeleteExample.py new file mode 100644 index 000000000..bcfe5d65b --- /dev/null +++ b/sandbox/python/src/ApiAppDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.ApiAppApi(api_client).api_app_delete( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_delete: %s\n" % e) diff --git a/sandbox/python/src/ApiAppGetExample.py b/sandbox/python/src/ApiAppGetExample.py new file mode 100644 index 000000000..0eee76c6a --- /dev/null +++ b/sandbox/python/src/ApiAppGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.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) diff --git a/sandbox/python/src/ApiAppListExample.py b/sandbox/python/src/ApiAppListExample.py new file mode 100644 index 000000000..c0bca67da --- /dev/null +++ b/sandbox/python/src/ApiAppListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.ApiAppApi(api_client).api_app_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_list: %s\n" % e) diff --git a/sandbox/python/src/ApiAppUpdateExample.py b/sandbox/python/src/ApiAppUpdateExample.py new file mode 100644 index 000000000..00212198f --- /dev/null +++ b/sandbox/python/src/ApiAppUpdateExample.py @@ -0,0 +1,45 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + oauth = models.SubOAuth( + callback_url="https://example.com/oauth", + scopes=[ + "basic_account_info", + "request_signature", + ], + ) + + white_labeling_options = models.SubWhiteLabelingOptions( + primary_button_color="#00b3e6", + primary_button_text_color="#ffffff", + ) + + api_app_update_request = models.ApiAppUpdateRequest( + callback_url="https://example.com/dropboxsign", + name="New Name", + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), + oauth=oauth, + white_labeling_options=white_labeling_options, + ) + + try: + response = api.ApiAppApi(api_client).api_app_update( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + api_app_update_request=api_app_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ApiAppApi#api_app_update: %s\n" % e) diff --git a/sandbox/python/src/BulkSendJobGetExample.py b/sandbox/python/src/BulkSendJobGetExample.py new file mode 100644 index 000000000..58b865737 --- /dev/null +++ b/sandbox/python/src/BulkSendJobGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_get( + bulk_send_job_id="6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e) diff --git a/sandbox/python/src/BulkSendJobListExample.py b/sandbox/python/src/BulkSendJobListExample.py new file mode 100644 index 000000000..cb688f24d --- /dev/null +++ b/sandbox/python/src/BulkSendJobListExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.BulkSendJobApi(api_client).bulk_send_job_list( + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling BulkSendJobApi#bulk_send_job_list: %s\n" % e) diff --git a/sandbox/python/src/EmbeddedEditUrlExample.py b/sandbox/python/src/EmbeddedEditUrlExample.py new file mode 100644 index 000000000..0c8577780 --- /dev/null +++ b/sandbox/python/src/EmbeddedEditUrlExample.py @@ -0,0 +1,31 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + merge_fields = [ + ] + + embedded_edit_url_request = models.EmbeddedEditUrlRequest( + cc_roles=[ + "", + ], + merge_fields=merge_fields, + ) + + try: + response = api.EmbeddedApi(api_client).embedded_edit_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + embedded_edit_url_request=embedded_edit_url_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_edit_url: %s\n" % e) diff --git a/sandbox/python/src/EmbeddedSignUrlExample.py b/sandbox/python/src/EmbeddedSignUrlExample.py new file mode 100644 index 000000000..903945d90 --- /dev/null +++ b/sandbox/python/src/EmbeddedSignUrlExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.EmbeddedApi(api_client).embedded_sign_url( + signature_id="50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling EmbeddedApi#embedded_sign_url: %s\n" % e) diff --git a/sandbox/python/src/EventCallbackExample.py b/sandbox/python/src/EventCallbackExample.py new file mode 100644 index 000000000..38394d4d1 --- /dev/null +++ b/sandbox/python/src/EventCallbackExample.py @@ -0,0 +1,31 @@ +import json + +from dropbox_sign import ApiClient, EventCallbackHelper +from dropbox_sign.models import EventCallbackRequest + +# use your API key +api_key = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782" + +# callback_data represents data we send to you +callback_data = { + "event": { + "event_type": "account_confirmed", + "event_time": "1669926463", + "event_hash": "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + "event_metadata": { + "related_signature_id": None, + "reported_for_account_id": "6421d70b9bd45059fa207d03ab8d1b96515b472c", + "reported_for_app_id": None, + "event_message": None, + }, + }, +} + +callback_event = EventCallbackRequest.init(callback_data) + +# verify that a callback came from HelloSign.com +if EventCallbackHelper.is_valid(api_key, callback_event): + # one of "account_callback" or "api_app_callback" + callback_type = EventCallbackHelper.get_callback_type(callback_event) + + # do your magic below! diff --git a/sandbox/python/src/FaxDeleteExample.py b/sandbox/python/src/FaxDeleteExample.py new file mode 100644 index 000000000..76774d75b --- /dev/null +++ b/sandbox/python/src/FaxDeleteExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.FaxApi(api_client).fax_delete( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling FaxApi#fax_delete: %s\n" % e) diff --git a/sandbox/python/src/FaxFilesExample.py b/sandbox/python/src/FaxFilesExample.py new file mode 100644 index 000000000..4bc18d604 --- /dev/null +++ b/sandbox/python/src/FaxFilesExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxApi(api_client).fax_files( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling FaxApi#fax_files: %s\n" % e) diff --git a/sandbox/python/src/FaxGetExample.py b/sandbox/python/src/FaxGetExample.py new file mode 100644 index 000000000..e1288e656 --- /dev/null +++ b/sandbox/python/src/FaxGetExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxApi(api_client).fax_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxApi#fax_get: %s\n" % e) diff --git a/sandbox/python/src/FaxLineAddUserExample.py b/sandbox/python/src/FaxLineAddUserExample.py new file mode 100644 index 000000000..255ac248b --- /dev/null +++ b/sandbox/python/src/FaxLineAddUserExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_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) diff --git a/sandbox/python/src/FaxLineAreaCodeGetExample.py b/sandbox/python/src/FaxLineAreaCodeGetExample.py new file mode 100644 index 000000000..a2752d8d6 --- /dev/null +++ b/sandbox/python/src/FaxLineAreaCodeGetExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_area_code_get( + country="US", + state=None, + province=None, + city=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) diff --git a/sandbox/python/src/FaxLineCreateExample.py b/sandbox/python/src/FaxLineCreateExample.py new file mode 100644 index 000000000..3f7be1223 --- /dev/null +++ b/sandbox/python/src/FaxLineCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_create_request = models.FaxLineCreateRequest( + area_code=209, + country="US", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_create( + fax_line_create_request=fax_line_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_create: %s\n" % e) diff --git a/sandbox/python/src/FaxLineDeleteExample.py b/sandbox/python/src/FaxLineDeleteExample.py new file mode 100644 index 000000000..e5e7c23ea --- /dev/null +++ b/sandbox/python/src/FaxLineDeleteExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_delete_request = models.FaxLineDeleteRequest( + number="[FAX_NUMBER]", + ) + + try: + api.FaxLineApi(api_client).fax_line_delete( + fax_line_delete_request=fax_line_delete_request, + ) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_delete: %s\n" % e) diff --git a/sandbox/python/src/FaxLineGetExample.py b/sandbox/python/src/FaxLineGetExample.py new file mode 100644 index 000000000..56d2a204d --- /dev/null +++ b/sandbox/python/src/FaxLineGetExample.py @@ -0,0 +1,19 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_get( + number="123-123-1234", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_get: %s\n" % e) diff --git a/sandbox/python/src/FaxLineListExample.py b/sandbox/python/src/FaxLineListExample.py new file mode 100644 index 000000000..4af3f4a56 --- /dev/null +++ b/sandbox/python/src/FaxLineListExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + response = api.FaxLineApi(api_client).fax_line_list( + account_id="ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page=1, + page_size=20, + show_team_lines=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) diff --git a/sandbox/python/src/FaxLineRemoveUserExample.py b/sandbox/python/src/FaxLineRemoveUserExample.py new file mode 100644 index 000000000..366957bac --- /dev/null +++ b/sandbox/python/src/FaxLineRemoveUserExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + fax_line_remove_user_request = models.FaxLineRemoveUserRequest( + number="[FAX_NUMBER]", + email_address="member@dropboxsign.com", + ) + + try: + response = api.FaxLineApi(api_client).fax_line_remove_user( + fax_line_remove_user_request=fax_line_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling FaxLineApi#fax_line_remove_user: %s\n" % e) diff --git a/sandbox/python/src/FaxListExample.py b/sandbox/python/src/FaxListExample.py new file mode 100644 index 000000000..44f840a7f --- /dev/null +++ b/sandbox/python/src/FaxListExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +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) diff --git a/sandbox/python/src/FaxSendExample.py b/sandbox/python/src/FaxSendExample.py new file mode 100644 index 000000000..77fbf8bbf --- /dev/null +++ b/sandbox/python/src/FaxSendExample.py @@ -0,0 +1,32 @@ +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) diff --git a/sandbox/python/src/OauthTokenGenerateExample.py b/sandbox/python/src/OauthTokenGenerateExample.py new file mode 100644 index 000000000..69cec3ffd --- /dev/null +++ b/sandbox/python/src/OauthTokenGenerateExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( +) + +with ApiClient(configuration) as api_client: + o_auth_token_generate_request = models.OAuthTokenGenerateRequest( + client_id="cc91c61d00f8bb2ece1428035716b", + client_secret="1d14434088507ffa390e6f5528465", + code="1b0d28d90c86c141", + state="900e06e2", + grant_type="authorization_code", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_generate( + o_auth_token_generate_request=o_auth_token_generate_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_generate: %s\n" % e) diff --git a/sandbox/python/src/OauthTokenRefreshExample.py b/sandbox/python/src/OauthTokenRefreshExample.py new file mode 100644 index 000000000..7bd30fbf8 --- /dev/null +++ b/sandbox/python/src/OauthTokenRefreshExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( +) + +with ApiClient(configuration) as api_client: + o_auth_token_refresh_request = models.OAuthTokenRefreshRequest( + grant_type="refresh_token", + refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", + ) + + try: + response = api.OAuthApi(api_client).oauth_token_refresh( + o_auth_token_refresh_request=o_auth_token_refresh_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling OAuthApi#oauth_token_refresh: %s\n" % e) diff --git a/sandbox/python/src/ReportCreateExample.py b/sandbox/python/src/ReportCreateExample.py new file mode 100644 index 000000000..cfcc85d84 --- /dev/null +++ b/sandbox/python/src/ReportCreateExample.py @@ -0,0 +1,28 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + report_create_request = models.ReportCreateRequest( + start_date="09/01/2020", + end_date="09/01/2020", + report_type=[ + "user_activity", + "document_status", + ], + ) + + try: + response = api.ReportApi(api_client).report_create( + report_create_request=report_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling ReportApi#report_create: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py b/sandbox/python/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..b2cb98a38 --- /dev/null +++ b/sandbox/python/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_create_embedded_with_template_request = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + client_id="1a659d9ad95bccd307ecad78d72192f8", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request=signature_request_bulk_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestBulkSendWithTemplateExample.py b/sandbox/python/src/SignatureRequestBulkSendWithTemplateExample.py new file mode 100644 index 000000000..4a8fb41c5 --- /dev/null +++ b/sandbox/python/src/SignatureRequestBulkSendWithTemplateExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signer_list_2_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="123 LLC", + ) + + signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, + ] + + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", + ) + + signer_list_2_signers = [ + signer_list_2_signers_1, + ] + + signer_list_1_custom_fields_1 = models.SubBulkSignerListCustomField( + name="company", + value="ABC Corp", + ) + + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] + + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + pin="d79a3td", + ) + + signer_list_1_signers = [ + signer_list_1_signers_1, + ] + + signer_list_1 = models.SubBulkSignerList( + custom_fields=signer_list_1_custom_fields, + signers=signer_list_1_signers, + ) + + signer_list_2 = models.SubBulkSignerList( + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, + ) + + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + signature_request_bulk_send_with_template_request = models.SignatureRequestBulkSendWithTemplateRequest( + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signer_list=signer_list, + ccs=ccs, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request=signature_request_bulk_send_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestCancelExample.py b/sandbox/python/src/SignatureRequestCancelExample.py new file mode 100644 index 000000000..6a0e62bc1 --- /dev/null +++ b/sandbox/python/src/SignatureRequestCancelExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_cancel( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_cancel: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py new file mode 100644 index 000000000..2e1b93c1d --- /dev/null +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedExample.py @@ -0,0 +1,62 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py new file mode 100644 index 000000000..8bc255e6f --- /dev/null +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedGroupedSignersExample.py @@ -0,0 +1,92 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_create_embedded_request = models.SignatureRequestCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded( + signature_request_create_embedded_request=signature_request_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py b/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..6a5835760 --- /dev/null +++ b/sandbox/python/src/SignatureRequestCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,50 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_create_embedded_with_template_request = models.SignatureRequestCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request=signature_request_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestEditEmbeddedExample.py b/sandbox/python/src/SignatureRequestEditEmbeddedExample.py new file mode 100644 index 000000000..e3e5f1a87 --- /dev/null +++ b/sandbox/python/src/SignatureRequestEditEmbeddedExample.py @@ -0,0 +1,63 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py b/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py new file mode 100644 index 000000000..9c26905c3 --- /dev/null +++ b/sandbox/python/src/SignatureRequestEditEmbeddedGroupedSignersExample.py @@ -0,0 +1,93 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_embedded_request = models.SignatureRequestEditEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_request=signature_request_edit_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py b/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..92f0378ef --- /dev/null +++ b/sandbox/python/src/SignatureRequestEditEmbeddedWithTemplateExample.py @@ -0,0 +1,51 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + signature_request_edit_embedded_with_template_request = models.SignatureRequestEditEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + template_ids=[ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_embedded_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_embedded_with_template_request=signature_request_edit_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestEditExample.py b/sandbox/python/src/SignatureRequestEditExample.py new file mode 100644 index 000000000..4c6fc1e74 --- /dev/null +++ b/sandbox/python/src/SignatureRequestEditExample.py @@ -0,0 +1,73 @@ +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) diff --git a/sandbox/python/src/SignatureRequestEditGroupedSignersExample.py b/sandbox/python/src/SignatureRequestEditGroupedSignersExample.py new file mode 100644 index 000000000..41f5a54dc --- /dev/null +++ b/sandbox/python/src/SignatureRequestEditGroupedSignersExample.py @@ -0,0 +1,103 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_edit_request = models.SignatureRequestEditRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestEditWithTemplateExample.py b/sandbox/python/src/SignatureRequestEditWithTemplateExample.py new file mode 100644 index 000000000..4e8653475 --- /dev/null +++ b/sandbox/python/src/SignatureRequestEditWithTemplateExample.py @@ -0,0 +1,72 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@example.com", + ) + + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( + name="Cost", + editor="Client", + required=True, + value="$20,000", + ) + + custom_fields = [ + custom_fields_1, + ] + + signature_request_edit_with_template_request = models.SignatureRequestEditWithTemplateRequest( + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + message="Glad we could come to an agreement.", + subject="Purchase Order", + test_mode=True, + signing_options=signing_options, + signers=signers, + ccs=ccs, + custom_fields=custom_fields, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_edit_with_template( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_with_template_request=signature_request_edit_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_edit_with_template: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestFilesAsDataUriExample.py b/sandbox/python/src/SignatureRequestFilesAsDataUriExample.py new file mode 100644 index 000000000..09a50923d --- /dev/null +++ b/sandbox/python/src/SignatureRequestFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files_as_data_uri( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestFilesAsFileUrlExample.py b/sandbox/python/src/SignatureRequestFilesAsFileUrlExample.py new file mode 100644 index 000000000..9cd19e6db --- /dev/null +++ b/sandbox/python/src/SignatureRequestFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files_as_file_url( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files_as_file_url: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestFilesExample.py b/sandbox/python/src/SignatureRequestFilesExample.py new file mode 100644 index 000000000..12694cc53 --- /dev/null +++ b/sandbox/python/src/SignatureRequestFilesExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_files( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type="pdf", + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_files: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestGetExample.py b/sandbox/python/src/SignatureRequestGetExample.py new file mode 100644 index 000000000..47359ef9c --- /dev/null +++ b/sandbox/python/src/SignatureRequestGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_get( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_get: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestListExample.py b/sandbox/python/src/SignatureRequestListExample.py new file mode 100644 index 000000000..6d3db2fe3 --- /dev/null +++ b/sandbox/python/src/SignatureRequestListExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_list( + account_id=None, + page=1, + page_size=20, + query=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_list: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestReleaseHoldExample.py b/sandbox/python/src/SignatureRequestReleaseHoldExample.py new file mode 100644 index 000000000..e584b4fd2 --- /dev/null +++ b/sandbox/python/src/SignatureRequestReleaseHoldExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.SignatureRequestApi(api_client).signature_request_release_hold( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_release_hold: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestRemindExample.py b/sandbox/python/src/SignatureRequestRemindExample.py new file mode 100644 index 000000000..048db3092 --- /dev/null +++ b/sandbox/python/src/SignatureRequestRemindExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_remind_request = models.SignatureRequestRemindRequest( + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_remind( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_remind_request=signature_request_remind_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_remind: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestRemoveExample.py b/sandbox/python/src/SignatureRequestRemoveExample.py new file mode 100644 index 000000000..3a380080b --- /dev/null +++ b/sandbox/python/src/SignatureRequestRemoveExample.py @@ -0,0 +1,17 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", +) + +with ApiClient(configuration) as api_client: + try: + api.SignatureRequestApi(api_client).signature_request_remove( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_remove: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestSendExample.py b/sandbox/python/src/SignatureRequestSendExample.py new file mode 100644 index 000000000..21b1bfc26 --- /dev/null +++ b/sandbox/python/src/SignatureRequestSendExample.py @@ -0,0 +1,72 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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_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) diff --git a/sandbox/python/src/SignatureRequestSendGroupedSignersExample.py b/sandbox/python/src/SignatureRequestSendGroupedSignersExample.py new file mode 100644 index 000000000..3a7e649c6 --- /dev/null +++ b/sandbox/python/src/SignatureRequestSendGroupedSignersExample.py @@ -0,0 +1,102 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + grouped_signers_2_signers_1 = models.SubSignatureRequestSigner( + name="Bob", + email_address="bob@example.com", + ) + + grouped_signers_2_signers_2 = models.SubSignatureRequestSigner( + name="Charlie", + email_address="charlie@example.com", + ) + + grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, + ] + + grouped_signers_1_signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + ) + + grouped_signers_1_signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + ) + + grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) + + grouped_signers_1 = models.SubSignatureRequestGroupedSigners( + group="Group #1", + order=0, + signers=grouped_signers_1_signers, + ) + + grouped_signers_2 = models.SubSignatureRequestGroupedSigners( + group="Group #2", + order=1, + signers=grouped_signers_2_signers, + ) + + grouped_signers = [ + grouped_signers_1, + grouped_signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", + subject="The NDA we talked about", + test_mode=True, + title="NDA with Acme Co.", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_email_addresses=[ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", + ], + metadata=json.loads(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """), + field_options=field_options, + signing_options=signing_options, + grouped_signers=grouped_signers, + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_send: %s\n" % e) diff --git a/sandbox/python/src/SignatureRequestSendWithTemplateExample.py b/sandbox/python/src/SignatureRequestSendWithTemplateExample.py new file mode 100644 index 000000000..468a6b101 --- /dev/null +++ b/sandbox/python/src/SignatureRequestSendWithTemplateExample.py @@ -0,0 +1,71 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + 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_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) diff --git a/sandbox/python/src/SignatureRequestUpdateExample.py b/sandbox/python/src/SignatureRequestUpdateExample.py new file mode 100644 index 000000000..0d9bc45fb --- /dev/null +++ b/sandbox/python/src/SignatureRequestUpdateExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signature_request_update_request = models.SignatureRequestUpdateRequest( + signature_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + email_address="john@example.com", + ) + + try: + response = api.SignatureRequestApi(api_client).signature_request_update( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_update_request=signature_request_update_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling SignatureRequestApi#signature_request_update: %s\n" % e) diff --git a/sandbox/python/src/TeamAddMemberAccountIdExample.py b/sandbox/python/src/TeamAddMemberAccountIdExample.py new file mode 100644 index 000000000..402e0f2c5 --- /dev/null +++ b/sandbox/python/src/TeamAddMemberAccountIdExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/sandbox/python/src/TeamAddMemberExample.py b/sandbox/python/src/TeamAddMemberExample.py new file mode 100644 index 000000000..caef04ea5 --- /dev/null +++ b/sandbox/python/src/TeamAddMemberExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_add_member_request = models.TeamAddMemberRequest( + email_address="george@example.com", + ) + + try: + response = api.TeamApi(api_client).team_add_member( + team_add_member_request=team_add_member_request, + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_add_member: %s\n" % e) diff --git a/sandbox/python/src/TeamCreateExample.py b/sandbox/python/src/TeamCreateExample.py new file mode 100644 index 000000000..88772104e --- /dev/null +++ b/sandbox/python/src/TeamCreateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_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) diff --git a/sandbox/python/src/TeamDeleteExample.py b/sandbox/python/src/TeamDeleteExample.py new file mode 100644 index 000000000..2da2f0be7 --- /dev/null +++ b/sandbox/python/src/TeamDeleteExample.py @@ -0,0 +1,16 @@ +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) diff --git a/sandbox/python/src/TeamGetExample.py b/sandbox/python/src/TeamGetExample.py new file mode 100644 index 000000000..dc0b0532e --- /dev/null +++ b/sandbox/python/src/TeamGetExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_get() + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_get: %s\n" % e) diff --git a/sandbox/python/src/TeamInfoExample.py b/sandbox/python/src/TeamInfoExample.py new file mode 100644 index 000000000..994688dc2 --- /dev/null +++ b/sandbox/python/src/TeamInfoExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_info( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_info: %s\n" % e) diff --git a/sandbox/python/src/TeamInvitesExample.py b/sandbox/python/src/TeamInvitesExample.py new file mode 100644 index 000000000..c9764ae11 --- /dev/null +++ b/sandbox/python/src/TeamInvitesExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_invites() + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_invites: %s\n" % e) diff --git a/sandbox/python/src/TeamMembersExample.py b/sandbox/python/src/TeamMembersExample.py new file mode 100644 index 000000000..92c3ebaf5 --- /dev/null +++ b/sandbox/python/src/TeamMembersExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_members( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_members: %s\n" % e) diff --git a/sandbox/python/src/TeamRemoveMemberAccountIdExample.py b/sandbox/python/src/TeamRemoveMemberAccountIdExample.py new file mode 100644 index 000000000..132ab54cb --- /dev/null +++ b/sandbox/python/src/TeamRemoveMemberAccountIdExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_remove_member_request = models.TeamRemoveMemberRequest( + account_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + try: + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) diff --git a/sandbox/python/src/TeamRemoveMemberExample.py b/sandbox/python/src/TeamRemoveMemberExample.py new file mode 100644 index 000000000..7847d7289 --- /dev/null +++ b/sandbox/python/src/TeamRemoveMemberExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_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) diff --git a/sandbox/python/src/TeamSubTeamsExample.py b/sandbox/python/src/TeamSubTeamsExample.py new file mode 100644 index 000000000..93afde113 --- /dev/null +++ b/sandbox/python/src/TeamSubTeamsExample.py @@ -0,0 +1,22 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TeamApi(api_client).team_sub_teams( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page=1, + page_size=20, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TeamApi#team_sub_teams: %s\n" % e) diff --git a/sandbox/python/src/TeamUpdateExample.py b/sandbox/python/src/TeamUpdateExample.py new file mode 100644 index 000000000..e28eb2907 --- /dev/null +++ b/sandbox/python/src/TeamUpdateExample.py @@ -0,0 +1,24 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + team_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) diff --git a/sandbox/python/src/TemplateAddUserExample.py b/sandbox/python/src/TemplateAddUserExample.py new file mode 100644 index 000000000..5259a01d4 --- /dev/null +++ b/sandbox/python/src/TemplateAddUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_add_user_request = models.TemplateAddUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_add_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_add_user_request=template_add_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_add_user: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateEmbeddedDraftExample.py b/sandbox/python/src/TemplateCreateEmbeddedDraftExample.py new file mode 100644 index 000000000..2e96c0a48 --- /dev/null +++ b/sandbox/python/src/TemplateCreateEmbeddedDraftExample.py @@ -0,0 +1,71 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py b/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py new file mode 100644 index 000000000..84232eacf --- /dev/null +++ b/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.py b/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.py new file mode 100644 index 000000000..e20394052 --- /dev/null +++ b/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py b/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..b99b91ac7 --- /dev/null +++ b/sandbox/python/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + signer_roles=signer_roles, + ) + + try: + response = api.TemplateApi(api_client).template_create_embedded_draft( + template_create_embedded_draft_request=template_create_embedded_draft_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create_embedded_draft: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateExample.py b/sandbox/python/src/TemplateCreateExample.py new file mode 100644 index 000000000..a6ed3611e --- /dev/null +++ b/sandbox/python/src/TemplateCreateExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + cc_roles=[ + "Manager", + ], + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateFormFieldGroupsExample.py b/sandbox/python/src/TemplateCreateFormFieldGroupsExample.py new file mode 100644 index 000000000..6a755d022 --- /dev/null +++ b/sandbox/python/src/TemplateCreateFormFieldGroupsExample.py @@ -0,0 +1,120 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_groups=form_field_groups, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateFormFieldRulesExample.py b/sandbox/python/src/TemplateCreateFormFieldRulesExample.py new file mode 100644 index 000000000..a7f2d94ff --- /dev/null +++ b/sandbox/python/src/TemplateCreateFormFieldRulesExample.py @@ -0,0 +1,138 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + form_field_rules=form_field_rules, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/sandbox/python/src/TemplateCreateFormFieldsPerDocumentExample.py b/sandbox/python/src/TemplateCreateFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..6e2185aa9 --- /dev/null +++ b/sandbox/python/src/TemplateCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,107 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) + + signer_roles_1 = models.SubTemplateRole( + name="Client", + order=0, + ) + + signer_roles_2 = models.SubTemplateRole( + name="Witness", + order=1, + ) + + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + merge_fields_1 = models.SubMergeField( + name="Full Name", + type="text", + ) + + merge_fields_2 = models.SubMergeField( + name="Is Registered?", + type="checkbox", + ) + + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] + + template_create_request = models.TemplateCreateRequest( + client_id="37dee8d8440c66d54cfa05d92c160882", + message="For your approval", + subject="Please sign this document", + test_mode=True, + title="Test Template", + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + cc_roles=[ + "Manager", + ], + field_options=field_options, + signer_roles=signer_roles, + form_fields_per_document=form_fields_per_document, + merge_fields=merge_fields, + ) + + try: + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_create: %s\n" % e) diff --git a/sandbox/python/src/TemplateDeleteExample.py b/sandbox/python/src/TemplateDeleteExample.py new file mode 100644 index 000000000..3bf63f5ad --- /dev/null +++ b/sandbox/python/src/TemplateDeleteExample.py @@ -0,0 +1,18 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + api.TemplateApi(api_client).template_delete( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + except ApiException as e: + print("Exception when calling TemplateApi#template_delete: %s\n" % e) diff --git a/sandbox/python/src/TemplateFilesAsDataUriExample.py b/sandbox/python/src/TemplateFilesAsDataUriExample.py new file mode 100644 index 000000000..ce91dc6ec --- /dev/null +++ b/sandbox/python/src/TemplateFilesAsDataUriExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_data_uri( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_data_uri: %s\n" % e) diff --git a/sandbox/python/src/TemplateFilesAsFileUrlExample.py b/sandbox/python/src/TemplateFilesAsFileUrlExample.py new file mode 100644 index 000000000..052891df2 --- /dev/null +++ b/sandbox/python/src/TemplateFilesAsFileUrlExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files_as_file_url( + template_id="f57db65d3f933b5316d398057a36176831451a35", + force_download=1, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_files_as_file_url: %s\n" % e) diff --git a/sandbox/python/src/TemplateFilesExample.py b/sandbox/python/src/TemplateFilesExample.py new file mode 100644 index 000000000..712642766 --- /dev/null +++ b/sandbox/python/src/TemplateFilesExample.py @@ -0,0 +1,21 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + file_type=None, + ) + + open("./file_response", "wb").write(response.read()) + except ApiException as e: + print("Exception when calling TemplateApi#template_files: %s\n" % e) diff --git a/sandbox/python/src/TemplateGetExample.py b/sandbox/python/src/TemplateGetExample.py new file mode 100644 index 000000000..2226f74d0 --- /dev/null +++ b/sandbox/python/src/TemplateGetExample.py @@ -0,0 +1,20 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_get( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_get: %s\n" % e) diff --git a/sandbox/python/src/TemplateListExample.py b/sandbox/python/src/TemplateListExample.py new file mode 100644 index 000000000..6b96ea19c --- /dev/null +++ b/sandbox/python/src/TemplateListExample.py @@ -0,0 +1,23 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + try: + response = api.TemplateApi(api_client).template_list( + account_id=None, + page=1, + page_size=20, + query=None, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_list: %s\n" % e) diff --git a/sandbox/python/src/TemplateRemoveUserExample.py b/sandbox/python/src/TemplateRemoveUserExample.py new file mode 100644 index 000000000..c44814c40 --- /dev/null +++ b/sandbox/python/src/TemplateRemoveUserExample.py @@ -0,0 +1,25 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_remove_user_request = models.TemplateRemoveUserRequest( + email_address="george@dropboxsign.com", + ) + + try: + response = api.TemplateApi(api_client).template_remove_user( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_remove_user_request=template_remove_user_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_remove_user: %s\n" % e) diff --git a/sandbox/python/src/TemplateUpdateFilesExample.py b/sandbox/python/src/TemplateUpdateFilesExample.py new file mode 100644 index 000000000..71ab006be --- /dev/null +++ b/sandbox/python/src/TemplateUpdateFilesExample.py @@ -0,0 +1,27 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + template_update_files_request = models.TemplateUpdateFilesRequest( + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.TemplateApi(api_client).template_update_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + template_update_files_request=template_update_files_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling TemplateApi#template_update_files: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateEmbeddedExample.py b/sandbox/python/src/UnclaimedDraftCreateEmbeddedExample.py new file mode 100644 index 000000000..dade05ec4 --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateEmbeddedExample.py @@ -0,0 +1,29 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py b/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py new file mode 100644 index 000000000..b825eeac8 --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.py @@ -0,0 +1,78 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py b/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py new file mode 100644 index 000000000..931cc0bdd --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.py @@ -0,0 +1,96 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py b/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..6828613cd --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.py @@ -0,0 +1,65 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_embedded_request = models.UnclaimedDraftCreateEmbeddedRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request=unclaimed_draft_create_embedded_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.py b/sandbox/python/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.py new file mode 100644 index 000000000..fbb76e6bf --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.py @@ -0,0 +1,50 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@dropboxsign.com", + ) + + ccs = [ + ccs_1, + ] + + signers_1 = models.SubUnclaimedDraftTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_embedded_with_template_request = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + requester_email_address="jack@dropboxsign.com", + template_ids=[ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + test_mode=False, + ccs=ccs, + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request=unclaimed_draft_create_embedded_with_template_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateExample.py b/sandbox/python/src/UnclaimedDraftCreateExample.py new file mode 100644 index 000000000..f7715b7ea --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateExample.py @@ -0,0 +1,39 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + signers_1 = models.SubUnclaimedDraftSigner( + name="Jack", + email_address="jack@example.com", + order=0, + ) + + signers = [ + signers_1, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signers=signers, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateFormFieldGroupsExample.py b/sandbox/python/src/UnclaimedDraftCreateFormFieldGroupsExample.py new file mode 100644 index 000000000..4af69152a --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateFormFieldGroupsExample.py @@ -0,0 +1,77 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_groups_1 = models.SubFormFieldGroup( + group_id="RadioItemGroup1", + group_label="Radio Item Group 1", + requirement="require_0-1", + ) + + form_field_groups = [ + form_field_groups_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_1", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=328, + group="RadioItemGroup1", + is_checked=True, + name="", + page=1, + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentRadio( + document_index=0, + api_id="uniqueIdHere_2", + type="radio", + required=False, + signer="0", + width=18, + height=18, + x=112, + y=370, + group="RadioItemGroup1", + is_checked=False, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_groups=form_field_groups, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateFormFieldRulesExample.py b/sandbox/python/src/UnclaimedDraftCreateFormFieldRulesExample.py new file mode 100644 index 000000000..a0bba3023 --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateFormFieldRulesExample.py @@ -0,0 +1,95 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_field_rules_1_triggers_1 = models.SubFormFieldRuleTrigger( + id="uniqueIdHere_1", + operator="is", + value="foo", + ) + + form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, + ] + + form_field_rules_1_actions_1 = models.SubFormFieldRuleAction( + hidden=True, + type="change-field-visibility", + field_id="uniqueIdHere_2", + ) + + form_field_rules_1_actions = [ + form_field_rules_1_actions_1, + ] + + form_field_rules_1 = models.SubFormFieldRule( + id="rule_1", + trigger_operator="AND", + triggers=form_field_rules_1_triggers, + actions=form_field_rules_1_actions, + ) + + form_field_rules = [ + form_field_rules_1, + ] + + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="0", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_field_rules=form_field_rules, + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.py b/sandbox/python/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.py new file mode 100644 index 000000000..d15b6c577 --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.py @@ -0,0 +1,64 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + form_fields_per_document_1 = models.SubFormFieldsPerDocumentText( + document_index=0, + api_id="uniqueIdHere_1", + type="text", + required=True, + signer="1", + width=100, + height=16, + x=112, + y=328, + name="", + page=1, + placeholder="", + validation_type="numbers_only", + ) + + form_fields_per_document_2 = models.SubFormFieldsPerDocumentSignature( + document_index=0, + api_id="uniqueIdHere_2", + type="signature", + required=True, + signer="0", + width=120, + height=30, + x=530, + y=415, + name="", + page=1, + ) + + form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, + ] + + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( + type="request_signature", + test_mode=False, + file_urls=[ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", + ], + form_fields_per_document=form_fields_per_document, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_create( + unclaimed_draft_create_request=unclaimed_draft_create_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e) diff --git a/sandbox/python/src/UnclaimedDraftEditAndResendExample.py b/sandbox/python/src/UnclaimedDraftEditAndResendExample.py new file mode 100644 index 000000000..440aaaa9e --- /dev/null +++ b/sandbox/python/src/UnclaimedDraftEditAndResendExample.py @@ -0,0 +1,26 @@ +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models + +configuration = Configuration( + username="YOUR_API_KEY", + # access_token="YOUR_ACCESS_TOKEN", +) + +with ApiClient(configuration) as api_client: + unclaimed_draft_edit_and_resend_request = models.UnclaimedDraftEditAndResendRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + test_mode=False, + ) + + try: + response = api.UnclaimedDraftApi(api_client).unclaimed_draft_edit_and_resend( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimed_draft_edit_and_resend_request=unclaimed_draft_edit_and_resend_request, + ) + + pprint(response) + except ApiException as e: + print("Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: %s\n" % e) diff --git a/sandbox/python/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/python/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/python/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/python/test_fixtures/SignatureRequestSendRequest.json b/sandbox/python/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/python/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/python/test_fixtures/pdf-sample.pdf b/sandbox/python/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/python/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sandbox/python/tests/.config.dist.json b/sandbox/python/tests/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/python/tests/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/python/tests/.gitignore b/sandbox/python/tests/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/python/tests/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/python/tests/test_signature_request.py b/sandbox/python/tests/test_signature_request.py deleted file mode 100644 index 93bdf203c..000000000 --- a/sandbox/python/tests/test_signature_request.py +++ /dev/null @@ -1,124 +0,0 @@ -import json -import os -import unittest - -from dropbox_sign import ApiClient, Configuration, apis, models, ApiException - - -class TestSignatureRequest(unittest.TestCase): - def setUp(self): - self.base_path = os.path.dirname(os.path.abspath(__file__)) + "/.." - self.config_merged = self.get_config() - - self.configuration = Configuration( - username=self.config_merged["API_KEY"], - host=self.config_merged["BASE_URL"], - ) - - def get_config(self): - file = open(f'{self.base_path}/tests/.config.dist.json', 'r') - config_dist = json.load(file) - file.close() - - file = open(f'{self.base_path}/tests/.config.json', 'r') - config_custom = json.load(file) - file.close() - - config_dist.update(config_custom) - - return config_dist - - def test_send(self): - api_client = ApiClient(self.configuration) - signature_request_api = apis.SignatureRequestApi(api_client) - - file = open(f'{self.base_path}/test_fixtures/SignatureRequestSendRequest.json', 'r') - data = json.load(file) - file.close() - - send_request = models.SignatureRequestSendRequest.init(data) - send_request.files = [open(f'{self.base_path}/test_fixtures/pdf-sample.pdf', 'rb')] - - send_response = signature_request_api.signature_request_send(send_request) - - self.assertEqual( - send_request.form_fields_per_document[0].api_id, - send_response.signature_request.custom_fields[0].api_id, - ) - - self.assertEqual( - send_request.signers[0].email_address, - send_response.signature_request.signatures[0].signer_email_address, - ) - self.assertEqual( - send_request.signers[1].email_address, - send_response.signature_request.signatures[1].signer_email_address, - ) - self.assertEqual( - send_request.signers[2].email_address, - send_response.signature_request.signatures[2].signer_email_address, - ) - - get_response = signature_request_api.signature_request_get( - send_response.signature_request.signature_request_id, - ) - - self.assertEqual( - send_response.signature_request.signature_request_id, - get_response.signature_request.signature_request_id, - ) - - def test_create_embedded(self): - api_client = ApiClient(self.configuration) - signature_request_api = apis.SignatureRequestApi(api_client) - - file = open(f'{self.base_path}/test_fixtures/SignatureRequestCreateEmbeddedRequest.json', 'r') - data = json.load(file) - data["client_id"] = self.config_merged["CLIENT_ID"] - file.close() - - send_request = models.SignatureRequestCreateEmbeddedRequest.init(data) - send_request.files = [open(f'{self.base_path}/test_fixtures/pdf-sample.pdf', 'rb')] - - send_response = signature_request_api.signature_request_create_embedded(send_request) - - self.assertEqual( - send_request.signers[0].email_address, - send_response.signature_request.signatures[0].signer_email_address, - ) - self.assertEqual( - send_request.signers[1].email_address, - send_response.signature_request.signatures[1].signer_email_address, - ) - self.assertEqual( - send_request.signers[2].email_address, - send_response.signature_request.signatures[2].signer_email_address, - ) - - embedded_api = apis.EmbeddedApi(api_client) - - get_response = embedded_api.embedded_sign_url( - send_response.signature_request.signatures[0].signature_id - ) - - self.assertNotEquals("", get_response.embedded.sign_url) - - def test_send_without_file_error(self): - api_client = ApiClient(self.configuration) - signature_request_api = apis.SignatureRequestApi(api_client) - - file = open(f'{self.base_path}/test_fixtures/SignatureRequestSendRequest.json', 'r') - data = json.load(file) - file.close() - - send_request = models.SignatureRequestSendRequest.init(data) - - try: - signature_request_api.signature_request_send(send_request) - self.assertFalse(True) - except ApiException as e: - self.assertEqual("file", e.data.error.error_path) - - -if __name__ == '__main__': - unittest.main() diff --git a/sandbox/ruby/.gitignore b/sandbox/ruby/.gitignore new file mode 100644 index 000000000..b844b143d --- /dev/null +++ b/sandbox/ruby/.gitignore @@ -0,0 +1 @@ +Gemfile.lock diff --git a/sandbox/ruby/spec/.config.dist.json b/sandbox/ruby/spec/.config.dist.json deleted file mode 100644 index 601c6a5f9..000000000 --- a/sandbox/ruby/spec/.config.dist.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "BASE_URL": "https://api.hellosign.com/v3", - "API_KEY": "", - "CLIENT_ID": "", - "USE_XDEBUG": 0 -} diff --git a/sandbox/ruby/spec/.gitignore b/sandbox/ruby/spec/.gitignore deleted file mode 100644 index a9b8cc8b8..000000000 --- a/sandbox/ruby/spec/.gitignore +++ /dev/null @@ -1 +0,0 @@ -.config.json diff --git a/sandbox/ruby/spec/signature_request_spec.rb b/sandbox/ruby/spec/signature_request_spec.rb deleted file mode 100644 index d598cf164..000000000 --- a/sandbox/ruby/spec/signature_request_spec.rb +++ /dev/null @@ -1,133 +0,0 @@ -require "spec_helper" -require "dropbox-sign" - -# This test suite is intended solely as a stopgap while we setup automated -# internal tests from github actions. -# -# For now it requires running manually -describe "SignatureRequestSpec" do - config_custom = JSON.parse(File.read(__dir__ + "/.config.json"), :symbolize_names => false) - config_dist = JSON.parse(File.read(__dir__ + "/.config.dist.json"), :symbolize_names => false) - config_merged = config_dist.merge(config_custom) - opts = {} - - if config_merged["USE_XDEBUG"] - opts[:header_params] = {"Cookie" => "XDEBUG_SESSION=xdebug"} - end - - Dropbox::Sign.configure do |config| - config.username = config_merged["API_KEY"] - config.host = config_merged["BASE_URL"] - end - - it "testSend" do - signature_request_api = Dropbox::Sign::SignatureRequestApi.new - - data = JSON.parse( - File.read(__dir__ + "/../test_fixtures/SignatureRequestSendRequest.json"), - :symbolize_names => true, - ) - - send_request = Dropbox::Sign::SignatureRequestSendRequest.init(data) - send_request.files = [File.new(__dir__ + "/../test_fixtures/pdf-sample.pdf", "r")] - - begin - send_response = signature_request_api.signature_request_send(send_request, opts) - rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" - exit - end - - signature_request = send_response.signature_request - - expect(signature_request.custom_fields[0].api_id) - .to eq(send_request.form_fields_per_document[0].api_id) - - expect(signature_request.signatures[0].signer_email_address) - .to eq(send_request.signers[0].email_address) - expect(signature_request.signatures[1].signer_email_address) - .to eq(send_request.signers[1].email_address) - expect(signature_request.signatures[2].signer_email_address) - .to eq(send_request.signers[2].email_address) - - begin - get_response = signature_request_api.signature_request_get( - signature_request.signature_request_id, - opts, - ) - rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" - exit - end - - expect(signature_request.signature_request_id) - .to eq(get_response.signature_request.signature_request_id) - end - - it "testCreateEmbedded" do - signature_request_api = Dropbox::Sign::SignatureRequestApi.new - - data = JSON.parse( - File.read(__dir__ + "/../test_fixtures/SignatureRequestCreateEmbeddedRequest.json"), - :symbolize_names => true, - ) - - send_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.init(data) - send_request.files = [File.new(__dir__ + "/../test_fixtures/pdf-sample.pdf", "r")] - send_request.client_id = config_merged["CLIENT_ID"] - - begin - send_response = signature_request_api.signature_request_create_embedded( - send_request, - opts, - ) - rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" - exit - end - - signature_request = send_response.signature_request - - expect(signature_request.signatures[0].signer_email_address) - .to eq(send_request.signers[0].email_address) - expect(signature_request.signatures[1].signer_email_address) - .to eq(send_request.signers[1].email_address) - expect(signature_request.signatures[2].signer_email_address) - .to eq(send_request.signers[2].email_address) - - embedded_api = Dropbox::Sign::EmbeddedApi.new - - begin - get_response = embedded_api.embedded_sign_url( - signature_request.signatures[0].signature_id, - opts, - ) - - expect(get_response.embedded.sign_url).to be_truthy - rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" - exit - end - end - - it "testSendWithoutFileError" do - signature_request_api = Dropbox::Sign::SignatureRequestApi.new - - data = JSON.parse( - File.read(__dir__ + "/../test_fixtures/SignatureRequestSendRequest.json"), - :symbolize_names => true, - ) - - send_request = Dropbox::Sign::SignatureRequestSendRequest.init(data) - - begin - send_response = signature_request_api.signature_request_send(send_request, opts) - - puts "Should have thrown: #{send_response}" - exit - rescue Dropbox::Sign::ApiError => e - expect(e.response_body.error.error_path) - .to eq("file") - end - end -end diff --git a/sandbox/ruby/spec/spec_helper.rb b/sandbox/ruby/spec/spec_helper.rb deleted file mode 100644 index a365de3db..000000000 --- a/sandbox/ruby/spec/spec_helper.rb +++ /dev/null @@ -1,111 +0,0 @@ -=begin -#Dropbox Sign API - -#Dropbox Sign v3 API - -The version of the OpenAPI document: 3.0.0 -Contact: apisupport@hellosign.com -Generated by: https://openapi-generator.tech -Generator version: 7.8.0 - -=end - -# load the gem -require 'dropbox-sign' - -# The following was generated by the `rspec --init` command. Conventionally, all -# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. -# The generated `.rspec` file contains `--require spec_helper` which will cause -# this file to always be loaded, without a need to explicitly require it in any -# files. -# -# Given that it is always loaded, you are encouraged to keep this file as -# light-weight as possible. Requiring heavyweight dependencies from this file -# will add to the boot time of your test suite on EVERY test run, even for an -# individual file that may not need all of that loaded. Instead, consider making -# a separate helper file that requires the additional dependencies and performs -# the additional setup, and require it from the spec files that actually need -# it. -# -# The `.rspec` file also contains a few flags that are not defaults but that -# users commonly want. -# -# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration -RSpec.configure do |config| - # rspec-expectations config goes here. You can use an alternate - # assertion/expectation library such as wrong or the stdlib/minitest - # assertions if you prefer. - config.expect_with :rspec do |expectations| - # This option will default to `true` in RSpec 4. It makes the `description` - # and `failure_message` of custom matchers include text for helper methods - # defined using `chain`, e.g.: - # be_bigger_than(2).and_smaller_than(4).description - # # => "be bigger than 2 and smaller than 4" - # ...rather than: - # # => "be bigger than 2" - expectations.include_chain_clauses_in_custom_matcher_descriptions = true - end - - # rspec-mocks config goes here. You can use an alternate test double - # library (such as bogus or mocha) by changing the `mock_with` option here. - config.mock_with :rspec do |mocks| - # Prevents you from mocking or stubbing a method that does not exist on - # a real object. This is generally recommended, and will default to - # `true` in RSpec 4. - mocks.verify_partial_doubles = true - end - -# The settings below are suggested to provide a good initial experience -# with RSpec, but feel free to customize to your heart's content. -=begin - # These two settings work together to allow you to limit a spec run - # to individual examples or groups you care about by tagging them with - # `:focus` metadata. When nothing is tagged with `:focus`, all examples - # get run. - config.filter_run :focus - config.run_all_when_everything_filtered = true - - # Allows RSpec to persist some state between runs in order to support - # the `--only-failures` and `--next-failure` CLI options. We recommend - # you configure your source control system to ignore this file. - config.example_status_persistence_file_path = "spec/examples.txt" - - # Limits the available syntax to the non-monkey patched syntax that is - # recommended. For more details, see: - # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/ - # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/ - # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode - config.disable_monkey_patching! - - # This setting enables warnings. It's recommended, but in some cases may - # be too noisy due to issues in dependencies. - config.warnings = true - - # Many RSpec users commonly either run the entire suite or an individual - # file, and it's useful to allow more verbose output when running an - # individual spec file. - if config.files_to_run.one? - # Use the documentation formatter for detailed output, - # unless a formatter has already been configured - # (e.g. via a command-line flag). - config.default_formatter = 'doc' - end - - # Print the 10 slowest examples and example groups at the - # end of the spec run, to help surface which specs are running - # particularly slow. - config.profile_examples = 10 - - # Run specs in random order to surface order dependencies. If you find an - # order dependency and want to debug it, you can fix the order by providing - # the seed, which is printed after each run. - # --seed 1234 - config.order = :random - - # Seed global randomization in this process using the `--seed` CLI option. - # Setting this allows you to use `--seed` to deterministically reproduce - # test failures related to randomization by passing the same `--seed` value - # as the one that triggered the failure. - Kernel.srand config.seed -=end -end diff --git a/sandbox/ruby/src/AccountCreateExample.rb b/sandbox/ruby/src/AccountCreateExample.rb new file mode 100644 index 000000000..6ce6db264 --- /dev/null +++ b/sandbox/ruby/src/AccountCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" + +begin + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_create: #{e}" +end diff --git a/sandbox/ruby/src/AccountCreateOauthExample.rb b/sandbox/ruby/src/AccountCreateOauthExample.rb new file mode 100644 index 000000000..26ebdc768 --- /dev/null +++ b/sandbox/ruby/src/AccountCreateOauthExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" +account_create_request.client_id = "cc91c61d00f8bb2ece1428035716b" +account_create_request.client_secret = "1d14434088507ffa390e6f5528465" + +begin + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_create: #{e}" +end diff --git a/sandbox/ruby/src/AccountGetExample.rb b/sandbox/ruby/src/AccountGetExample.rb new file mode 100644 index 000000000..3b8fb5d9e --- /dev/null +++ b/sandbox/ruby/src/AccountGetExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::AccountApi.new.account_get + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_get: #{e}" +end diff --git a/sandbox/ruby/src/AccountUpdateExample.rb b/sandbox/ruby/src/AccountUpdateExample.rb new file mode 100644 index 000000000..f8d7f1b2d --- /dev/null +++ b/sandbox/ruby/src/AccountUpdateExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_update_request = Dropbox::Sign::AccountUpdateRequest.new +account_update_request.callback_url = "https://www.example.com/callback" +account_update_request.locale = "en-US" + +begin + response = Dropbox::Sign::AccountApi.new.account_update( + account_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_update: #{e}" +end diff --git a/sandbox/ruby/src/AccountVerifyExample.rb b/sandbox/ruby/src/AccountVerifyExample.rb new file mode 100644 index 000000000..8e57affce --- /dev/null +++ b/sandbox/ruby/src/AccountVerifyExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +account_verify_request = Dropbox::Sign::AccountVerifyRequest.new +account_verify_request.email_address = "some_user@dropboxsign.com" + +begin + response = Dropbox::Sign::AccountApi.new.account_verify( + account_verify_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling AccountApi#account_verify: #{e}" +end diff --git a/sandbox/ruby/src/ApiAppCreateExample.rb b/sandbox/ruby/src/ApiAppCreateExample.rb new file mode 100644 index 000000000..d2b959780 --- /dev/null +++ b/sandbox/ruby/src/ApiAppCreateExample.rb @@ -0,0 +1,37 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] + +white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new +white_labeling_options.primary_button_color = "#00b3e6" +white_labeling_options.primary_button_text_color = "#ffffff" + +api_app_create_request = Dropbox::Sign::ApiAppCreateRequest.new +api_app_create_request.name = "My Production App" +api_app_create_request.domains = [ + "example.com", +] +api_app_create_request.custom_logo_file = File.new("CustomLogoFile.png", "r") +api_app_create_request.oauth = oauth +api_app_create_request.white_labeling_options = white_labeling_options + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_create( + api_app_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_create: #{e}" +end diff --git a/sandbox/ruby/src/ApiAppDeleteExample.rb b/sandbox/ruby/src/ApiAppDeleteExample.rb new file mode 100644 index 000000000..def7fb657 --- /dev/null +++ b/sandbox/ruby/src/ApiAppDeleteExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::ApiAppApi.new.api_app_delete( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_delete: #{e}" +end diff --git a/sandbox/ruby/src/ApiAppGetExample.rb b/sandbox/ruby/src/ApiAppGetExample.rb new file mode 100644 index 000000000..f40c92b55 --- /dev/null +++ b/sandbox/ruby/src/ApiAppGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_get( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_get: #{e}" +end diff --git a/sandbox/ruby/src/ApiAppListExample.rb b/sandbox/ruby/src/ApiAppListExample.rb new file mode 100644 index 000000000..3e776c659 --- /dev/null +++ b/sandbox/ruby/src/ApiAppListExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_list: #{e}" +end diff --git a/sandbox/ruby/src/ApiAppUpdateExample.rb b/sandbox/ruby/src/ApiAppUpdateExample.rb new file mode 100644 index 000000000..e973b3520 --- /dev/null +++ b/sandbox/ruby/src/ApiAppUpdateExample.rb @@ -0,0 +1,39 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] + +white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new +white_labeling_options.primary_button_color = "#00b3e6" +white_labeling_options.primary_button_text_color = "#ffffff" + +api_app_update_request = Dropbox::Sign::ApiAppUpdateRequest.new +api_app_update_request.callback_url = "https://example.com/dropboxsign" +api_app_update_request.name = "New Name" +api_app_update_request.domains = [ + "example.com", +] +api_app_update_request.custom_logo_file = File.new("CustomLogoFile.png", "r") +api_app_update_request.oauth = oauth +api_app_update_request.white_labeling_options = white_labeling_options + +begin + response = Dropbox::Sign::ApiAppApi.new.api_app_update( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + api_app_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ApiAppApi#api_app_update: #{e}" +end diff --git a/sandbox/ruby/src/BulkSendJobGetExample.rb b/sandbox/ruby/src/BulkSendJobGetExample.rb new file mode 100644 index 000000000..bf4b58570 --- /dev/null +++ b/sandbox/ruby/src/BulkSendJobGetExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_get( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", # bulk_send_job_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}" +end diff --git a/sandbox/ruby/src/BulkSendJobListExample.rb b/sandbox/ruby/src/BulkSendJobListExample.rb new file mode 100644 index 000000000..60e8c1b50 --- /dev/null +++ b/sandbox/ruby/src/BulkSendJobListExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::BulkSendJobApi.new.bulk_send_job_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}" +end diff --git a/sandbox/ruby/src/EmbeddedEditUrlExample.rb b/sandbox/ruby/src/EmbeddedEditUrlExample.rb new file mode 100644 index 000000000..8c110f69d --- /dev/null +++ b/sandbox/ruby/src/EmbeddedEditUrlExample.rb @@ -0,0 +1,27 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +merge_fields = [ +] + +embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new +embedded_edit_url_request.cc_roles = [ + "", +] +embedded_edit_url_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::EmbeddedApi.new.embedded_edit_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + embedded_edit_url_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}" +end diff --git a/sandbox/ruby/src/EmbeddedSignUrlExample.rb b/sandbox/ruby/src/EmbeddedSignUrlExample.rb new file mode 100644 index 000000000..dd08e5a6f --- /dev/null +++ b/sandbox/ruby/src/EmbeddedSignUrlExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::EmbeddedApi.new.embedded_sign_url( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}" +end diff --git a/sandbox/ruby/src/EventCallbackExample.rb b/sandbox/ruby/src/EventCallbackExample.rb new file mode 100644 index 000000000..c3b6ca98a --- /dev/null +++ b/sandbox/ruby/src/EventCallbackExample.rb @@ -0,0 +1,29 @@ +require "dropbox-sign" + +# use your API key +api_key = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782" + +# callback_data represents data we send to you +callback_data = { + event: { + event_type: "account_confirmed", + event_time: "1669926463", + event_hash: "ff8b03439122f9160500c3fb855bdee5a9ccba5fff27d3b258745d8f3074832f", + event_metadata: { + related_signature_id: nil, + reported_for_account_id: "6421d70b9bd45059fa207d03ab8d1b96515b472c", + reported_for_app_id: nil, + event_message: nil, + }, + }, +} + +callback_event = Dropbox::Sign::EventCallbackRequest.init(callback_data) + +# verify that a callback came from HelloSign.com +if Dropbox::Sign::EventCallbackHelper.is_valid(api_key, callback_event) + # one of "account_callback" or "api_app_callback" + callback_type = Dropbox::Sign::EventCallbackHelper.get_callback_type(callback_event) + + # do your magic below! +end diff --git a/sandbox/ruby/src/FaxDeleteExample.rb b/sandbox/ruby/src/FaxDeleteExample.rb new file mode 100644 index 000000000..6caa9d681 --- /dev/null +++ b/sandbox/ruby/src/FaxDeleteExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::FaxApi.new.fax_delete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_delete: #{e}" +end diff --git a/sandbox/ruby/src/FaxFilesExample.rb b/sandbox/ruby/src/FaxFilesExample.rb new file mode 100644 index 000000000..b44d604c4 --- /dev/null +++ b/sandbox/ruby/src/FaxFilesExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_files: #{e}" +end diff --git a/sandbox/ruby/src/FaxGetExample.rb b/sandbox/ruby/src/FaxGetExample.rb new file mode 100644 index 000000000..692ae1c99 --- /dev/null +++ b/sandbox/ruby/src/FaxGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_get: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineAddUserExample.rb b/sandbox/ruby/src/FaxLineAddUserExample.rb new file mode 100644 index 000000000..4d7f568bb --- /dev/null +++ b/sandbox/ruby/src/FaxLineAddUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_add_user_request = Dropbox::Sign::FaxLineAddUserRequest.new +fax_line_add_user_request.number = "[FAX_NUMBER]" +fax_line_add_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_add_user( + fax_line_add_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineAreaCodeGetExample.rb b/sandbox/ruby/src/FaxLineAreaCodeGetExample.rb new file mode 100644 index 000000000..75c3a3c3e --- /dev/null +++ b/sandbox/ruby/src/FaxLineAreaCodeGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get( + "US", # country + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineCreateExample.rb b/sandbox/ruby/src/FaxLineCreateExample.rb new file mode 100644 index 000000000..5342e5c31 --- /dev/null +++ b/sandbox/ruby/src/FaxLineCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new +fax_line_create_request.area_code = 209 +fax_line_create_request.country = "US" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_create( + fax_line_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_create: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineDeleteExample.rb b/sandbox/ruby/src/FaxLineDeleteExample.rb new file mode 100644 index 000000000..c54da52b1 --- /dev/null +++ b/sandbox/ruby/src/FaxLineDeleteExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new +fax_line_delete_request.number = "[FAX_NUMBER]" + +begin + Dropbox::Sign::FaxLineApi.new.fax_line_delete( + fax_line_delete_request, + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_delete: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineGetExample.rb b/sandbox/ruby/src/FaxLineGetExample.rb new file mode 100644 index 000000000..d4a749bd8 --- /dev/null +++ b/sandbox/ruby/src/FaxLineGetExample.rb @@ -0,0 +1,16 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_get( + "123-123-1234", # number + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_get: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineListExample.rb b/sandbox/ruby/src/FaxLineListExample.rb new file mode 100644 index 000000000..0da5a39e4 --- /dev/null +++ b/sandbox/ruby/src/FaxLineListExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_list( + { + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_list: #{e}" +end diff --git a/sandbox/ruby/src/FaxLineRemoveUserExample.rb b/sandbox/ruby/src/FaxLineRemoveUserExample.rb new file mode 100644 index 000000000..4f67f7e11 --- /dev/null +++ b/sandbox/ruby/src/FaxLineRemoveUserExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new +fax_line_remove_user_request.number = "[FAX_NUMBER]" +fax_line_remove_user_request.email_address = "member@dropboxsign.com" + +begin + response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user( + fax_line_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}" +end diff --git a/sandbox/ruby/src/FaxListExample.rb b/sandbox/ruby/src/FaxListExample.rb new file mode 100644 index 000000000..519e04dad --- /dev/null +++ b/sandbox/ruby/src/FaxListExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + response = Dropbox::Sign::FaxApi.new.fax_list( + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_list: #{e}" +end diff --git a/sandbox/ruby/src/FaxSendExample.rb b/sandbox/ruby/src/FaxSendExample.rb new file mode 100644 index 000000000..4faeaa725 --- /dev/null +++ b/sandbox/ruby/src/FaxSendExample.rb @@ -0,0 +1,28 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +fax_send_request = Dropbox::Sign::FaxSendRequest.new +fax_send_request.recipient = "16690000001" +fax_send_request.sender = "16690000000" +fax_send_request.test_mode = true +fax_send_request.cover_page_to = "Jill Fax" +fax_send_request.cover_page_from = "Faxer Faxerson" +fax_send_request.cover_page_message = "I'm sending you a fax!" +fax_send_request.title = "This is what the fax is about!" +fax_send_request.files = [ + File.new("./example_fax.pdf", "r"), +] + +begin + response = Dropbox::Sign::FaxApi.new.fax_send( + fax_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling FaxApi#fax_send: #{e}" +end diff --git a/sandbox/ruby/src/OauthTokenGenerateExample.rb b/sandbox/ruby/src/OauthTokenGenerateExample.rb new file mode 100644 index 000000000..47553822e --- /dev/null +++ b/sandbox/ruby/src/OauthTokenGenerateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_generate_request = Dropbox::Sign::OAuthTokenGenerateRequest.new +o_auth_token_generate_request.client_id = "cc91c61d00f8bb2ece1428035716b" +o_auth_token_generate_request.client_secret = "1d14434088507ffa390e6f5528465" +o_auth_token_generate_request.code = "1b0d28d90c86c141" +o_auth_token_generate_request.state = "900e06e2" +o_auth_token_generate_request.grant_type = "authorization_code" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_generate( + o_auth_token_generate_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_generate: #{e}" +end diff --git a/sandbox/ruby/src/OauthTokenRefreshExample.rb b/sandbox/ruby/src/OauthTokenRefreshExample.rb new file mode 100644 index 000000000..5068b44da --- /dev/null +++ b/sandbox/ruby/src/OauthTokenRefreshExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| +end + +o_auth_token_refresh_request = Dropbox::Sign::OAuthTokenRefreshRequest.new +o_auth_token_refresh_request.grant_type = "refresh_token" +o_auth_token_refresh_request.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" + +begin + response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh( + o_auth_token_refresh_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}" +end diff --git a/sandbox/ruby/src/ReportCreateExample.rb b/sandbox/ruby/src/ReportCreateExample.rb new file mode 100644 index 000000000..d5169ca61 --- /dev/null +++ b/sandbox/ruby/src/ReportCreateExample.rb @@ -0,0 +1,24 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +report_create_request = Dropbox::Sign::ReportCreateRequest.new +report_create_request.start_date = "09/01/2020" +report_create_request.end_date = "09/01/2020" +report_create_request.report_type = [ + "user_activity", + "document_status", +] + +begin + response = Dropbox::Sign::ReportApi.new.report_create( + report_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling ReportApi#report_create: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..e01b04f47 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new +signature_request_bulk_create_embedded_with_template_request.client_id = "1a659d9ad95bccd307ecad78d72192f8" +signature_request_bulk_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_bulk_create_embedded_with_template_request.test_mode = true +signature_request_bulk_create_embedded_with_template_request.signer_list = signer_list +signature_request_bulk_create_embedded_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_create_embedded_with_template( + signature_request_bulk_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestBulkSendWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestBulkSendWithTemplateExample.rb new file mode 100644 index 000000000..27f2d66d5 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestBulkSendWithTemplateExample.rb @@ -0,0 +1,84 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signer_list_2_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_2_custom_fields_1.name = "company" +signer_list_2_custom_fields_1.value = "123 LLC" + +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] + +signer_list_2_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_2_signers_1.role = "Client" +signer_list_2_signers_1.name = "Mary" +signer_list_2_signers_1.email_address = "mary@example.com" +signer_list_2_signers_1.pin = "gd9as5b" + +signer_list_2_signers = [ + signer_list_2_signers_1, +] + +signer_list_1_custom_fields_1 = Dropbox::Sign::SubBulkSignerListCustomField.new +signer_list_1_custom_fields_1.name = "company" +signer_list_1_custom_fields_1.value = "ABC Corp" + +signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, +] + +signer_list_1_signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signer_list_1_signers_1.role = "Client" +signer_list_1_signers_1.name = "George" +signer_list_1_signers_1.email_address = "george@example.com" +signer_list_1_signers_1.pin = "d79a3td" + +signer_list_1_signers = [ + signer_list_1_signers_1, +] + +signer_list_1 = Dropbox::Sign::SubBulkSignerList.new +signer_list_1.custom_fields = signer_list_1_custom_fields +signer_list_1.signers = signer_list_1_signers + +signer_list_2 = Dropbox::Sign::SubBulkSignerList.new +signer_list_2.custom_fields = signer_list_2_custom_fields +signer_list_2.signers = signer_list_2_signers + +signer_list = [ + signer_list_1, + signer_list_2, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +signature_request_bulk_send_with_template_request = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new +signature_request_bulk_send_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_bulk_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_bulk_send_with_template_request.subject = "Purchase Order" +signature_request_bulk_send_with_template_request.test_mode = true +signature_request_bulk_send_with_template_request.signer_list = signer_list +signature_request_bulk_send_with_template_request.ccs = ccs + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_bulk_send_with_template( + signature_request_bulk_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestCancelExample.rb b/sandbox/ruby/src/SignatureRequestCancelExample.rb new file mode 100644 index 000000000..9f3ff955e --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestCancelExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_cancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb new file mode 100644 index 000000000..55db08ca7 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedExample.rb @@ -0,0 +1,55 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb new file mode 100644 index 000000000..9910ee894 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedGroupedSignersExample.rb @@ -0,0 +1,81 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_create_embedded_request = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new +signature_request_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_create_embedded_request.subject = "The NDA we talked about" +signature_request_create_embedded_request.test_mode = true +signature_request_create_embedded_request.title = "NDA with Acme Co." +signature_request_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_create_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_create_embedded_request.signing_options = signing_options +signature_request_create_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded( + signature_request_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..2de72cf8a --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +signature_request_create_embedded_with_template_request = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new +signature_request_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_create_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_create_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_create_embedded_with_template_request.subject = "Purchase Order" +signature_request_create_embedded_with_template_request.test_mode = true +signature_request_create_embedded_with_template_request.signing_options = signing_options +signature_request_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_create_embedded_with_template( + signature_request_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb b/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb new file mode 100644 index 000000000..0e192377c --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestEditEmbeddedExample.rb @@ -0,0 +1,56 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb b/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb new file mode 100644 index 000000000..0fc7bc7a3 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestEditEmbeddedGroupedSignersExample.rb @@ -0,0 +1,82 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_embedded_request = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new +signature_request_edit_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_embedded_request.subject = "The NDA we talked about" +signature_request_edit_embedded_request.test_mode = true +signature_request_edit_embedded_request.title = "NDA with Acme Co." +signature_request_edit_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_embedded_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_embedded_request.signing_options = signing_options +signature_request_edit_embedded_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..f504f1944 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestEditEmbeddedWithTemplateExample.rb @@ -0,0 +1,45 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +signature_request_edit_embedded_with_template_request = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new +signature_request_edit_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +signature_request_edit_embedded_with_template_request.template_ids = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +] +signature_request_edit_embedded_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_embedded_with_template_request.subject = "Purchase Order" +signature_request_edit_embedded_with_template_request.test_mode = true +signature_request_edit_embedded_with_template_request.signing_options = signing_options +signature_request_edit_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_embedded_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestEditExample.rb b/sandbox/ruby/src/SignatureRequestEditExample.rb new file mode 100644 index 000000000..e55d7beee --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestEditExample.rb @@ -0,0 +1,66 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestEditGroupedSignersExample.rb b/sandbox/ruby/src/SignatureRequestEditGroupedSignersExample.rb new file mode 100644 index 000000000..2b19ffabb --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestEditGroupedSignersExample.rb @@ -0,0 +1,92 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_edit_request = Dropbox::Sign::SignatureRequestEditRequest.new +signature_request_edit_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_edit_request.subject = "The NDA we talked about" +signature_request_edit_request.test_mode = true +signature_request_edit_request.title = "NDA with Acme Co." +signature_request_edit_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_edit_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_edit_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_edit_request.field_options = field_options +signature_request_edit_request.signing_options = signing_options +signature_request_edit_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestEditWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestEditWithTemplateExample.rb new file mode 100644 index 000000000..f3c2d8ed6 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestEditWithTemplateExample.rb @@ -0,0 +1,64 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +custom_fields_1 = Dropbox::Sign::SubCustomField.new +custom_fields_1.name = "Cost" +custom_fields_1.editor = "Client" +custom_fields_1.required = true +custom_fields_1.value = "$20,000" + +custom_fields = [ + custom_fields_1, +] + +signature_request_edit_with_template_request = Dropbox::Sign::SignatureRequestEditWithTemplateRequest.new +signature_request_edit_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_edit_with_template_request.message = "Glad we could come to an agreement." +signature_request_edit_with_template_request.subject = "Purchase Order" +signature_request_edit_with_template_request.test_mode = true +signature_request_edit_with_template_request.signing_options = signing_options +signature_request_edit_with_template_request.signers = signers +signature_request_edit_with_template_request.ccs = ccs +signature_request_edit_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_edit_with_template( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_edit_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestFilesAsDataUriExample.rb b/sandbox/ruby/src/SignatureRequestFilesAsDataUriExample.rb new file mode 100644 index 000000000..9f9390e41 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestFilesAsDataUriExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_data_uri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestFilesAsFileUrlExample.rb b/sandbox/ruby/src/SignatureRequestFilesAsFileUrlExample.rb new file mode 100644 index 000000000..14abf28bf --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestFilesAsFileUrlExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files_as_file_url( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestFilesExample.rb b/sandbox/ruby/src/SignatureRequestFilesExample.rb new file mode 100644 index 000000000..1d891d696 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestFilesExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_files( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + { + file_type: "pdf", + }, + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestGetExample.rb b/sandbox/ruby/src/SignatureRequestGetExample.rb new file mode 100644 index 000000000..6399f34f6 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestListExample.rb b/sandbox/ruby/src/SignatureRequestListExample.rb new file mode 100644 index 000000000..2fcc01276 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestListExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestReleaseHoldExample.rb b/sandbox/ruby/src/SignatureRequestReleaseHoldExample.rb new file mode 100644 index 000000000..422ab2d05 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestReleaseHoldExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_release_hold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestRemindExample.rb b/sandbox/ruby/src/SignatureRequestRemindExample.rb new file mode 100644 index 000000000..722928d9e --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestRemindExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new +signature_request_remind_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_remind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_remind_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestRemoveExample.rb b/sandbox/ruby/src/SignatureRequestRemoveExample.rb new file mode 100644 index 000000000..7940519df --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestRemoveExample.rb @@ -0,0 +1,14 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" +end + +begin + Dropbox::Sign::SignatureRequestApi.new.signature_request_remove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestSendExample.rb b/sandbox/ruby/src/SignatureRequestSendExample.rb new file mode 100644 index 000000000..28905902d --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestSendExample.rb @@ -0,0 +1,65 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +signers_2.name = "Jill" +signers_2.email_address = "jill@example.com" +signers_2.order = 1 + +signers = [ + signers_1, + signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.signers = signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestSendGroupedSignersExample.rb b/sandbox/ruby/src/SignatureRequestSendGroupedSignersExample.rb new file mode 100644 index 000000000..dec38e89c --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestSendGroupedSignersExample.rb @@ -0,0 +1,91 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +grouped_signers_2_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_1.name = "Bob" +grouped_signers_2_signers_1.email_address = "bob@example.com" + +grouped_signers_2_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_2_signers_2.name = "Charlie" +grouped_signers_2_signers_2.email_address = "charlie@example.com" + +grouped_signers_2_signers = [ + grouped_signers_2_signers_1, + grouped_signers_2_signers_2, +] + +grouped_signers_1_signers_1 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_1.name = "Jack" +grouped_signers_1_signers_1.email_address = "jack@example.com" + +grouped_signers_1_signers_2 = Dropbox::Sign::SubSignatureRequestSigner.new +grouped_signers_1_signers_2.name = "Jill" +grouped_signers_1_signers_2.email_address = "jill@example.com" + +grouped_signers_1_signers = [ + grouped_signers_1_signers_1, + grouped_signers_1_signers_2, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +grouped_signers_1 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_1.group = "Group #1" +grouped_signers_1.order = 0 +grouped_signers_1.signers = grouped_signers_1_signers + +grouped_signers_2 = Dropbox::Sign::SubSignatureRequestGroupedSigners.new +grouped_signers_2.group = "Group #2" +grouped_signers_2.order = 1 +grouped_signers_2.signers = grouped_signers_2_signers + +grouped_signers = [ + grouped_signers_1, + grouped_signers_2, +] + +signature_request_send_request = Dropbox::Sign::SignatureRequestSendRequest.new +signature_request_send_request.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions." +signature_request_send_request.subject = "The NDA we talked about" +signature_request_send_request.test_mode = true +signature_request_send_request.title = "NDA with Acme Co." +signature_request_send_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +signature_request_send_request.cc_email_addresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +] +signature_request_send_request.metadata = JSON.parse(<<-EOD + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD +) +signature_request_send_request.field_options = field_options +signature_request_send_request.signing_options = signing_options +signature_request_send_request.grouped_signers = grouped_signers + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb b/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb new file mode 100644 index 000000000..4ee78fded --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestSendWithTemplateExample.rb @@ -0,0 +1,63 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" +signing_options.draw = true +signing_options.phone = false +signing_options.type = true +signing_options.upload = true + +signers_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@example.com" + +ccs = [ + ccs_1, +] + +custom_fields_1 = Dropbox::Sign::SubCustomField.new +custom_fields_1.name = "Cost" +custom_fields_1.editor = "Client" +custom_fields_1.required = true +custom_fields_1.value = "$20,000" + +custom_fields = [ + custom_fields_1, +] + +signature_request_send_with_template_request = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new +signature_request_send_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +signature_request_send_with_template_request.message = "Glad we could come to an agreement." +signature_request_send_with_template_request.subject = "Purchase Order" +signature_request_send_with_template_request.test_mode = true +signature_request_send_with_template_request.signing_options = signing_options +signature_request_send_with_template_request.signers = signers +signature_request_send_with_template_request.ccs = ccs +signature_request_send_with_template_request.custom_fields = custom_fields + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send_with_template( + signature_request_send_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}" +end diff --git a/sandbox/ruby/src/SignatureRequestUpdateExample.rb b/sandbox/ruby/src/SignatureRequestUpdateExample.rb new file mode 100644 index 000000000..3cac8ae67 --- /dev/null +++ b/sandbox/ruby/src/SignatureRequestUpdateExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signature_request_update_request = Dropbox::Sign::SignatureRequestUpdateRequest.new +signature_request_update_request.signature_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +signature_request_update_request.email_address = "john@example.com" + +begin + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_update( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + signature_request_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}" +end diff --git a/sandbox/ruby/src/TeamAddMemberAccountIdExample.rb b/sandbox/ruby/src/TeamAddMemberAccountIdExample.rb new file mode 100644 index 000000000..e19955860 --- /dev/null +++ b/sandbox/ruby/src/TeamAddMemberAccountIdExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35" + +begin + response = Dropbox::Sign::TeamApi.new.team_add_member( + team_add_member_request, + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_add_member: #{e}" +end diff --git a/sandbox/ruby/src/TeamAddMemberExample.rb b/sandbox/ruby/src/TeamAddMemberExample.rb new file mode 100644 index 000000000..b312e9894 --- /dev/null +++ b/sandbox/ruby/src/TeamAddMemberExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.email_address = "george@example.com" + +begin + response = Dropbox::Sign::TeamApi.new.team_add_member( + team_add_member_request, + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_add_member: #{e}" +end diff --git a/sandbox/ruby/src/TeamCreateExample.rb b/sandbox/ruby/src/TeamCreateExample.rb new file mode 100644 index 000000000..6bac61268 --- /dev/null +++ b/sandbox/ruby/src/TeamCreateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_create_request = Dropbox::Sign::TeamCreateRequest.new +team_create_request.name = "New Team Name" + +begin + response = Dropbox::Sign::TeamApi.new.team_create( + team_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_create: #{e}" +end diff --git a/sandbox/ruby/src/TeamDeleteExample.rb b/sandbox/ruby/src/TeamDeleteExample.rb new file mode 100644 index 000000000..729b6f794 --- /dev/null +++ b/sandbox/ruby/src/TeamDeleteExample.rb @@ -0,0 +1,13 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::TeamApi.new.team_delete +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_delete: #{e}" +end diff --git a/sandbox/ruby/src/TeamGetExample.rb b/sandbox/ruby/src/TeamGetExample.rb new file mode 100644 index 000000000..903822830 --- /dev/null +++ b/sandbox/ruby/src/TeamGetExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_get + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_get: #{e}" +end diff --git a/sandbox/ruby/src/TeamInfoExample.rb b/sandbox/ruby/src/TeamInfoExample.rb new file mode 100644 index 000000000..dfe5874d5 --- /dev/null +++ b/sandbox/ruby/src/TeamInfoExample.rb @@ -0,0 +1,19 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_info( + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_info: #{e}" +end diff --git a/sandbox/ruby/src/TeamInvitesExample.rb b/sandbox/ruby/src/TeamInvitesExample.rb new file mode 100644 index 000000000..9fee219c0 --- /dev/null +++ b/sandbox/ruby/src/TeamInvitesExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_invites + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_invites: #{e}" +end diff --git a/sandbox/ruby/src/TeamMembersExample.rb b/sandbox/ruby/src/TeamMembersExample.rb new file mode 100644 index 000000000..f35f9d174 --- /dev/null +++ b/sandbox/ruby/src/TeamMembersExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_members( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_members: #{e}" +end diff --git a/sandbox/ruby/src/TeamRemoveMemberAccountIdExample.rb b/sandbox/ruby/src/TeamRemoveMemberAccountIdExample.rb new file mode 100644 index 000000000..16913dd79 --- /dev/null +++ b/sandbox/ruby/src/TeamRemoveMemberAccountIdExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new +team_remove_member_request.account_id = "f57db65d3f933b5316d398057a36176831451a35" + +begin + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_remove_member: #{e}" +end diff --git a/sandbox/ruby/src/TeamRemoveMemberExample.rb b/sandbox/ruby/src/TeamRemoveMemberExample.rb new file mode 100644 index 000000000..27c87cb0e --- /dev/null +++ b/sandbox/ruby/src/TeamRemoveMemberExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_remove_member_request = Dropbox::Sign::TeamRemoveMemberRequest.new +team_remove_member_request.email_address = "teammate@dropboxsign.com" +team_remove_member_request.new_owner_email_address = "new_teammate@dropboxsign.com" + +begin + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_remove_member: #{e}" +end diff --git a/sandbox/ruby/src/TeamSubTeamsExample.rb b/sandbox/ruby/src/TeamSubTeamsExample.rb new file mode 100644 index 000000000..12c87f2b7 --- /dev/null +++ b/sandbox/ruby/src/TeamSubTeamsExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TeamApi.new.team_sub_teams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", # team_id + { + page: 1, + page_size: 20, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_sub_teams: #{e}" +end diff --git a/sandbox/ruby/src/TeamUpdateExample.rb b/sandbox/ruby/src/TeamUpdateExample.rb new file mode 100644 index 000000000..7f925ffff --- /dev/null +++ b/sandbox/ruby/src/TeamUpdateExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +team_update_request = Dropbox::Sign::TeamUpdateRequest.new +team_update_request.name = "New Team Name" + +begin + response = Dropbox::Sign::TeamApi.new.team_update( + team_update_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TeamApi#team_update: #{e}" +end diff --git a/sandbox/ruby/src/TemplateAddUserExample.rb b/sandbox/ruby/src/TemplateAddUserExample.rb new file mode 100644 index 000000000..a34a81fbf --- /dev/null +++ b/sandbox/ruby/src/TemplateAddUserExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_add_user_request = Dropbox::Sign::TemplateAddUserRequest.new +template_add_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_add_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_add_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_add_user: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateEmbeddedDraftExample.rb b/sandbox/ruby/src/TemplateCreateEmbeddedDraftExample.rb new file mode 100644 index 000000000..8d40c03a2 --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateEmbeddedDraftExample.rb @@ -0,0 +1,62 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb b/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb new file mode 100644 index 000000000..3cf7abbf2 --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldGroupsExample.rb @@ -0,0 +1,108 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_field_groups = form_field_groups +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb b/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb new file mode 100644 index 000000000..38263c1cb --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldRulesExample.rb @@ -0,0 +1,124 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_field_rules = form_field_rules +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb b/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..525ee3773 --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +template_create_embedded_draft_request = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new +template_create_embedded_draft_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_embedded_draft_request.message = "For your approval" +template_create_embedded_draft_request.subject = "Please sign this document" +template_create_embedded_draft_request.test_mode = true +template_create_embedded_draft_request.title = "Test Template" +template_create_embedded_draft_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_embedded_draft_request.cc_roles = [ + "Manager", +] +template_create_embedded_draft_request.field_options = field_options +template_create_embedded_draft_request.form_fields_per_document = form_fields_per_document +template_create_embedded_draft_request.merge_fields = merge_fields +template_create_embedded_draft_request.signer_roles = signer_roles + +begin + response = Dropbox::Sign::TemplateApi.new.template_create_embedded_draft( + template_create_embedded_draft_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateExample.rb b/sandbox/ruby/src/TemplateCreateExample.rb new file mode 100644 index 000000000..f4d623397 --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateFormFieldGroupsExample.rb b/sandbox/ruby/src/TemplateCreateFormFieldGroupsExample.rb new file mode 100644 index 000000000..83fdc09bb --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateFormFieldGroupsExample.rb @@ -0,0 +1,108 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_groups = form_field_groups +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateFormFieldRulesExample.rb b/sandbox/ruby/src/TemplateCreateFormFieldRulesExample.rb new file mode 100644 index 000000000..cea893e1d --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateFormFieldRulesExample.rb @@ -0,0 +1,124 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.form_field_rules = form_field_rules +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/sandbox/ruby/src/TemplateCreateFormFieldsPerDocumentExample.rb b/sandbox/ruby/src/TemplateCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..39185b3d0 --- /dev/null +++ b/sandbox/ruby/src/TemplateCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,96 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +field_options = Dropbox::Sign::SubFieldOptions.new +field_options.date_format = "DD - MM - YYYY" + +signer_roles_1 = Dropbox::Sign::SubTemplateRole.new +signer_roles_1.name = "Client" +signer_roles_1.order = 0 + +signer_roles_2 = Dropbox::Sign::SubTemplateRole.new +signer_roles_2.name = "Witness" +signer_roles_2.order = 1 + +signer_roles = [ + signer_roles_1, + signer_roles_2, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +merge_fields_1 = Dropbox::Sign::SubMergeField.new +merge_fields_1.name = "Full Name" +merge_fields_1.type = "text" + +merge_fields_2 = Dropbox::Sign::SubMergeField.new +merge_fields_2.name = "Is Registered?" +merge_fields_2.type = "checkbox" + +merge_fields = [ + merge_fields_1, + merge_fields_2, +] + +template_create_request = Dropbox::Sign::TemplateCreateRequest.new +template_create_request.client_id = "37dee8d8440c66d54cfa05d92c160882" +template_create_request.message = "For your approval" +template_create_request.subject = "Please sign this document" +template_create_request.test_mode = true +template_create_request.title = "Test Template" +template_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +template_create_request.cc_roles = [ + "Manager", +] +template_create_request.field_options = field_options +template_create_request.signer_roles = signer_roles +template_create_request.form_fields_per_document = form_fields_per_document +template_create_request.merge_fields = merge_fields + +begin + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_create: #{e}" +end diff --git a/sandbox/ruby/src/TemplateDeleteExample.rb b/sandbox/ruby/src/TemplateDeleteExample.rb new file mode 100644 index 000000000..33e07f299 --- /dev/null +++ b/sandbox/ruby/src/TemplateDeleteExample.rb @@ -0,0 +1,15 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + Dropbox::Sign::TemplateApi.new.template_delete( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_delete: #{e}" +end diff --git a/sandbox/ruby/src/TemplateFilesAsDataUriExample.rb b/sandbox/ruby/src/TemplateFilesAsDataUriExample.rb new file mode 100644 index 000000000..c51e03680 --- /dev/null +++ b/sandbox/ruby/src/TemplateFilesAsDataUriExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files_as_data_uri( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_data_uri: #{e}" +end diff --git a/sandbox/ruby/src/TemplateFilesAsFileUrlExample.rb b/sandbox/ruby/src/TemplateFilesAsFileUrlExample.rb new file mode 100644 index 000000000..055fd32f6 --- /dev/null +++ b/sandbox/ruby/src/TemplateFilesAsFileUrlExample.rb @@ -0,0 +1,20 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files_as_file_url( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + { + force_download: 1, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files_as_file_url: #{e}" +end diff --git a/sandbox/ruby/src/TemplateFilesExample.rb b/sandbox/ruby/src/TemplateFilesExample.rb new file mode 100644 index 000000000..6aef00074 --- /dev/null +++ b/sandbox/ruby/src/TemplateFilesExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + FileUtils.cp(response.path, "./file_response") +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_files: #{e}" +end diff --git a/sandbox/ruby/src/TemplateGetExample.rb b/sandbox/ruby/src/TemplateGetExample.rb new file mode 100644 index 000000000..aacf15e90 --- /dev/null +++ b/sandbox/ruby/src/TemplateGetExample.rb @@ -0,0 +1,17 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_get( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_get: #{e}" +end diff --git a/sandbox/ruby/src/TemplateListExample.rb b/sandbox/ruby/src/TemplateListExample.rb new file mode 100644 index 000000000..a69c46f66 --- /dev/null +++ b/sandbox/ruby/src/TemplateListExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +begin + response = Dropbox::Sign::TemplateApi.new.template_list( + { + account_id: nil, + page: 1, + page_size: 20, + query: nil, + }, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_list: #{e}" +end diff --git a/sandbox/ruby/src/TemplateRemoveUserExample.rb b/sandbox/ruby/src/TemplateRemoveUserExample.rb new file mode 100644 index 000000000..00687e102 --- /dev/null +++ b/sandbox/ruby/src/TemplateRemoveUserExample.rb @@ -0,0 +1,21 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_remove_user_request = Dropbox::Sign::TemplateRemoveUserRequest.new +template_remove_user_request.email_address = "george@dropboxsign.com" + +begin + response = Dropbox::Sign::TemplateApi.new.template_remove_user( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_remove_user_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_remove_user: #{e}" +end diff --git a/sandbox/ruby/src/TemplateUpdateFilesExample.rb b/sandbox/ruby/src/TemplateUpdateFilesExample.rb new file mode 100644 index 000000000..d5088f2a7 --- /dev/null +++ b/sandbox/ruby/src/TemplateUpdateFilesExample.rb @@ -0,0 +1,23 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +template_update_files_request = Dropbox::Sign::TemplateUpdateFilesRequest.new +template_update_files_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::TemplateApi.new.template_update_files( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + template_update_files_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling TemplateApi#template_update_files: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedExample.rb new file mode 100644 index 000000000..a22330de8 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedExample.rb @@ -0,0 +1,25 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = true +unclaimed_draft_create_embedded_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb new file mode 100644 index 000000000..46129e4d7 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.rb @@ -0,0 +1,71 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_groups = form_field_groups +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb new file mode 100644 index 000000000..a6b174891 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.rb @@ -0,0 +1,87 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_field_rules = form_field_rules +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..774085a28 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.rb @@ -0,0 +1,59 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_embedded_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new +unclaimed_draft_create_embedded_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_request.test_mode = false +unclaimed_draft_create_embedded_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_embedded_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded( + unclaimed_draft_create_embedded_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb new file mode 100644 index 000000000..c6e799cae --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb @@ -0,0 +1,44 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@dropboxsign.com" + +ccs = [ + ccs_1, +] + +signers_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" + +signers = [ + signers_1, +] + +unclaimed_draft_create_embedded_with_template_request = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new +unclaimed_draft_create_embedded_with_template_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_create_embedded_with_template_request.requester_email_address = "jack@dropboxsign.com" +unclaimed_draft_create_embedded_with_template_request.template_ids = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +] +unclaimed_draft_create_embedded_with_template_request.test_mode = false +unclaimed_draft_create_embedded_with_template_request.ccs = ccs +unclaimed_draft_create_embedded_with_template_request.signers = signers + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create_embedded_with_template( + unclaimed_draft_create_embedded_with_template_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateExample.rb new file mode 100644 index 000000000..12f94dfd2 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateExample.rb @@ -0,0 +1,34 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +signers_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers = [ + signers_1, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = true +unclaimed_draft_create_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] +unclaimed_draft_create_request.signers = signers + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateFormFieldGroupsExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateFormFieldGroupsExample.rb new file mode 100644 index 000000000..881fde8ab --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateFormFieldGroupsExample.rb @@ -0,0 +1,70 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_groups_1 = Dropbox::Sign::SubFormFieldGroup.new +form_field_groups_1.group_id = "RadioItemGroup1" +form_field_groups_1.group_label = "Radio Item Group 1" +form_field_groups_1.requirement = "require_0-1" + +form_field_groups = [ + form_field_groups_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "radio" +form_fields_per_document_1.required = false +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 18 +form_fields_per_document_1.height = 18 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.group = "RadioItemGroup1" +form_fields_per_document_1.is_checked = true +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentRadio.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "radio" +form_fields_per_document_2.required = false +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 18 +form_fields_per_document_2.height = 18 +form_fields_per_document_2.x = 112 +form_fields_per_document_2.y = 370 +form_fields_per_document_2.group = "RadioItemGroup1" +form_fields_per_document_2.is_checked = false +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_groups = form_field_groups +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateFormFieldRulesExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateFormFieldRulesExample.rb new file mode 100644 index 000000000..54822f3a7 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateFormFieldRulesExample.rb @@ -0,0 +1,86 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_field_rules_1_triggers_1 = Dropbox::Sign::SubFormFieldRuleTrigger.new +form_field_rules_1_triggers_1.id = "uniqueIdHere_1" +form_field_rules_1_triggers_1.operator = "is" +form_field_rules_1_triggers_1.value = "foo" + +form_field_rules_1_triggers = [ + form_field_rules_1_triggers_1, +] + +form_field_rules_1_actions_1 = Dropbox::Sign::SubFormFieldRuleAction.new +form_field_rules_1_actions_1.hidden = true +form_field_rules_1_actions_1.type = "change-field-visibility" +form_field_rules_1_actions_1.field_id = "uniqueIdHere_2" + +form_field_rules_1_actions = [ + form_field_rules_1_actions_1, +] + +form_field_rules_1 = Dropbox::Sign::SubFormFieldRule.new +form_field_rules_1.id = "rule_1" +form_field_rules_1.trigger_operator = "AND" +form_field_rules_1.triggers = form_field_rules_1_triggers +form_field_rules_1.actions = form_field_rules_1_actions + +form_field_rules = [ + form_field_rules_1, +] + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "0" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_field_rules = form_field_rules +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb b/sandbox/ruby/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb new file mode 100644 index 000000000..e4bc66ec0 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftCreateFormFieldsPerDocumentExample.rb @@ -0,0 +1,58 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +form_fields_per_document_1 = Dropbox::Sign::SubFormFieldsPerDocumentText.new +form_fields_per_document_1.document_index = 0 +form_fields_per_document_1.api_id = "uniqueIdHere_1" +form_fields_per_document_1.type = "text" +form_fields_per_document_1.required = true +form_fields_per_document_1.signer = "1" +form_fields_per_document_1.width = 100 +form_fields_per_document_1.height = 16 +form_fields_per_document_1.x = 112 +form_fields_per_document_1.y = 328 +form_fields_per_document_1.name = "" +form_fields_per_document_1.page = 1 +form_fields_per_document_1.placeholder = "" +form_fields_per_document_1.validation_type = "numbers_only" + +form_fields_per_document_2 = Dropbox::Sign::SubFormFieldsPerDocumentSignature.new +form_fields_per_document_2.document_index = 0 +form_fields_per_document_2.api_id = "uniqueIdHere_2" +form_fields_per_document_2.type = "signature" +form_fields_per_document_2.required = true +form_fields_per_document_2.signer = "0" +form_fields_per_document_2.width = 120 +form_fields_per_document_2.height = 30 +form_fields_per_document_2.x = 530 +form_fields_per_document_2.y = 415 +form_fields_per_document_2.name = "" +form_fields_per_document_2.page = 1 + +form_fields_per_document = [ + form_fields_per_document_1, + form_fields_per_document_2, +] + +unclaimed_draft_create_request = Dropbox::Sign::UnclaimedDraftCreateRequest.new +unclaimed_draft_create_request.type = "request_signature" +unclaimed_draft_create_request.test_mode = false +unclaimed_draft_create_request.file_urls = [ + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1", +] +unclaimed_draft_create_request.form_fields_per_document = form_fields_per_document + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" +end diff --git a/sandbox/ruby/src/UnclaimedDraftEditAndResendExample.rb b/sandbox/ruby/src/UnclaimedDraftEditAndResendExample.rb new file mode 100644 index 000000000..dccc4d027 --- /dev/null +++ b/sandbox/ruby/src/UnclaimedDraftEditAndResendExample.rb @@ -0,0 +1,22 @@ +require "json" +require "dropbox-sign" + +Dropbox::Sign.configure do |config| + config.username = "YOUR_API_KEY" + # config.access_token = "YOUR_ACCESS_TOKEN" +end + +unclaimed_draft_edit_and_resend_request = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new +unclaimed_draft_edit_and_resend_request.client_id = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a" +unclaimed_draft_edit_and_resend_request.test_mode = false + +begin + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_edit_and_resend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + unclaimed_draft_edit_and_resend_request, + ) + + p response +rescue Dropbox::Sign::ApiError => e + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: #{e}" +end diff --git a/sandbox/ruby/test_fixtures/SignatureRequestCreateEmbeddedRequest.json b/sandbox/ruby/test_fixtures/SignatureRequestCreateEmbeddedRequest.json deleted file mode 100644 index f9bd157f8..000000000 --- a/sandbox/ruby/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "MM / DD / YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/ruby/test_fixtures/SignatureRequestSendRequest.json b/sandbox/ruby/test_fixtures/SignatureRequestSendRequest.json deleted file mode 100644 index 9560ddd52..000000000 --- a/sandbox/ruby/test_fixtures/SignatureRequestSendRequest.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "allow_decline": true, - "allow_reassign": true, - "attachments": [ - { - "name": "Attachment1", - "signer_index": 1, - "instructions": "Upload your Driver's License", - "required": true - } - ], - "cc_email_addresses": [ - "lawyer1@example.com", - "lawyer2@example.com" - ], - "field_options": { - "date_format": "DD - MM - YYYY" - }, - "form_field_groups": [ - { - "group_id": "radio_group_1", - "group_label": "Radio Group 1", - "requirement": "require_0-1" - } - ], - "form_field_rules": [ - { - "id": "rule_1", - "trigger_operator": "AND", - "triggers": [ - { - "id": "api_id_1", - "operator": "is", - "value": "foo" - } - ], - "actions": [ - { - "field_id": "api_id_2", - "hidden": true, - "type": "change-field-visibility" - } - ] - } - ], - "form_fields_per_document": [ - { - "document_index": 0, - "api_id": "api_id_1", - "name": "field_1", - "type": "text", - "x": 0, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": "0", - "page": 1, - "font_family": "roboto", - "font_size": 11 - }, - { - "document_index": 0, - "api_id": "api_id_2", - "name": "field_2", - "type": "text", - "x": 300, - "y": 0, - "width": 120, - "height": 30, - "required": true, - "signer": 0, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_3", - "name": "field_3", - "type": "dropdown", - "options": [ - "Option 1", - "Option 2", - "Option 3" - ], - "x": 0, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": 1, - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_4", - "name": "field_4", - "type": "text", - "x": 300, - "y": 200, - "width": 120, - "height": 30, - "required": true, - "signer": "1", - "page": 1, - "font_size": 12 - }, - { - "document_index": 0, - "api_id": "api_id_5", - "name": "field_5", - "type": "radio", - "group": "radio_group_1", - "is_checked": true, - "x": 0, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - }, - { - "document_index": 0, - "api_id": "api_id_6", - "name": "field_6", - "type": "radio", - "group": "radio_group_1", - "is_checked": false, - "x": 300, - "y": 400, - "width": 100, - "height": 16, - "required": false, - "signer": "2", - "page": 1 - } - ], - "message": "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", - "metadata": { - "custom_id": 1234, - "custom_text": "NDA #9" - }, - "signers": [ - { - "email_address": "s1@example.com", - "name": "Signer 1", - "order": 0 - }, - { - "email_address": "s2@example.com", - "name": "Signer 2", - "order": 1 - }, - { - "email_address": "s3@example.com", - "name": "Signer 3", - "order": 2 - } - ], - "test_mode": true -} diff --git a/sandbox/ruby/test_fixtures/pdf-sample.pdf b/sandbox/ruby/test_fixtures/pdf-sample.pdf deleted file mode 100644 index f698ff53d..000000000 Binary files a/sandbox/ruby/test_fixtures/pdf-sample.pdf and /dev/null differ diff --git a/sdks/dotnet/README.md b/sdks/dotnet/README.md index fcea11bde..4f715b358 100644 --- a/sdks/dotnet/README.md +++ b/sdks/dotnet/README.md @@ -82,36 +82,39 @@ c.Proxy = webProxy; ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class AccountCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountCreateRequest( + var accountCreateRequest = new AccountCreateRequest( emailAddress: "newuser@dropboxsign.com" ); try { - var result = accountApi.AccountCreate(data); - Console.WriteLine(result); + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/AccountApi.md b/sdks/dotnet/docs/AccountApi.md index 897f4d2ab..f62f83365 100644 --- a/sdks/dotnet/docs/AccountApi.md +++ b/sdks/dotnet/docs/AccountApi.md @@ -20,36 +20,39 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class AccountCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountCreateRequest( + var accountCreateRequest = new AccountCreateRequest( emailAddress: "newuser@dropboxsign.com" ); try { - var result = accountApi.AccountCreate(data); - Console.WriteLine(result); + var response = new AccountApi(config).AccountCreate( + accountCreateRequest: accountCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling AccountApi#AccountCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -117,32 +120,33 @@ Returns the properties and settings of your Account. ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class AccountGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = accountApi.AccountGet(null, "jack@example.com"); - Console.WriteLine(result); + var response = new AccountApi(config).AccountGet(); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling AccountApi#AccountGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -211,36 +215,40 @@ Updates the properties and settings of your Account. Currently only allows for u ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class AccountUpdateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountUpdateRequest( - callbackUrl: "https://www.example.com/callback" + var accountUpdateRequest = new AccountUpdateRequest( + callbackUrl: "https://www.example.com/callback", + locale: "en-US" ); try { - var result = accountApi.AccountUpdate(data); - Console.WriteLine(result); + var response = new AccountApi(config).AccountUpdate( + accountUpdateRequest: accountUpdateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling AccountApi#AccountUpdate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -308,36 +316,39 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class AccountVerifyExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var accountApi = new AccountApi(config); - - var data = new AccountVerifyRequest( + var accountVerifyRequest = new AccountVerifyRequest( emailAddress: "some_user@dropboxsign.com" ); try { - var result = accountApi.AccountVerify(data); - Console.WriteLine(result); + var response = new AccountApi(config).AccountVerify( + accountVerifyRequest: accountVerifyRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling AccountApi#AccountVerify: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/ApiAppApi.md b/sdks/dotnet/docs/ApiAppApi.md index e587a69d8..e94d26a30 100644 --- a/sdks/dotnet/docs/ApiAppApi.md +++ b/sdks/dotnet/docs/ApiAppApi.md @@ -23,29 +23,28 @@ Creates a new API App. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ApiAppCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; var oauth = new SubOAuth( callbackUrl: "https://example.com/oauth", - scopes: new List() { + scopes: [ SubOAuth.ScopesEnum.BasicAccountInfo, - SubOAuth.ScopesEnum.RequestSignature - } + SubOAuth.ScopesEnum.RequestSignature, + ] ); var whiteLabelingOptions = new SubWhiteLabelingOptions( @@ -53,27 +52,30 @@ public class Example primaryButtonTextColor: "#ffffff" ); - var customLogoFile = new FileStream( - "CustomLogoFile.png", - FileMode.Open - ); - - var data = new ApiAppCreateRequest( + var apiAppCreateRequest = new ApiAppCreateRequest( name: "My Production App", - domains: new List(){"example.com"}, + domains: [ + "example.com", + ], + customLogoFile: new FileStream( + path: "CustomLogoFile.png", + mode: FileMode.Open + ), oauth: oauth, - whiteLabelingOptions: whiteLabelingOptions, - customLogoFile: customLogoFile + whiteLabelingOptions: whiteLabelingOptions ); try { - var result = apiAppApi.ApiAppCreate(data); - Console.WriteLine(result); + var response = new ApiAppApi(config).ApiAppCreate( + apiAppCreateRequest: apiAppCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ApiAppApi#ApiAppCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -143,32 +145,31 @@ Deletes an API App. Can only be invoked for apps you own. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ApiAppDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - apiAppApi.ApiAppDelete(clientId); + new ApiAppApi(config).ApiAppDelete( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ApiAppApi#ApiAppDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -233,34 +234,35 @@ Returns an object with information about an API App. ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ApiAppGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = apiAppApi.ApiAppGet(clientId); - Console.WriteLine(result); + var response = new ApiAppApi(config).ApiAppGet( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ApiAppApi#ApiAppGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -328,35 +330,36 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ApiAppListExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); - - var page = 1; - var pageSize = 2; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = apiAppApi.ApiAppList(page, pageSize); - Console.WriteLine(result); + var response = new ApiAppApi(config).ApiAppList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ApiAppApi#ApiAppList: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -427,29 +430,28 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ApiAppUpdateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var apiAppApi = new ApiAppApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; var oauth = new SubOAuth( callbackUrl: "https://example.com/oauth", - scopes: new List() { + scopes: [ SubOAuth.ScopesEnum.BasicAccountInfo, - SubOAuth.ScopesEnum.RequestSignature - } + SubOAuth.ScopesEnum.RequestSignature, + ] ); var whiteLabelingOptions = new SubWhiteLabelingOptions( @@ -457,29 +459,32 @@ public class Example primaryButtonTextColor: "#ffffff" ); - var customLogoFile = new FileStream( - "CustomLogoFile.png", - FileMode.Open - ); - - var data = new ApiAppUpdateRequest( - name: "My Production App", - domains: new List(){"example.com"}, + 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, - customLogoFile: customLogoFile + whiteLabelingOptions: whiteLabelingOptions ); - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - try { - var result = apiAppApi.ApiAppUpdate(clientId, data); - Console.WriteLine(result); + var response = new ApiAppApi(config).ApiAppUpdate( + clientId: "0dd3b823a682527788c4e40cb7b6f7e9", + apiAppUpdateRequest: apiAppUpdateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ApiAppApi#ApiAppUpdate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/BulkSendJobApi.md b/sdks/dotnet/docs/BulkSendJobApi.md index 050257d63..46b262680 100644 --- a/sdks/dotnet/docs/BulkSendJobApi.md +++ b/sdks/dotnet/docs/BulkSendJobApi.md @@ -20,33 +20,35 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class BulkSendJobGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var bulkSendJobApi = new BulkSendJobApi(config); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = bulkSendJobApi.BulkSendJobGet(bulkSendJobId); - Console.WriteLine(result); + var response = new BulkSendJobApi(config).BulkSendJobGet( + bulkSendJobId: "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -118,34 +120,34 @@ Returns a list of BulkSendJob that you can access. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class BulkSendJobListExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var bulkSendJobApi = new BulkSendJobApi(config); - - var page = 1; - var pageSize = 20; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = bulkSendJobApi.BulkSendJobList(page, pageSize); - Console.WriteLine(result); + var response = new BulkSendJobApi(config).BulkSendJobList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling BulkSendJobApi#BulkSendJobList: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/EmbeddedApi.md b/sdks/dotnet/docs/EmbeddedApi.md index 39c38b4c2..473f3dfaf 100644 --- a/sdks/dotnet/docs/EmbeddedApi.md +++ b/sdks/dotnet/docs/EmbeddedApi.md @@ -20,38 +20,43 @@ Retrieves an embedded object containing a template url that can be opened in an using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class EmbeddedEditUrlExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var embeddedApi = new EmbeddedApi(config); + var mergeFields = new List(); - var data = new EmbeddedEditUrlRequest( - ccRoles: new List(){""}, - mergeFields: new List() + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest( + ccRoles: [ + "", + ], + mergeFields: mergeFields ); - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - try { - var result = embeddedApi.EmbeddedEditUrl(templateId, data); - Console.WriteLine(result); + var response = new EmbeddedApi(config).EmbeddedEditUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + embeddedEditUrlRequest: embeddedEditUrlRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedEditUrl: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -122,33 +127,33 @@ Retrieves an embedded object containing a signature url that can be opened in an using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class EmbeddedSignUrlExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var embeddedApi = new EmbeddedApi(config); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = embeddedApi.EmbeddedSignUrl(signatureId); - Console.WriteLine(result); + var response = new EmbeddedApi(config).EmbeddedSignUrl( + signatureId: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling EmbeddedApi#EmbeddedSignUrl: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/FaxApi.md b/sdks/dotnet/docs/FaxApi.md index 4368c0732..41349a481 100644 --- a/sdks/dotnet/docs/FaxApi.md +++ b/sdks/dotnet/docs/FaxApi.md @@ -23,26 +23,30 @@ Deletes the specified Fax from the system using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxApi = new FaxApi(config); - try { - faxApi.FaxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + new FaxApi(config).FaxDelete( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -109,32 +113,34 @@ Downloads files associated with a Fax using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxFilesExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxApi = new FaxApi(config); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - try { - var result = faxApi.FaxFiles(faxId); - var fileStream = File.Create("file_response.pdf"); - result.Seek(0, SeekOrigin.Begin); - result.CopyTo(fileStream); + 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 Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxFiles: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -202,31 +208,34 @@ Returns information about a Fax ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - var faxApi = new FaxApi(config); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - try { - var result = faxApi.FaxGet(faxId); - Console.WriteLine(result); + var response = new FaxApi(config).FaxGet( + faxId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -294,32 +303,35 @@ Returns properties of multiple Faxes ### Example ```csharp using System; +using System.Collections.Generic; +using System.IO; +using System.Text.Json; using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxListExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - var faxApi = new FaxApi(config); - - var page = 1; - var pageSize = 2; - try { - var result = faxApi.FaxList(page, pageSize); - Console.WriteLine(result); + var response = new FaxApi(config).FaxList( + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxList: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -390,47 +402,49 @@ Creates and sends a new Fax with the submitted file(s) using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxSendExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxApi = new FaxApi(config); - - var files = new List { - new FileStream( - "./example_fax.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new FaxSendRequest( - files: files, - testMode: true, + var faxSendRequest = new FaxSendRequest( recipient: "16690000001", sender: "16690000000", + testMode: true, coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", coverPageFrom: "Faxer Faxerson", + coverPageMessage: "I'm sending you a fax!", title: "This is what the fax is about!", + files: new List + { + new FileStream( + path: "./example_fax.pdf", + mode: FileMode.Open + ), + } ); try { - var result = faxApi.FaxSend(data); - Console.WriteLine(result); + var response = new FaxApi(config).FaxSend( + faxSendRequest: faxSendRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxApi#FaxSend: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/FaxLineApi.md b/sdks/dotnet/docs/FaxLineApi.md index d914fb09b..0b7ea70a4 100644 --- a/sdks/dotnet/docs/FaxLineApi.md +++ b/sdks/dotnet/docs/FaxLineApi.md @@ -25,32 +25,37 @@ Grants a user access to the specified Fax Line. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineAddUserExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineAddUserRequest( + var faxLineAddUserRequest = new FaxLineAddUserRequest( number: "[FAX_NUMBER]", emailAddress: "member@dropboxsign.com" ); try { - var result = faxLineApi.FaxLineAddUser(data); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineAddUser( + faxLineAddUserRequest: faxLineAddUserRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAddUser: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -120,27 +125,35 @@ Returns a list of available area codes for a given state/province and city using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineAreaCodeGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - try { - var result = faxLineApi.FaxLineAreaCodeGet("US", "CA"); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineAreaCodeGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -213,32 +226,37 @@ Purchases a new Fax Line using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineCreateRequest( + var faxLineCreateRequest = new FaxLineCreateRequest( areaCode: 209, - country: "US" + country: FaxLineCreateRequest.CountryEnum.US ); try { - var result = faxLineApi.FaxLineCreate(data); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineCreate( + faxLineCreateRequest: faxLineCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -308,30 +326,34 @@ Deletes the specified Fax Line from the subscription. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineDeleteRequest( + var faxLineDeleteRequest = new FaxLineDeleteRequest( number: "[FAX_NUMBER]" ); try { - faxLineApi.FaxLineDelete(data); + new FaxLineApi(config).FaxLineDelete( + faxLineDeleteRequest: faxLineDeleteRequest + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -398,27 +420,32 @@ Returns the properties and settings of a Fax Line. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - try { - var result = faxLineApi.FaxLineGet("[FAX_NUMBER]"); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineGet( + number: "123-123-1234" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -488,27 +515,35 @@ Returns the properties and settings of multiple Fax Lines. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineListExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - try { - var result = faxLineApi.FaxLineList(); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineList( + accountId: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + pageSize: 20, + showTeamLines: null + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineList: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -581,32 +616,37 @@ Removes a user's access to the specified Fax Line using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class FaxLineRemoveUserExample { - public static void Main() + public static void Run() { var config = new Configuration(); config.Username = "YOUR_API_KEY"; - var faxLineApi = new FaxLineApi(config); - - var data = new FaxLineRemoveUserRequest( + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest( number: "[FAX_NUMBER]", emailAddress: "member@dropboxsign.com" ); try { - var result = faxLineApi.FaxLineRemoveUser(data); - Console.WriteLine(result); + var response = new FaxLineApi(config).FaxLineRemoveUser( + faxLineRemoveUserRequest: faxLineRemoveUserRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling FaxLineApi#FaxLineRemoveUser: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/OAuthApi.md b/sdks/dotnet/docs/OAuthApi.md index c80ee2758..2918ea95f 100644 --- a/sdks/dotnet/docs/OAuthApi.md +++ b/sdks/dotnet/docs/OAuthApi.md @@ -20,33 +20,39 @@ Once you have retrieved the code from the user callback, you will need to exchan using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class OauthTokenGenerateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - var oAuthApi = new OAuthApi(config); - - var data = new OAuthTokenGenerateRequest( - state: "900e06e2", - code: "1b0d28d90c86c141", + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest( clientId: "cc91c61d00f8bb2ece1428035716b", - clientSecret: "1d14434088507ffa390e6f5528465" + clientSecret: "1d14434088507ffa390e6f5528465", + code: "1b0d28d90c86c141", + state: "900e06e2", + grantType: "authorization_code" ); try { - var result = oAuthApi.OauthTokenGenerate(data); - Console.WriteLine(result); + var response = new OAuthApi(config).OauthTokenGenerate( + oAuthTokenGenerateRequest: oAuthTokenGenerateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling OAuthApi#OauthTokenGenerate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -116,30 +122,36 @@ Access tokens are only valid for a given period of time (typically one hour) for using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class OauthTokenRefreshExample { - public static void Main() + public static void Run() { var config = new Configuration(); - var oAuthApi = new OAuthApi(config); - - var data = new OAuthTokenRefreshRequest( + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest( + grantType: "refresh_token", refreshToken: "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" ); try { - var result = oAuthApi.OauthTokenRefresh(data); - Console.WriteLine(result); + var response = new OAuthApi(config).OauthTokenRefresh( + oAuthTokenRefreshRequest: oAuthTokenRefreshRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling OAuthApi#OauthTokenRefresh: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/ReportApi.md b/sdks/dotnet/docs/ReportApi.md index 9ea98796f..324902c65 100644 --- a/sdks/dotnet/docs/ReportApi.md +++ b/sdks/dotnet/docs/ReportApi.md @@ -19,40 +19,41 @@ Request the creation of one or more report(s). When the report(s) have been gen using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class ReportCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var reportApi = new ReportApi(config); - - var data = new ReportCreateRequest( + var reportCreateRequest = new ReportCreateRequest( startDate: "09/01/2020", endDate: "09/01/2020", - reportType: new List() { + reportType: [ ReportCreateRequest.ReportTypeEnum.UserActivity, ReportCreateRequest.ReportTypeEnum.DocumentStatus, - } + ] ); try { - var result = reportApi.OauthCreate(data); - Console.WriteLine(result); + var response = new ReportApi(config).ReportCreate( + reportCreateRequest: reportCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling ReportApi#ReportCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/SignatureRequestApi.md b/sdks/dotnet/docs/SignatureRequestApi.md index 4e5f19d8e..9e7f7669d 100644 --- a/sdks/dotnet/docs/SignatureRequestApi.md +++ b/sdks/dotnet/docs/SignatureRequestApi.md @@ -38,80 +38,114 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); - var signatureRequestApi = new SignatureRequestApi(config); + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; - var signerList1Signer = new SubSignatureRequestTemplateSigner( + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td" + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" ); - var signerList1CustomFields = new SubBulkSignerListCustomField( + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( name: "company", value: "ABC Corp" ); - var signerList1 = new SubBulkSignerList( - signers: new List(){signerList1Signer}, - customFields: new List(){signerList1CustomFields} - ); + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; - var signerList2Signer = new SubSignatureRequestTemplateSigner( + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b" + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" ); - var signerList2CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "123 Corp" + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers ); var signerList2 = new SubBulkSignerList( - signers: new List(){signerList2Signer}, - customFields: new List(){signerList2CustomFields} + customFields: signerList2CustomFields, + signers: signerList2Signers ); - var cc1 = new SubCC( + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( role: "Accounting", - emailAddress: "accouting@email.com" + emailAddress: "accounting@example.com" ); - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest( clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], message: "Glad we could come to an agreement.", - signerList: new List(){signerList1, signerList2}, - ccs: new List(){cc1}, - testMode: true + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs ); try { - var result = signatureRequestApi.SignatureRequestBulkCreateEmbeddedWithTemplate(data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest: signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkCreateEmbeddedWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -181,79 +215,114 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestBulkSendWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; + var signerList2CustomFields1 = new SubBulkSignerListCustomField( + name: "company", + value: "123 LLC" + ); - var signatureRequestApi = new SignatureRequestApi(config); + var signerList2CustomFields = new List + { + signerList2CustomFields1, + }; - var signerList1Signer = new SubSignatureRequestTemplateSigner( + var signerList2Signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td" + name: "Mary", + emailAddress: "mary@example.com", + pin: "gd9as5b" ); - var signerList1CustomFields = new SubBulkSignerListCustomField( + var signerList2Signers = new List + { + signerList2Signers1, + }; + + var signerList1CustomFields1 = new SubBulkSignerListCustomField( name: "company", value: "ABC Corp" ); - var signerList1 = new SubBulkSignerList( - signers: new List(){signerList1Signer}, - customFields: new List(){signerList1CustomFields} - ); + var signerList1CustomFields = new List + { + signerList1CustomFields1, + }; - var signerList2Signer = new SubSignatureRequestTemplateSigner( + var signerList1Signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b" + name: "George", + emailAddress: "george@example.com", + pin: "d79a3td" ); - var signerList2CustomFields = new SubBulkSignerListCustomField( - name: "company", - value: "123 Corp" + var signerList1Signers = new List + { + signerList1Signers1, + }; + + var signerList1 = new SubBulkSignerList( + customFields: signerList1CustomFields, + signers: signerList1Signers ); var signerList2 = new SubBulkSignerList( - signers: new List(){signerList2Signer}, - customFields: new List(){signerList2CustomFields} + customFields: signerList2CustomFields, + signers: signerList2Signers ); - var cc1 = new SubCC( + var signerList = new List + { + signerList1, + signerList2, + }; + + var ccs1 = new SubCC( role: "Accounting", - emailAddress: "accouting@email.com" + emailAddress: "accounting@example.com" ); - var data = new SignatureRequestBulkSendWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", + var ccs = new List + { + ccs1, + }; + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest( + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], message: "Glad we could come to an agreement.", - signerList: new List(){signerList1, signerList2}, - ccs: new List(){cc1}, - testMode: true + subject: "Purchase Order", + testMode: true, + signerList: signerList, + ccs: ccs ); try { - var result = signatureRequestApi.SignatureRequestBulkSendWithTemplate(data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest: signatureRequestBulkSendWithTemplateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestBulkSendWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -323,32 +392,31 @@ Cancels an incomplete signature request. This action is **not reversible**. The using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestCancelExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - signatureRequestApi.SignatureRequestCancel(signatureRequestId); + new SignatureRequestApi(config).SignatureRequestCancel( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCancel: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -415,72 +483,80 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", + var signers1 = new SubSignatureRequestSigner( name: "Jack", + emailAddress: "jack@example.com", order: 0 ); - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", + var signers2 = new SubSignatureRequestSigner( name: "Jill", + emailAddress: "jill@example.com", order: 1 ); - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) + var signers = new List + { + signers1, + signers2, }; - var data = new SignatureRequestCreateEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", + 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", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, + 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, - testMode: true + signers: signers ); try { - var result = signatureRequestApi.SignatureRequestCreateEmbedded(data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest: signatureRequestCreateEmbeddedRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbedded: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -549,54 +625,65 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestCreateEmbeddedWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestTemplateSigner( + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - name: "George" + name: "George", + emailAddress: "george@example.com" ); - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); + var signers = new List + { + signers1, + }; - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - signingOptions: subSigningOptions, - testMode: true + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers ); try { - var result = signatureRequestApi.SignatureRequestCreateEmbeddedWithTemplate(data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest: signatureRequestCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestCreateEmbeddedWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -666,85 +753,91 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", + var signers1 = new SubSignatureRequestSigner( name: "Jack", + emailAddress: "jack@example.com", order: 0 ); - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", + var signers2 = new SubSignatureRequestSigner( name: "Jill", + emailAddress: "jill@example.com", order: 1 ); - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var metadata = new Dictionary() + var signers = new List { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" + signers1, + signers2, }; - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new SignatureRequestEditRequest( - title: "NDA with Acme Co.", + 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", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, + 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, - fieldOptions: subFieldOptions, - testMode: true + signers: signers ); - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - var result = signatureRequestApi.SignatureRequestEdit(signatureRequestId, data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestEdit( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditRequest: signatureRequestEditRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEdit: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -815,77 +908,81 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", + var signers1 = new SubSignatureRequestSigner( name: "Jack", + emailAddress: "jack@example.com", order: 0 ); - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", + var signers2 = new SubSignatureRequestSigner( name: "Jill", + emailAddress: "jill@example.com", order: 1 ); - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) + var signers = new List + { + signers1, + signers2, }; - var data = new SignatureRequestEditEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", + 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", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, + 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, - testMode: true + signers: signers ); - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - var result = signatureRequestApi.SignatureRequestEditEmbedded( - signatureRequestId, - data + var response = new SignatureRequestApi(config).SignatureRequestEditEmbedded( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedRequest: signatureRequestEditEmbeddedRequest ); - Console.WriteLine(result); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbedded: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -955,59 +1052,66 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditEmbeddedWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestTemplateSigner( + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - name: "George" + name: "George", + emailAddress: "george@example.com" ); - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); + var signers = new List + { + signers1, + }; - var data = new SignatureRequestEditEmbeddedWithTemplateRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + templateIds: [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ], message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - signingOptions: subSigningOptions, - testMode: true + subject: "Purchase Order", + testMode: true, + signingOptions: signingOptions, + signers: signers ); - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - var result = signatureRequestApi.SignatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data + var response = new SignatureRequestApi(config).SignatureRequestEditEmbeddedWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditEmbeddedWithTemplateRequest: signatureRequestEditEmbeddedWithTemplateRequest ); - Console.WriteLine(result); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditEmbeddedWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1077,70 +1181,89 @@ Edits and sends a SignatureRequest based off of the Template(s) specified with t ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestEditWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestTemplateSigner( + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - emailAddress: "george@example.com", - name: "George" + name: "George", + emailAddress: "george@example.com" ); - var cc1 = new SubCC( + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( role: "Accounting", - emailAddress: "accouting@emaple.com" + emailAddress: "accounting@example.com" ); - var customField1 = new SubCustomField( + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( name: "Cost", - value: "$20,000", editor: "Client", - required: true + required: true, + value: "$20,000" ); - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); + var customFields = new List + { + customFields1, + }; - var data = new SignatureRequestEditWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - ccs: new List(){cc1}, - customFields: new List(){customField1}, + subject: "Purchase Order", + testMode: true, signingOptions: signingOptions, - testMode: true + signers: signers, + ccs: ccs, + customFields: customFields ); - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - var result = signatureRequestApi.SignatureRequestEditWithTemplate(signatureRequestId, data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestEditWithTemplate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestEditWithTemplateRequest: signatureRequestEditWithTemplateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestEditWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1210,37 +1333,37 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = signatureRequestApi.SignatureRequestFiles(signatureRequestId, "pdf"); - - var fileStream = File.Create("file_response.pdf"); - result.Seek(0, SeekOrigin.Begin); - result.CopyTo(fileStream); + 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 Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFiles: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1310,33 +1433,34 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsDataUriExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = signatureRequestApi.SignatureRequestFilesAsDataUri(signatureRequestId); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestFilesAsDataUri( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsDataUri: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1405,33 +1529,35 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestFilesAsFileUrlExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = signatureRequestApi.SignatureRequestFilesAsFileUrl(signatureRequestId); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestFilesAsFileUrl( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + forceDownload: 1 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestFilesAsFileUrl: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1501,33 +1627,34 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = signatureRequestApi.SignatureRequestGet(signatureRequestId); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestGet( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1596,33 +1723,37 @@ Returns a list of SignatureRequests that you can access. This includes Signature ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestListExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var accountId = "accountId"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = signatureRequestApi.SignatureRequestList(accountId); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestList: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1694,33 +1825,34 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestReleaseHoldExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = signatureRequestApi.SignatureRequestReleaseHold(signatureRequestId); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestReleaseHold( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestReleaseHold: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1789,37 +1921,39 @@ Sends an email to the signer reminding them to sign the signature request. You c ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemindExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var data = new SignatureRequestRemindRequest( + var signatureRequestRemindRequest = new SignatureRequestRemindRequest( emailAddress: "john@example.com" ); - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - var result = signatureRequestApi.SignatureRequestRemind(signatureRequestId, data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestRemind( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestRemindRequest: signatureRequestRemindRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemind: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1889,32 +2023,31 @@ Removes your access to a completed signature request. This action is **not rever ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestRemoveExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - signatureRequestApi.SignatureRequestRemove(signatureRequestId); + new SignatureRequestApi(config).SignatureRequestRemove( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestRemove: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1981,83 +2114,90 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestSigner( - emailAddress: "jack@example.com", + var signers1 = new SubSignatureRequestSigner( name: "Jack", + emailAddress: "jack@example.com", order: 0 ); - var signer2 = new SubSignatureRequestSigner( - emailAddress: "jill@example.com", + var signers2 = new SubSignatureRequestSigner( name: "Jill", + emailAddress: "jill@example.com", order: 1 ); - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: true, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var metadata = new Dictionary() + var signers = new List { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) + signers1, + signers2, }; - var data = new SignatureRequestSendRequest( - title: "NDA with Acme Co.", + 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", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, + 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, - fieldOptions: subFieldOptions, - testMode: true + signers: signers ); try { - var result = signatureRequestApi.SignatureRequestSend(data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestSend( + signatureRequestSendRequest: signatureRequestSendRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSend: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -2126,68 +2266,88 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestSendWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); + var signingOptions = new SubSigningOptions( + defaultType: SubSigningOptions.DefaultTypeEnum.Draw, + draw: true, + phone: false, + type: true, + upload: true + ); - var signer1 = new SubSignatureRequestTemplateSigner( + var signers1 = new SubSignatureRequestTemplateSigner( role: "Client", - emailAddress: "george@example.com", - name: "George" + name: "George", + emailAddress: "george@example.com" ); - var cc1 = new SubCC( + var signers = new List + { + signers1, + }; + + var ccs1 = new SubCC( role: "Accounting", - emailAddress: "accouting@emaple.com" + emailAddress: "accounting@example.com" ); - var customField1 = new SubCustomField( + var ccs = new List + { + ccs1, + }; + + var customFields1 = new SubCustomField( name: "Cost", - value: "$20,000", editor: "Client", - required: true + required: true, + value: "$20,000" ); - var signingOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); + var customFields = new List + { + customFields1, + }; - var data = new SignatureRequestSendWithTemplateRequest( - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, - subject: "Purchase Order", + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest( + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], message: "Glad we could come to an agreement.", - signers: new List(){signer1}, - ccs: new List(){cc1}, - customFields: new List(){customField1}, + subject: "Purchase Order", + testMode: true, signingOptions: signingOptions, - testMode: true + signers: signers, + ccs: ccs, + customFields: customFields ); try { - var result = signatureRequestApi.SignatureRequestSendWithTemplate(data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest: signatureRequestSendWithTemplateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestSendWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -2256,38 +2416,40 @@ Updates the email address and/or the name for a given signer on a signature requ ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class SignatureRequestUpdateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var signatureRequestApi = new SignatureRequestApi(config); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestUpdateRequest( - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3" + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest( + signatureId: "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", + emailAddress: "john@example.com" ); try { - var result = signatureRequestApi.SignatureRequestUpdate(signatureRequestId, data); - Console.WriteLine(result); + var response = new SignatureRequestApi(config).SignatureRequestUpdate( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + signatureRequestUpdateRequest: signatureRequestUpdateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling SignatureRequestApi#SignatureRequestUpdate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/TeamApi.md b/sdks/dotnet/docs/TeamApi.md index 64d8dd554..2e5e8784f 100644 --- a/sdks/dotnet/docs/TeamApi.md +++ b/sdks/dotnet/docs/TeamApi.md @@ -27,35 +27,39 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamAddMemberExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamAddMemberRequest( + var teamAddMemberRequest = new TeamAddMemberRequest( emailAddress: "george@example.com" ); try { - var result = teamApi.TeamAddMember(data); - Console.WriteLine(result); + var response = new TeamApi(config).TeamAddMember( + teamAddMemberRequest: teamAddMemberRequest, + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamAddMember: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -125,35 +129,38 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamCreateRequest( + var teamCreateRequest = new TeamCreateRequest( name: "New Team Name" ); try { - var result = teamApi.TeamCreate(data); - Console.WriteLine(result); + var response = new TeamApi(config).TeamCreate( + teamCreateRequest: teamCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -222,30 +229,30 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - teamApi.TeamDelete(); + new TeamApi(config).TeamDelete(); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -307,31 +314,32 @@ Returns information about your Team as well as a list of its members. If you do ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = teamApi.TeamGet(); - Console.WriteLine(result); + var response = new TeamApi(config).TeamGet(); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -396,31 +404,34 @@ Provides information about a team. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamInfoExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = teamApi.TeamInfo(); - Console.WriteLine(result); + var response = new TeamApi(config).TeamInfo( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamInfo: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -489,32 +500,32 @@ Provides a list of team invites (and their roles). ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamInvitesExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var emailAddress = "user@dropboxsign.com"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = teamApi.TeamInvites(emailAddress); - Console.WriteLine(result); + var response = new TeamApi(config).TeamInvites(); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamInvites: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -583,32 +594,36 @@ Provides a paginated list of members (and their roles) that belong to a given te ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamMembersExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = teamApi.TeamMembers(teamId); - Console.WriteLine(result); + var response = new TeamApi(config).TeamMembers( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamMembers: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -679,36 +694,39 @@ Removes the provided user Account from your Team. If the Account had an outstand ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamRemoveMemberExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamRemoveMemberRequest( + var teamRemoveMemberRequest = new TeamRemoveMemberRequest( emailAddress: "teammate@dropboxsign.com", newOwnerEmailAddress: "new_teammate@dropboxsign.com" ); try { - var result = teamApi.TeamRemoveMember(data); - Console.WriteLine(result); + var response = new TeamApi(config).TeamRemoveMember( + teamRemoveMemberRequest: teamRemoveMemberRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamRemoveMember: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -777,32 +795,36 @@ Provides a paginated list of sub teams that belong to a given team. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamSubTeamsExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = teamApi.TeamSubTeams(teamId); - Console.WriteLine(result); + var response = new TeamApi(config).TeamSubTeams( + teamId: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + page: 1, + pageSize: 20 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamSubTeams: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -873,35 +895,38 @@ Updates the name of your Team. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TeamUpdateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var teamApi = new TeamApi(config); - - var data = new TeamUpdateRequest( + var teamUpdateRequest = new TeamUpdateRequest( name: "New Team Name" ); try { - var result = teamApi.TeamUpdate(data); - Console.WriteLine(result); + var response = new TeamApi(config).TeamUpdate( + teamUpdateRequest: teamUpdateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TeamApi#TeamUpdate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/TemplateApi.md b/sdks/dotnet/docs/TemplateApi.md index c51decd9d..69707eaac 100644 --- a/sdks/dotnet/docs/TemplateApi.md +++ b/sdks/dotnet/docs/TemplateApi.md @@ -28,37 +28,39 @@ Gives the specified Account access to the specified Template. The specified Acco ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateAddUserExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - var data = new TemplateAddUserRequest( + var templateAddUserRequest = new TemplateAddUserRequest( emailAddress: "george@dropboxsign.com" ); try { - var result = templateApi.TemplateAddUser(templateId, data); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateAddUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateAddUserRequest: templateAddUserRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateAddUser: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -129,77 +131,127 @@ Creates a template that can then be used. using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY + ); - var role1 = new SubTemplateRole( + var signerRoles1 = new SubTemplateRole( name: "Client", order: 0 ); - var role2 = new SubTemplateRole( + var signerRoles2 = new SubTemplateRole( name: "Witness", order: 1 ); - var mergeField1 = new SubMergeField( + 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 mergeField2 = new SubMergeField( + var mergeFields2 = new SubMergeField( name: "Is Registered?", type: SubMergeField.TypeEnum.Checkbox ); - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY - ); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) + var mergeFields = new List + { + mergeFields1, + mergeFields2, }; - var data = new TemplateCreateRequest( + var templateCreateRequest = new TemplateCreateRequest( clientId: "37dee8d8440c66d54cfa05d92c160882", - files: files, - title: "Test Template", - subject: "Please sign this document", message: "For your approval", - signerRoles: new List(){role1, role2}, - ccRoles: new List(){"Manager"}, - mergeFields: new List(){mergeField1, mergeField2}, - fieldOptions: subFieldOptions, - testMode: true + 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 result = templateApi.TemplateCreate(data); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateCreate( + templateCreateRequest: templateCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -269,77 +321,90 @@ The first step in an embedded template workflow. Creates a draft template that c using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateCreateEmbeddedDraftExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var role1 = new SubTemplateRole( - name: "Client", - order: 0 - ); - - var role2 = new SubTemplateRole( - name: "Witness", - order: 1 + var fieldOptions = new SubFieldOptions( + dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY ); - var mergeField1 = new SubMergeField( + var mergeFields1 = new SubMergeField( name: "Full Name", type: SubMergeField.TypeEnum.Text ); - var mergeField2 = new SubMergeField( + var mergeFields2 = new SubMergeField( name: "Is Registered?", type: SubMergeField.TypeEnum.Checkbox ); - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DDMMYYYY + var mergeFields = new List + { + mergeFields1, + mergeFields2, + }; + + var signerRoles1 = new SubTemplateRole( + name: "Client", + order: 0 ); - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) + var signerRoles2 = new SubTemplateRole( + name: "Witness", + order: 1 + ); + + var signerRoles = new List + { + signerRoles1, + signerRoles2, }; - var data = new TemplateCreateEmbeddedDraftRequest( + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest( clientId: "37dee8d8440c66d54cfa05d92c160882", - files: files, - title: "Test Template", - subject: "Please sign this document", message: "For your approval", - signerRoles: new List(){role1, role2}, - ccRoles: new List(){"Manager"}, - mergeFields: new List(){mergeField1, mergeField2}, - fieldOptions: subFieldOptions, - testMode: true + 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 result = templateApi.TemplateCreateEmbeddedDraft(data); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest: templateCreateEmbeddedDraftRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateCreateEmbeddedDraft: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -408,32 +473,32 @@ Completely deletes the template specified from the account. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateDeleteExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - templateApi.TemplateDelete(templateId); + new TemplateApi(config).TemplateDelete( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateDelete: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -499,37 +564,37 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateFilesExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = templateApi.TemplateFiles(templateId, "pdf"); - - var fileStream = File.Create("file_response.pdf"); - result.Seek(0, SeekOrigin.Begin); - result.CopyTo(fileStream); + var response = new TemplateApi(config).TemplateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + fileType: null + ); + var fileStream = File.Create("./file_response"); + response.Seek(0, SeekOrigin.Begin); + response.CopyTo(fileStream); fileStream.Close(); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateFiles: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -599,33 +664,34 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsDataUriExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = templateApi.TemplateFilesAsDataUri(templateId, "pdf", false, false); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateFilesAsDataUri( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsDataUri: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -694,33 +760,35 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateFilesAsFileUrlExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = templateApi.TemplateFilesAsFileUrl(templateId, "pdf", false, false); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateFilesAsFileUrl( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + forceDownload: 1 + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateFilesAsFileUrl: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -790,33 +858,34 @@ Returns the Template specified by the `template_id` parameter. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateGetExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = templateApi.TemplateGet(templateId); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateGet( + templateId: "f57db65d3f933b5316d398057a36176831451a35" + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateGet: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -885,33 +954,37 @@ Returns a list of the Templates that are accessible by you. Take a look at our ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateListExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; try { - var result = templateApi.TemplateList(accountId, 1, 20, null); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateList( + accountId: null, + page: 1, + pageSize: 20, + query: null + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateList: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -983,37 +1056,39 @@ Removes the specified Account's access to the specified Template. ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateRemoveUserExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var data = new TemplateRemoveUserRequest( + var templateRemoveUserRequest = new TemplateRemoveUserRequest( emailAddress: "george@dropboxsign.com" ); - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - try { - var result = templateApi.TemplateRemoveUser(templateId, data); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateRemoveUser( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateRemoveUserRequest: templateRemoveUserRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateRemoveUser: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -1084,46 +1159,44 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class TemplateUpdateFilesExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; - - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var templateApi = new TemplateApi(config); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new TemplateUpdateFilesRequest( - files: files + // config.AccessToken = "YOUR_ACCESS_TOKEN"; + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest( + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } ); - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - try { - var result = templateApi.TemplateUpdateFiles(templateId, data); - Console.WriteLine(result); + var response = new TemplateApi(config).TemplateUpdateFiles( + templateId: "f57db65d3f933b5316d398057a36176831451a35", + templateUpdateFilesRequest: templateUpdateFilesRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling TemplateApi#TemplateUpdateFiles: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/docs/UnclaimedDraftApi.md b/sdks/dotnet/docs/UnclaimedDraftApi.md index 7d5a0e145..3bd6eda05 100644 --- a/sdks/dotnet/docs/UnclaimedDraftApi.md +++ b/sdks/dotnet/docs/UnclaimedDraftApi.md @@ -22,83 +22,57 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var signer1 = new SubUnclaimedDraftSigner( - emailAddress: "jack@example.com", + var signers1 = new SubUnclaimedDraftSigner( name: "Jack", + emailAddress: "jack@example.com", order: 0 ); - var signer2 = new SubUnclaimedDraftSigner( - emailAddress: "jill@example.com", - name: "Jill", - order: 1 - ); - - var subSigningOptions = new SubSigningOptions( - draw: true, - type: true, - upload: true, - phone: false, - defaultType: SubSigningOptions.DefaultTypeEnum.Draw - ); - - var subFieldOptions = new SubFieldOptions( - dateFormat: SubFieldOptions.DateFormatEnum.DD_MM_YYYY - ); - - var metadata = new Dictionary() + var signers = new List { - ["custom_id"] = 1234, - ["custom_text"] = "NDA #9" - }; - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) + signers1, }; - var data = new UnclaimedDraftCreateRequest( - subject: "The NDA we talked about", + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest( type: UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: new List(){signer1, signer2}, - ccEmailAddresses: new List(){"lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"}, - files: files, - metadata: metadata, - signingOptions: subSigningOptions, - fieldOptions: subFieldOptions, - testMode: true + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + }, + signers: signers ); try { - var result = unclaimedDraftApi.UnclaimedDraftCreate(data); - Console.WriteLine(result); + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreate( + unclaimedDraftCreateRequest: unclaimedDraftCreateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -168,47 +142,46 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs using System; using System.Collections.Generic; using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var files = new List { - new FileStream( - "./example_signature_request.pdf", - FileMode.Open, - FileAccess.Read, - FileShare.Read - ) - }; - - var data = new UnclaimedDraftCreateEmbeddedRequest( - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: files, + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", requesterEmailAddress: "jack@dropboxsign.com", - testMode: true + testMode: true, + files: new List + { + new FileStream( + path: "./example_signature_request.pdf", + mode: FileMode.Open + ), + } ); try { - var result = unclaimedDraftApi.UnclaimedDraftCreateEmbedded(data); - Console.WriteLine(result); + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest: unclaimedDraftCreateEmbeddedRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbedded: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -277,51 +250,66 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftCreateEmbeddedWithTemplateExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; + var ccs1 = new SubCC( + role: "Accounting", + emailAddress: "accounting@dropboxsign.com" + ); - var unclaimedDraftApi = new UnclaimedDraftApi(config); + var ccs = new List + { + ccs1, + }; - var signer = new SubUnclaimedDraftTemplateSigner( + var signers1 = new SubUnclaimedDraftTemplateSigner( role: "Client", name: "George", emailAddress: "george@example.com" ); - var cc1 = new SubCC( - role: "Accounting", - emailAddress: "accouting@email.com" - ); + var signers = new List + { + signers1, + }; - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: new List(){"c26b8a16784a872da37ea946b9ddec7c1e11dff6"}, + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", requesterEmailAddress: "jack@dropboxsign.com", - signers: new List(){signer}, - ccs: new List(){cc1}, - testMode: true + templateIds: [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ], + testMode: false, + ccs: ccs, + signers: signers ); try { - var result = unclaimedDraftApi.UnclaimedDraftCreateEmbeddedWithTemplate(data); - Console.WriteLine(result); + var response = new UnclaimedDraftApi(config).UnclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest: unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftCreateEmbeddedWithTemplate: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } @@ -390,38 +378,40 @@ Creates a new signature request from an embedded request that can be edited prio ```csharp using System; using System.Collections.Generic; +using System.IO; +using System.Text.Json; + using Dropbox.Sign.Api; using Dropbox.Sign.Client; using Dropbox.Sign.Model; -public class Example +namespace Dropbox.SignSandbox; + +public class UnclaimedDraftEditAndResendExample { - public static void Main() + public static void Run() { var config = new Configuration(); - // Configure HTTP basic authorization: api_key config.Username = "YOUR_API_KEY"; + // config.AccessToken = "YOUR_ACCESS_TOKEN"; - // or, configure Bearer (JWT) authorization: oauth2 - // config.AccessToken = "YOUR_BEARER_TOKEN"; - - var unclaimedDraftApi = new UnclaimedDraftApi(config); - - var data = new UnclaimedDraftEditAndResendRequest( - clientId: "1a659d9ad95bccd307ecad78d72192f8", - testMode: true + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest( + clientId: "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + testMode: false ); - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - try { - var result = unclaimedDraftApi.UnclaimedDraftEditAndResend(signatureRequestId, data); - Console.WriteLine(result); + var response = new UnclaimedDraftApi(config).UnclaimedDraftEditAndResend( + signatureRequestId: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + unclaimedDraftEditAndResendRequest: unclaimedDraftEditAndResendRequest + ); + + Console.WriteLine(response); } catch (ApiException e) { - Console.WriteLine("Exception when calling Dropbox Sign API: " + e.Message); + Console.WriteLine("Exception when calling UnclaimedDraftApi#UnclaimedDraftEditAndResend: " + e.Message); Console.WriteLine("Status Code: " + e.ErrorCode); Console.WriteLine(e.StackTrace); } diff --git a/sdks/dotnet/openapi-config.yaml b/sdks/dotnet/openapi-config.yaml index ce2c64827..a33ad8805 100644 --- a/sdks/dotnet/openapi-config.yaml +++ b/sdks/dotnet/openapi-config.yaml @@ -15,6 +15,10 @@ additionalProperties: legacyDiscriminatorBehavior: true useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.namespace: Dropbox.SignSandbox + oseg.packageGuid: "{7045D429-F203-4317-A29F-FB9FD34B7FF9}" + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-EventCallbackHelper.cs: templateType: SupportingFiles diff --git a/sdks/dotnet/templates/Entry.cs b/sdks/dotnet/templates/Entry.cs new file mode 100644 index 000000000..b642a7ff1 --- /dev/null +++ b/sdks/dotnet/templates/Entry.cs @@ -0,0 +1,8 @@ +namespace Dropbox.SignSandbox; + +public class Entry +{ + public static void Main() + { + } +} diff --git a/sdks/java-v1/README.md b/sdks/java-v1/README.md index 5a19d8db9..69fa45d1d 100644 --- a/sdks/java-v1/README.md +++ b/sdks/java-v1/README.md @@ -94,31 +94,40 @@ Please follow the [installation](#installation) instruction and execute the foll ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling AccountApi#accountCreate"); System.err.println("Status code: " + e.getCode()); diff --git a/sdks/java-v1/docs/AccountApi.md b/sdks/java-v1/docs/AccountApi.md index 494853dda..cd7c9244f 100644 --- a/sdks/java-v1/docs/AccountApi.md +++ b/sdks/java-v1/docs/AccountApi.md @@ -22,31 +22,40 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling AccountApi#accountCreate"); System.err.println("Status code: " + e.getCode()); @@ -97,30 +106,37 @@ Returns the properties and settings of your Account. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - try { - AccountGetResponse result = accountApi.accountGet(null, "jack@example.com"); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -170,33 +186,43 @@ Updates the properties and settings of your Account. Currently only allows for u ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountUpdateRequest() - .callbackUrl("https://www.example.com/callback"); - - try { - AccountGetResponse result = accountApi.accountUpdate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -245,33 +271,42 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountVerifyRequest() - .emailAddress("some_user@dropboxsign.com"); - - try { - AccountVerifyResponse result = accountApi.accountVerify(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountVerifyExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/ApiAppApi.md b/sdks/java-v1/docs/ApiAppApi.md index 02630c9d7..672878e86 100644 --- a/sdks/java-v1/docs/ApiAppApi.md +++ b/sdks/java-v1/docs/ApiAppApi.md @@ -23,50 +23,59 @@ Creates a new API App. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of((SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppCreateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - try { - ApiAppGetResponse result = apiAppApi.apiAppCreate(data); - System.out.println(result); +import java.util.Map; + +public class ApiAppCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -115,30 +124,37 @@ Deletes an API App. Can only be invoked for apps you own. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - apiAppApi.apiAppDelete(clientId); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -187,32 +203,39 @@ Returns an object with information about an API App. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppGet(clientId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -261,33 +284,40 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - ApiAppListResponse result = apiAppApi.apiAppList(page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -337,52 +367,61 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of(SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppUpdateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppUpdate(clientId, data); - System.out.println(result); +import java.util.Map; + +public class ApiAppUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/BulkSendJobApi.md b/sdks/java-v1/docs/BulkSendJobApi.md index 5d7335a12..742d55134 100644 --- a/sdks/java-v1/docs/BulkSendJobApi.md +++ b/sdks/java-v1/docs/BulkSendJobApi.md @@ -20,32 +20,41 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try { - BulkSendJobGetResponse result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -96,33 +105,40 @@ Returns a list of BulkSendJob that you can access. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var page = 1; - var pageSize = 20; - - try { - BulkSendJobListResponse result = bulkSendJobApi.bulkSendJobList(page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/EmbeddedApi.md b/sdks/java-v1/docs/EmbeddedApi.md index 62955f908..04700004d 100644 --- a/sdks/java-v1/docs/EmbeddedApi.md +++ b/sdks/java-v1/docs/EmbeddedApi.md @@ -20,38 +20,48 @@ Retrieves an embedded object containing a template url that can be opened in an ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var data = new EmbeddedEditUrlRequest() - .ccRoles(List.of("")) - .mergeFields(List.of()); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try { - EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data); - System.out.println(result); +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -101,32 +111,39 @@ Retrieves an embedded object containing a signature url that can be opened in an ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try { - EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedSignUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/FaxApi.md b/sdks/java-v1/docs/FaxApi.md index 5166ea29c..b092573e7 100644 --- a/sdks/java-v1/docs/FaxApi.md +++ b/sdks/java-v1/docs/FaxApi.md @@ -23,24 +23,36 @@ Deletes the specified Fax from the system ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - try { - faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -89,27 +101,37 @@ Downloads files associated with a Fax ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = faxApi.faxFiles(faxId); - result.renameTo(new File("file_response.pdf"));; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -158,26 +180,38 @@ Returns information about a Fax ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FaxGetResponse result = faxApi.faxGet(faxId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -226,27 +260,39 @@ Returns properties of multiple Faxes ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - FaxListResponse result = faxApi.faxList(page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -296,36 +342,50 @@ Creates and sends a new Fax with the submitted file(s) ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - - var data = new FaxSendRequest() - .addFilesItem(new File("example_fax.pdf")) - .testMode(true) - .recipient("16690000001") - .sender("16690000000") - .coverPageTo("Jill Fax") - .coverPageMessage("I'm sending you a fax!") - .coverPageFrom("Faxer Faxerson") - .title("This is what the fax is about!"); - - try { - FaxCreateResponse result = faxApi.faxSend(data); - System.out.println(result); +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/sdks/java-v1/docs/FaxLineApi.md b/sdks/java-v1/docs/FaxLineApi.md index 418bfc558..d1aafb013 100644 --- a/sdks/java-v1/docs/FaxLineApi.md +++ b/sdks/java-v1/docs/FaxLineApi.md @@ -25,29 +25,42 @@ Grants a user access to the specified Fax Line. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineAddUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineAddUser(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -96,25 +109,41 @@ Returns a list of available area codes for a given state/province and city ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineAreaCodeGetResponse result = faxLineApi.faxLineAreaCodeGet("US", "CA"); - System.out.println(result); +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -166,29 +195,42 @@ Purchases a new Fax Line ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineCreateRequest() - .areaCode(209) - .country("US"); - - try { - FaxLineResponse result = faxLineApi.faxLineCreate(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -237,27 +279,39 @@ Deletes the specified Fax Line from the subscription. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineDeleteRequest() - .number("[FAX_NUMBER]"); - - try { - faxLineApi.faxLineDelete(data); +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -306,25 +360,38 @@ Returns the properties and settings of a Fax Line. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineResponse result = faxLineApi.faxLineGet("[FAX_NUMBER]"); - System.out.println(result); +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -373,25 +440,41 @@ Returns the properties and settings of multiple Fax Lines. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineListResponse result = faxLineApi.faxLineList(); - System.out.println(result); +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -443,29 +526,42 @@ Removes a user's access to the specified Fax Line ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineRemoveUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineRemoveUser(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/sdks/java-v1/docs/OAuthApi.md b/sdks/java-v1/docs/OAuthApi.md index a2eaa2508..ed9b039c2 100644 --- a/sdks/java-v1/docs/OAuthApi.md +++ b/sdks/java-v1/docs/OAuthApi.md @@ -20,29 +20,44 @@ Once you have retrieved the code from the user callback, you will need to exchan ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenGenerateRequest() - .state("900e06e2") - .code("1b0d28d90c86c141") - .clientId("cc91c61d00f8bb2ece1428035716b") - .clientSecret("1d14434088507ffa390e6f5528465"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenGenerate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -91,26 +106,41 @@ Access tokens are only valid for a given period of time (typically one hour) for ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenRefreshRequest() - .refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenRefresh(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/ReportApi.md b/sdks/java-v1/docs/ReportApi.md index e0a409741..1ef6af025 100644 --- a/sdks/java-v1/docs/ReportApi.md +++ b/sdks/java-v1/docs/ReportApi.md @@ -21,40 +21,46 @@ When the report(s) have been generated, you will receive an email (one per reque ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var reportApi = new ReportApi(apiClient); - - var data = new ReportCreateRequest() - .startDate("09/01/2020") - .endDate("09/01/2020") - .reportType(List.of( - ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, - ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS - )); - - try { - ReportCreateResponse result = reportApi.reportCreate(data); - System.out.println(result); +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/SignatureRequestApi.md b/sdks/java-v1/docs/SignatureRequestApi.md index 4a9a22b75..9c22f6611 100644 --- a/sdks/java-v1/docs/SignatureRequestApi.md +++ b/sdks/java-v1/docs/SignatureRequestApi.md @@ -40,72 +40,106 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC().role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -156,72 +190,106 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); - System.out.println(result); +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -278,30 +346,37 @@ To be eligible for cancelation, a signature request must have been sent successf ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - try { - signatureRequestApi.signatureRequestCancel(signatureRequestId); +public class SignatureRequestCancelExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -350,61 +425,77 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbedded(data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -453,52 +544,66 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -549,68 +654,87 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); - System.out.println(result); +public class SignatureRequestEditExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -660,64 +784,76 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data +public class SignatureRequestEditEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); System.err.println("Status code: " + e.getCode()); @@ -769,57 +905,67 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); + 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()); @@ -871,69 +1017,86 @@ Edits and sends a SignatureRequest based off of the Template(s) specified with t ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data +public class SignatureRequestEditWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -985,33 +1148,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf"); - result.renameTo(new File("file_response.pdf")); +public class SignatureRequestFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1063,32 +1232,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - FileResponseDataUri result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1139,32 +1315,40 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); - try { - FileResponse result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1214,32 +1398,39 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestGet(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1290,40 +1481,42 @@ Take a look at our [search guide](/api/reference/search/) to learn more about qu ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var accountId = "accountId"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - SignatureRequestListResponse result = signatureRequestApi.signatureRequestList( - accountId, - page, - pageSize, - query +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1375,32 +1568,39 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +public class SignatureRequestReleaseHoldExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1451,35 +1651,43 @@ Sends an email to the signer reminding them to sign the signature request. You c ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var data = new SignatureRequestRemindRequest() - .emailAddress("john@example.com"); +public class SignatureRequestRemindExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1533,30 +1741,36 @@ Unlike /signature_request/cancel, this endpoint is synchronous and your access w ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - try { - signatureRequestApi.signatureRequestRemove(signatureRequestId); +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1605,66 +1819,86 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new SignatureRequestSendRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSend(data); - System.out.println(result); +public class SignatureRequestSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1713,64 +1947,85 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data); - System.out.println(result); +public class SignatureRequestSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1823,36 +2078,44 @@ Updating the email address of a signer will generate a new `signature_id` value. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var data = new SignatureRequestUpdateRequest() - .emailAddress("john@example.com") - .signatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); +public class SignatureRequestUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/TeamApi.md b/sdks/java-v1/docs/TeamApi.md index b35b40ea8..3e57e0451 100644 --- a/sdks/java-v1/docs/TeamApi.md +++ b/sdks/java-v1/docs/TeamApi.md @@ -28,35 +28,43 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamAddMemberRequest() - .emailAddress("george@example.com"); - - String teamId = null; - - try { - TeamGetResponse result = teamApi.teamAddMember(data, teamId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -106,33 +114,42 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamCreateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamCreate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -181,28 +198,35 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - teamApi.teamDelete(); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TeamApi(config).teamDelete(); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -248,30 +272,37 @@ Returns information about your Team as well as a list of its members. If you do ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetResponse result = teamApi.teamGet(); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -317,28 +348,37 @@ Provides information about a team. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetInfoResponse result = teamApi.teamInfo(); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInfoExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamInfo"); System.err.println("Status code: " + e.getCode()); @@ -389,32 +429,37 @@ Provides a list of team invites (and their roles). ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var emailAddress = "user@dropboxsign.com"; - - try { - TeamInvitesResponse result = teamApi.teamInvites(emailAddress); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInvitesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); + 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()); @@ -463,32 +508,39 @@ Provides a paginated list of members (and their roles) that belong to a given te ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamMembersResponse result = teamApi.teamMembers(teamId, page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamMembersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamMembers"); System.err.println("Status code: " + e.getCode()); @@ -541,34 +593,43 @@ Removes the provided user Account from your Team. If the Account had an outstand ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamRemoveMemberRequest() - .emailAddress("teammate@dropboxsign.com") - .newOwnerEmailAddress("new_teammate@dropboxsign.com"); - - try { - TeamGetResponse result = teamApi.teamRemoveMember(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -617,32 +678,39 @@ Provides a paginated list of sub teams that belong to a given team. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamSubTeamsResponse result = teamApi.teamSubTeams(teamId, page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamSubTeamsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamSubTeams"); System.err.println("Status code: " + e.getCode()); @@ -695,33 +763,42 @@ Updates the name of your Team. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamUpdateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamUpdate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/TemplateApi.md b/sdks/java-v1/docs/TemplateApi.md index e6c7d1745..f9de1a96a 100644 --- a/sdks/java-v1/docs/TemplateApi.md +++ b/sdks/java-v1/docs/TemplateApi.md @@ -29,35 +29,43 @@ Gives the specified Account access to the specified Template. The specified Acco ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateAddUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateAddUser(templateId, data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -107,64 +115,118 @@ Creates a template that can then be used. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateResponse result = templateApi.templateCreate(data); - System.out.println(result); +import java.util.Map; + +public class TemplateCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -213,64 +275,84 @@ The first step in an embedded template workflow. Creates a draft template that c ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateEmbeddedDraftRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateEmbeddedDraftResponse result = templateApi.templateCreateEmbeddedDraft(data); - System.out.println(result); +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -319,30 +401,37 @@ Completely deletes the template specified from the account. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - templateApi.templateDelete(templateId); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -393,33 +482,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - File result = templateApi.templateFiles(templateId, "pdf"); - result.renameTo(new File("file_response.pdf")); +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -471,32 +566,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponseDataUri result = templateApi.templateFilesAsDataUri(templateId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -547,32 +649,40 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponse result = templateApi.templateFilesAsFileUrl(templateId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -622,32 +732,39 @@ Returns the Template specified by the `template_id` parameter. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateGet(templateId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -698,35 +815,42 @@ Take a look at our [search guide](/api/reference/search/) to learn more about qu ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - TemplateListResponse result = templateApi.templateList(accountId, page, pageSize, query); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -778,35 +902,43 @@ Removes the specified Account's access to the specified Template. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateRemoveUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateGetResponse result = templateApi.templateRemoveUser(templateId, data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -867,37 +999,45 @@ If the page orientation or page count is different from the original template do ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateUpdateFilesRequest() - .addFilesItem(new File("example_signature_request.pdf")); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateUpdateFilesResponse result = templateApi.templateUpdateFiles(templateId, data); - System.out.println(result); +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateUpdateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v1/docs/UnclaimedDraftApi.md b/sdks/java-v1/docs/UnclaimedDraftApi.md index 4d6d12451..59ad0d2fd 100644 --- a/sdks/java-v1/docs/UnclaimedDraftApi.md +++ b/sdks/java-v1/docs/UnclaimedDraftApi.md @@ -22,66 +22,56 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer1 = new SubUnclaimedDraftSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubUnclaimedDraftSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); - - var data = new UnclaimedDraftCreateRequest() - .subject("The NDA we talked about") - .type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE) - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(subSigningOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreate(data); - System.out.println(result); +public class UnclaimedDraftCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -132,38 +122,47 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .addFilesItem(new File("example_signature_request.pdf")) - .requesterEmailAddress("jack@dropboxsign.com") - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); - System.out.println(result); +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -214,49 +213,66 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer = new SubUnclaimedDraftTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .requesterEmailAddress("jack@dropboxsign.com") - .signers(List.of(signer)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -307,36 +323,44 @@ Creates a new signature request from an embedded request that can be edited prio ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftEditAndResendRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .testMode(true); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); - System.out.println(result); +public class UnclaimedDraftEditAndResendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/README.md b/sdks/java-v2/README.md index af3ac5223..255e0809c 100644 --- a/sdks/java-v2/README.md +++ b/sdks/java-v2/README.md @@ -95,31 +95,40 @@ Please follow the [installation](#installation) instruction and execute the foll ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling AccountApi#accountCreate"); System.err.println("Status code: " + e.getCode()); diff --git a/sdks/java-v2/docs/AccountApi.md b/sdks/java-v2/docs/AccountApi.md index 494853dda..cd7c9244f 100644 --- a/sdks/java-v2/docs/AccountApi.md +++ b/sdks/java-v2/docs/AccountApi.md @@ -22,31 +22,40 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling AccountApi#accountCreate"); System.err.println("Status code: " + e.getCode()); @@ -97,30 +106,37 @@ Returns the properties and settings of your Account. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - try { - AccountGetResponse result = accountApi.accountGet(null, "jack@example.com"); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new AccountApi(config).accountGet(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -170,33 +186,43 @@ Updates the properties and settings of your Account. Currently only allows for u ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountUpdateRequest() - .callbackUrl("https://www.example.com/callback"); - - try { - AccountGetResponse result = accountApi.accountUpdate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -245,33 +271,42 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountVerifyRequest() - .emailAddress("some_user@dropboxsign.com"); - - try { - AccountVerifyResponse result = accountApi.accountVerify(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class AccountVerifyExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/ApiAppApi.md b/sdks/java-v2/docs/ApiAppApi.md index 02630c9d7..672878e86 100644 --- a/sdks/java-v2/docs/ApiAppApi.md +++ b/sdks/java-v2/docs/ApiAppApi.md @@ -23,50 +23,59 @@ Creates a new API App. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of((SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppCreateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - try { - ApiAppGetResponse result = apiAppApi.apiAppCreate(data); - System.out.println(result); +import java.util.Map; + +public class ApiAppCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -115,30 +124,37 @@ Deletes an API App. Can only be invoked for apps you own. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - apiAppApi.apiAppDelete(clientId); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -187,32 +203,39 @@ Returns an object with information about an API App. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppGet(clientId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -261,33 +284,40 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - ApiAppListResponse result = apiAppApi.apiAppList(page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class ApiAppListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -337,52 +367,61 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of(SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppUpdateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppUpdate(clientId, data); - System.out.println(result); +import java.util.Map; + +public class ApiAppUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/BulkSendJobApi.md b/sdks/java-v2/docs/BulkSendJobApi.md index 5d7335a12..742d55134 100644 --- a/sdks/java-v2/docs/BulkSendJobApi.md +++ b/sdks/java-v2/docs/BulkSendJobApi.md @@ -20,32 +20,41 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try { - BulkSendJobGetResponse result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -96,33 +105,40 @@ Returns a list of BulkSendJob that you can access. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var page = 1; - var pageSize = 20; - - try { - BulkSendJobListResponse result = bulkSendJobApi.bulkSendJobList(page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class BulkSendJobListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/EmbeddedApi.md b/sdks/java-v2/docs/EmbeddedApi.md index 62955f908..04700004d 100644 --- a/sdks/java-v2/docs/EmbeddedApi.md +++ b/sdks/java-v2/docs/EmbeddedApi.md @@ -20,38 +20,48 @@ Retrieves an embedded object containing a template url that can be opened in an ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var data = new EmbeddedEditUrlRequest() - .ccRoles(List.of("")) - .mergeFields(List.of()); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try { - EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data); - System.out.println(result); +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -101,32 +111,39 @@ Retrieves an embedded object containing a signature url that can be opened in an ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try { - EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class EmbeddedSignUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/FaxApi.md b/sdks/java-v2/docs/FaxApi.md index 5166ea29c..b092573e7 100644 --- a/sdks/java-v2/docs/FaxApi.md +++ b/sdks/java-v2/docs/FaxApi.md @@ -23,24 +23,36 @@ Deletes the specified Fax from the system ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - try { - faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -89,27 +101,37 @@ Downloads files associated with a Fax ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = faxApi.faxFiles(faxId); - result.renameTo(new File("file_response.pdf"));; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -158,26 +180,38 @@ Returns information about a Fax ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FaxGetResponse result = faxApi.faxGet(faxId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -226,27 +260,39 @@ Returns properties of multiple Faxes ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - FaxListResponse result = faxApi.faxList(page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -296,36 +342,50 @@ Creates and sends a new Fax with the submitted file(s) ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - - var data = new FaxSendRequest() - .addFilesItem(new File("example_fax.pdf")) - .testMode(true) - .recipient("16690000001") - .sender("16690000000") - .coverPageTo("Jill Fax") - .coverPageMessage("I'm sending you a fax!") - .coverPageFrom("Faxer Faxerson") - .title("This is what the fax is about!"); - - try { - FaxCreateResponse result = faxApi.faxSend(data); - System.out.println(result); +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/sdks/java-v2/docs/FaxLineApi.md b/sdks/java-v2/docs/FaxLineApi.md index 418bfc558..d1aafb013 100644 --- a/sdks/java-v2/docs/FaxLineApi.md +++ b/sdks/java-v2/docs/FaxLineApi.md @@ -25,29 +25,42 @@ Grants a user access to the specified Fax Line. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineAddUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineAddUser(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -96,25 +109,41 @@ Returns a list of available area codes for a given state/province and city ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineAreaCodeGetResponse result = faxLineApi.faxLineAreaCodeGet("US", "CA"); - System.out.println(result); +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -166,29 +195,42 @@ Purchases a new Fax Line ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineCreateRequest() - .areaCode(209) - .country("US"); - - try { - FaxLineResponse result = faxLineApi.faxLineCreate(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -237,27 +279,39 @@ Deletes the specified Fax Line from the subscription. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineDeleteRequest() - .number("[FAX_NUMBER]"); - - try { - faxLineApi.faxLineDelete(data); +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -306,25 +360,38 @@ Returns the properties and settings of a Fax Line. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineResponse result = faxLineApi.faxLineGet("[FAX_NUMBER]"); - System.out.println(result); +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -373,25 +440,41 @@ Returns the properties and settings of multiple Fax Lines. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineListResponse result = faxLineApi.faxLineList(); - System.out.println(result); +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -443,29 +526,42 @@ Removes a user's access to the specified Fax Line ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineRemoveUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineRemoveUser(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/sdks/java-v2/docs/OAuthApi.md b/sdks/java-v2/docs/OAuthApi.md index a2eaa2508..ed9b039c2 100644 --- a/sdks/java-v2/docs/OAuthApi.md +++ b/sdks/java-v2/docs/OAuthApi.md @@ -20,29 +20,44 @@ Once you have retrieved the code from the user callback, you will need to exchan ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenGenerateRequest() - .state("900e06e2") - .code("1b0d28d90c86c141") - .clientId("cc91c61d00f8bb2ece1428035716b") - .clientSecret("1d14434088507ffa390e6f5528465"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenGenerate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -91,26 +106,41 @@ Access tokens are only valid for a given period of time (typically one hour) for ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenRefreshRequest() - .refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenRefresh(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/ReportApi.md b/sdks/java-v2/docs/ReportApi.md index e0a409741..1ef6af025 100644 --- a/sdks/java-v2/docs/ReportApi.md +++ b/sdks/java-v2/docs/ReportApi.md @@ -21,40 +21,46 @@ When the report(s) have been generated, you will receive an email (one per reque ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var reportApi = new ReportApi(apiClient); - - var data = new ReportCreateRequest() - .startDate("09/01/2020") - .endDate("09/01/2020") - .reportType(List.of( - ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, - ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS - )); - - try { - ReportCreateResponse result = reportApi.reportCreate(data); - System.out.println(result); +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/SignatureRequestApi.md b/sdks/java-v2/docs/SignatureRequestApi.md index 4a9a22b75..9c22f6611 100644 --- a/sdks/java-v2/docs/SignatureRequestApi.md +++ b/sdks/java-v2/docs/SignatureRequestApi.md @@ -40,72 +40,106 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; + +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC().role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -156,72 +190,106 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); - System.out.println(result); +public class SignatureRequestBulkSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -278,30 +346,37 @@ To be eligible for cancelation, a signature request must have been sent successf ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - try { - signatureRequestApi.signatureRequestCancel(signatureRequestId); +public class SignatureRequestCancelExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -350,61 +425,77 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; + +public class SignatureRequestCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbedded(data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -453,52 +544,66 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -549,68 +654,87 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); - System.out.println(result); +public class SignatureRequestEditExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -660,64 +784,76 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data +public class SignatureRequestEditEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); System.err.println("Status code: " + e.getCode()); @@ -769,57 +905,67 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data +public class SignatureRequestEditEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); + 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()); @@ -871,69 +1017,86 @@ Edits and sends a SignatureRequest based off of the Template(s) specified with t ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data +public class SignatureRequestEditWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -985,33 +1148,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf"); - result.renameTo(new File("file_response.pdf")); +public class SignatureRequestFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1063,32 +1232,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - FileResponseDataUri result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1139,32 +1315,40 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); - try { - FileResponse result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1214,32 +1398,39 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestGet(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1290,40 +1481,42 @@ Take a look at our [search guide](/api/reference/search/) to learn more about qu ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var accountId = "accountId"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - SignatureRequestListResponse result = signatureRequestApi.signatureRequestList( - accountId, - page, - pageSize, - query +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class SignatureRequestListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1375,32 +1568,39 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +public class SignatureRequestReleaseHoldExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1451,35 +1651,43 @@ Sends an email to the signer reminding them to sign the signature request. You c ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var data = new SignatureRequestRemindRequest() - .emailAddress("john@example.com"); +public class SignatureRequestRemindExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1533,30 +1741,36 @@ Unlike /signature_request/cancel, this endpoint is synchronous and your access w ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - try { - signatureRequestApi.signatureRequestRemove(signatureRequestId); +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1605,66 +1819,86 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new SignatureRequestSendRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSend(data); - System.out.println(result); +public class SignatureRequestSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1713,64 +1947,85 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data); - System.out.println(result); +public class SignatureRequestSendWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -1823,36 +2078,44 @@ Updating the email address of a signer will generate a new `signature_id` value. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - var data = new SignatureRequestUpdateRequest() - .emailAddress("john@example.com") - .signatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); +public class SignatureRequestUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/TeamApi.md b/sdks/java-v2/docs/TeamApi.md index b35b40ea8..3e57e0451 100644 --- a/sdks/java-v2/docs/TeamApi.md +++ b/sdks/java-v2/docs/TeamApi.md @@ -28,35 +28,43 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamAddMemberRequest() - .emailAddress("george@example.com"); - - String teamId = null; - - try { - TeamGetResponse result = teamApi.teamAddMember(data, teamId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamAddMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -106,33 +114,42 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamCreateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamCreate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -181,28 +198,35 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - teamApi.teamDelete(); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TeamApi(config).teamDelete(); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -248,30 +272,37 @@ Returns information about your Team as well as a list of its members. If you do ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetResponse result = teamApi.teamGet(); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -317,28 +348,37 @@ Provides information about a team. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetInfoResponse result = teamApi.teamInfo(); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInfoExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamInfo"); System.err.println("Status code: " + e.getCode()); @@ -389,32 +429,37 @@ Provides a list of team invites (and their roles). ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var emailAddress = "user@dropboxsign.com"; - - try { - TeamInvitesResponse result = teamApi.teamInvites(emailAddress); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamInvitesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamInvites(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); + 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()); @@ -463,32 +508,39 @@ Provides a paginated list of members (and their roles) that belong to a given te ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamMembersResponse result = teamApi.teamMembers(teamId, page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamMembersExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamMembers"); System.err.println("Status code: " + e.getCode()); @@ -541,34 +593,43 @@ Removes the provided user Account from your Team. If the Account had an outstand ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamRemoveMemberRequest() - .emailAddress("teammate@dropboxsign.com") - .newOwnerEmailAddress("new_teammate@dropboxsign.com"); - - try { - TeamGetResponse result = teamApi.teamRemoveMember(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamRemoveMemberExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -617,32 +678,39 @@ Provides a paginated list of sub teams that belong to a given team. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamSubTeamsResponse result = teamApi.teamSubTeams(teamId, page, pageSize); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamSubTeamsExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamSubTeams"); System.err.println("Status code: " + e.getCode()); @@ -695,33 +763,42 @@ Updates the name of your Team. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamUpdateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamUpdate(data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TeamUpdateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/TemplateApi.md b/sdks/java-v2/docs/TemplateApi.md index e6c7d1745..f9de1a96a 100644 --- a/sdks/java-v2/docs/TemplateApi.md +++ b/sdks/java-v2/docs/TemplateApi.md @@ -29,35 +29,43 @@ Gives the specified Account access to the specified Template. The specified Acco ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateAddUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateAddUser(templateId, data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -107,64 +115,118 @@ Creates a template that can then be used. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateResponse result = templateApi.templateCreate(data); - System.out.println(result); +import java.util.Map; + +public class TemplateCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -213,64 +275,84 @@ The first step in an embedded template workflow. Creates a draft template that c ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateEmbeddedDraftRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateEmbeddedDraftResponse result = templateApi.templateCreateEmbeddedDraft(data); - System.out.println(result); +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -319,30 +401,37 @@ Completely deletes the template specified from the account. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - templateApi.templateDelete(templateId); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -393,33 +482,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; +import com.dropbox.sign.model.*; import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - File result = templateApi.templateFiles(templateId, "pdf"); - result.renameTo(new File("file_response.pdf")); +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -471,32 +566,39 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponseDataUri result = templateApi.templateFilesAsDataUri(templateId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsDataUriExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -547,32 +649,40 @@ If the files are currently being prepared, a status code of `409` will be return ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponse result = templateApi.templateFilesAsFileUrl(templateId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateFilesAsFileUrlExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -622,32 +732,39 @@ Returns the Template specified by the `template_id` parameter. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateGet(templateId); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -698,35 +815,42 @@ Take a look at our [search guide](/api/reference/search/) to learn more about qu ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - TemplateListResponse result = templateApi.templateList(accountId, page, pageSize, query); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -778,35 +902,43 @@ Removes the specified Account's access to the specified Template. ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateRemoveUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateGetResponse result = templateApi.templateRemoveUser(templateId, data); - System.out.println(result); +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -867,37 +999,45 @@ If the page orientation or page count is different from the original template do ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateUpdateFilesRequest() - .addFilesItem(new File("example_signature_request.pdf")); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateUpdateFilesResponse result = templateApi.templateUpdateFiles(templateId, data); - System.out.println(result); +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +public class TemplateUpdateFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/docs/UnclaimedDraftApi.md b/sdks/java-v2/docs/UnclaimedDraftApi.md index 4d6d12451..59ad0d2fd 100644 --- a/sdks/java-v2/docs/UnclaimedDraftApi.md +++ b/sdks/java-v2/docs/UnclaimedDraftApi.md @@ -22,66 +22,56 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer1 = new SubUnclaimedDraftSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubUnclaimedDraftSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); - - var data = new UnclaimedDraftCreateRequest() - .subject("The NDA we talked about") - .type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE) - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(subSigningOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreate(data); - System.out.println(result); +public class UnclaimedDraftCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -132,38 +122,47 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .addFilesItem(new File("example_signature_request.pdf")) - .requesterEmailAddress("jack@dropboxsign.com") - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); - System.out.println(result); +public class UnclaimedDraftCreateEmbeddedExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -214,49 +213,66 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; import java.util.List; +import java.util.Map; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer = new SubUnclaimedDraftTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .requesterEmailAddress("jack@dropboxsign.com") - .signers(List.of(signer)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); @@ -307,36 +323,44 @@ Creates a new signature request from an embedded request that can be edited prio ### Example ```java +package com.dropbox.sign_sandbox; + import com.dropbox.sign.ApiException; import com.dropbox.sign.Configuration; import com.dropbox.sign.api.*; import com.dropbox.sign.auth.*; +import com.dropbox.sign.JSON; import com.dropbox.sign.model.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftEditAndResendRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .testMode(true); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; +import java.io.File; +import java.time.LocalDate; +import java.time.OffsetDateTime; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); - System.out.println(result); +public class UnclaimedDraftEditAndResendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + config.setUsername("YOUR_API_KEY"); + // config.setAccessToken("YOUR_ACCESS_TOKEN"); + + var unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + 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()); diff --git a/sdks/java-v2/openapi-config.yaml b/sdks/java-v2/openapi-config.yaml index 44bc2c133..0c922902d 100644 --- a/sdks/java-v2/openapi-config.yaml +++ b/sdks/java-v2/openapi-config.yaml @@ -28,6 +28,10 @@ additionalProperties: licenseUrl: https://www.opensource.org/licenses/mit-license.php useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.package: com.dropbox.sign_sandbox + oseg.printApiCallProperty: true + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-EventCallbackHelper.mustache: templateType: SupportingFiles diff --git a/sdks/java-v2/templates/Main.java b/sdks/java-v2/templates/Main.java new file mode 100644 index 000000000..c8c8cea26 --- /dev/null +++ b/sdks/java-v2/templates/Main.java @@ -0,0 +1,6 @@ +package com.dropbox.sign_sandbox; + +public class Main { + public static void main(String[] args) { + } +} diff --git a/sdks/node/README.md b/sdks/node/README.md index ea771b194..38fb80120 100644 --- a/sdks/node/README.md +++ b/sdks/node/README.md @@ -47,58 +47,29 @@ Please follow the [installation procedure](#installation--usage) and then run th ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const accountApi = new DropboxSign.AccountApi(); +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountCreateRequest = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling AccountApi#accountCreate:"); console.log(error.body); }); ``` -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - ## API Endpoints diff --git a/sdks/node/bin/generate-examples.php b/sdks/node/bin/generate-examples.php index acd47f375..5288b8342 100755 --- a/sdks/node/bin/generate-examples.php +++ b/sdks/node/bin/generate-examples.php @@ -260,7 +260,7 @@ protected function getReplaceCodeString( $generate = new GenerateExamples( Yaml::parse(file_get_contents(__DIR__ . '/../openapi-sdk.yaml')), - ['JavaScript', 'TypeScript'], + ['TypeScript'], [__DIR__ . '/../docs/api', __DIR__ . '/../docs/model'], [__DIR__ . '/../README.md'], [ diff --git a/sdks/node/docs/api/AccountApi.md b/sdks/node/docs/api/AccountApi.md index fba97d1f1..fefcb3540 100644 --- a/sdks/node/docs/api/AccountApi.md +++ b/sdks/node/docs/api/AccountApi.md @@ -23,52 +23,23 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const accountApi = new DropboxSign.AccountApi(); +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; +const accountCreateRequest = new models.AccountCreateRequest(); +accountCreateRequest.emailAddress = "newuser@dropboxsign.com"; -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountCreateRequest = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "newuser@dropboxsign.com", -}; - -const result = accountApi.accountCreate(data); -result.then(response => { +apiCaller.accountCreate( + accountCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling AccountApi#accountCreate:"); console.log(error.body); }); @@ -110,44 +81,18 @@ Returns the properties and settings of your Account. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const accountApi = new DropboxSign.AccountApi(); +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = accountApi.accountGet(undefined, "jack@example.com"); -result.then(response => { +apiCaller.accountGet().then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = accountApi.accountGet(undefined, "jack@example.com"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling AccountApi#accountGet:"); console.log(error.body); }); @@ -190,52 +135,24 @@ Updates the properties and settings of your Account. Currently only allows for u ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; +const accountUpdateRequest = new models.AccountUpdateRequest(); +accountUpdateRequest.callbackUrl = "https://www.example.com/callback"; +accountUpdateRequest.locale = "en-US"; -const data: DropboxSign.AccountUpdateRequest = { - callbackUrl: "https://www.example.com/callback", -}; - -const result = accountApi.accountUpdate(data); -result.then(response => { +apiCaller.accountUpdate( + accountUpdateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - callbackUrl: "https://www.example.com/callback", -}; - -const result = accountApi.accountUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling AccountApi#accountUpdate:"); console.log(error.body); }); @@ -277,52 +194,23 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.AccountVerifyRequest = { - emailAddress: "some_user@dropboxsign.com", -}; - -const result = accountApi.accountVerify(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const accountApi = new DropboxSign.AccountApi(); - -// Configure HTTP basic authorization: api_key -accountApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// or, configure Bearer (JWT) authorization: oauth2 -// accountApi.accessToken = "YOUR_ACCESS_TOKEN"; +const apiCaller = new api.AccountApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const data = { - emailAddress: "some_user@dropboxsign.com", -}; +const accountVerifyRequest = new models.AccountVerifyRequest(); +accountVerifyRequest.emailAddress = "some_user@dropboxsign.com"; -const result = accountApi.accountVerify(data); -result.then(response => { +apiCaller.accountVerify( + accountVerifyRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling AccountApi#accountVerify:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/ApiAppApi.md b/sdks/node/docs/api/ApiAppApi.md index 758e164fe..e7dd67b58 100644 --- a/sdks/node/docs/api/ApiAppApi.md +++ b/sdks/node/docs/api/ApiAppApi.md @@ -24,88 +24,40 @@ Creates a new API App. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const oauth: DropboxSign.SubOAuth = { - callbackUrl: "https://example.com/oauth", - scopes: [ - DropboxSign.SubOAuth.ScopesEnum.BasicAccountInfo, - DropboxSign.SubOAuth.ScopesEnum.RequestSignature, - ], -}; - -const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data: DropboxSign.ApiAppCreateRequest = { - name: "My Production App", - domains: ["example.com"], - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - oauth, - whiteLabelingOptions, -}; - -const result = apiAppApi.apiAppCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const oauth = { - callbackUrl: "https://example.com/oauth", - scopes: [ - "basic_account_info", - "request_signature", - ], -}; - -const whiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data = { - name: "My Production App", - domains: ["example.com"], - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - oauth, - whiteLabelingOptions, -}; - -const result = apiAppApi.apiAppCreate(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppCreateRequest = new models.ApiAppCreateRequest(); +apiAppCreateRequest.name = "My Production App"; +apiAppCreateRequest.domains = [ + "example.com", +]; +apiAppCreateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppCreateRequest.oauth = oauth; +apiAppCreateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppCreate( + apiAppCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling ApiAppApi#apiAppCreate:"); console.log(error.body); }); @@ -147,48 +99,18 @@ Deletes an API App. Can only be invoked for apps you own. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppDelete(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = apiAppApi.apiAppDelete(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).catch(error => { + console.log("Exception when calling ApiAppApi#apiAppDelete:"); console.log(error.body); }); @@ -230,48 +152,20 @@ Returns an object with information about an API App. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppGet(clientId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = apiAppApi.apiAppGet(clientId); -result.then(response => { +apiCaller.apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling ApiAppApi#apiAppGet:"); console.log(error.body); }); @@ -313,50 +207,21 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 2; - -const result = apiAppApi.apiAppList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const page = 1; -const pageSize = 2; +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = apiAppApi.apiAppList(page, pageSize); -result.then(response => { +apiCaller.apiAppList( + 1, // page + 20, // pageSize +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling ApiAppApi#apiAppList:"); console.log(error.body); }); @@ -399,74 +264,42 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const whiteLabelingOptions: DropboxSign.SubWhiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data: DropboxSign.ApiAppUpdateRequest = { - name: "New Name", - callbackUrl: "https://example.com/dropboxsign", - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - whiteLabelingOptions, -}; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppUpdate(clientId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const apiAppApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -apiAppApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// apiAppApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const whiteLabelingOptions = { - primaryButtonColor: "#00b3e6", - primaryButtonTextColor: "#ffffff", -}; - -const data = { - name: "New Name", - callbackUrl: "http://example.com/dropboxsign", - customLogoFile: fs.createReadStream("CustomLogoFile.png"), - whiteLabelingOptions, -}; - -const clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - -const result = apiAppApi.apiAppUpdate(clientId, data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ApiAppApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const oauth = new models.SubOAuth(); +oauth.callbackUrl = "https://example.com/oauth"; +oauth.scopes = [ + models.SubOAuth.ScopesEnum.BasicAccountInfo, + models.SubOAuth.ScopesEnum.RequestSignature, +]; + +const whiteLabelingOptions = new models.SubWhiteLabelingOptions(); +whiteLabelingOptions.primaryButtonColor = "#00b3e6"; +whiteLabelingOptions.primaryButtonTextColor = "#ffffff"; + +const apiAppUpdateRequest = new models.ApiAppUpdateRequest(); +apiAppUpdateRequest.callbackUrl = "https://example.com/dropboxsign"; +apiAppUpdateRequest.name = "New Name"; +apiAppUpdateRequest.domains = [ + "example.com", +]; +apiAppUpdateRequest.customLogoFile = fs.createReadStream("CustomLogoFile.png"); +apiAppUpdateRequest.oauth = oauth; +apiAppUpdateRequest.whiteLabelingOptions = whiteLabelingOptions; + +apiCaller.apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling ApiAppApi#apiAppUpdate:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/BulkSendJobApi.md b/sdks/node/docs/api/BulkSendJobApi.md index bbd50c805..95a7a6b50 100644 --- a/sdks/node/docs/api/BulkSendJobApi.md +++ b/sdks/node/docs/api/BulkSendJobApi.md @@ -21,48 +21,22 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - -const result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); -result.then(response => { +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 Dropbox Sign API:"); + console.log("Exception when calling BulkSendJobApi#bulkSendJobGet:"); console.log(error.body); }); @@ -106,50 +80,21 @@ Returns a list of BulkSendJob that you can access. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 20; - -const result = bulkSendJobApi.bulkSendJobList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const bulkSendJobApi = new DropboxSign.BulkSendJobApi(); - -// Configure HTTP basic authorization: api_key -bulkSendJobApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// bulkSendJobApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const page = 1; -const pageSize = 20; - -const result = bulkSendJobApi.bulkSendJobList(page, pageSize); -result.then(response => { +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 Dropbox Sign API:"); + console.log("Exception when calling BulkSendJobApi#bulkSendJobList:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/EmbeddedApi.md b/sdks/node/docs/api/EmbeddedApi.md index 3fc622fac..107b4f15c 100644 --- a/sdks/node/docs/api/EmbeddedApi.md +++ b/sdks/node/docs/api/EmbeddedApi.md @@ -21,58 +21,30 @@ Retrieves an embedded object containing a template url that can be opened in an ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.EmbeddedEditUrlRequest = { - ccRoles: [""], - mergeFields: [], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = embeddedApi.embeddedEditUrl(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - ccRoles: [""], - mergeFields: [], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = embeddedApi.embeddedEditUrl(templateId, data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const mergeFields = [ +]; + +const embeddedEditUrlRequest = new models.EmbeddedEditUrlRequest(); +embeddedEditUrlRequest.ccRoles = [ + "", +]; +embeddedEditUrlRequest.mergeFields = mergeFields; + +apiCaller.embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling EmbeddedApi#embeddedEditUrl:"); console.log(error.body); }); @@ -115,48 +87,20 @@ Retrieves an embedded object containing a signature url that can be opened in an ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - -const result = embeddedApi.embeddedSignUrl(signatureId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const embeddedApi = new DropboxSign.EmbeddedApi(); - -// Configure HTTP basic authorization: api_key -embeddedApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// embeddedApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; +const apiCaller = new api.EmbeddedApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = embeddedApi.embeddedSignUrl(signatureId); -result.then(response => { +apiCaller.embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", // signatureId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling EmbeddedApi#embeddedSignUrl:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/FaxApi.md b/sdks/node/docs/api/FaxApi.md index 6a67c3316..98a4ae276 100644 --- a/sdks/node/docs/api/FaxApi.md +++ b/sdks/node/docs/api/FaxApi.md @@ -24,36 +24,17 @@ Deletes the specified Fax from the system ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const result = faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).catch(error => { + console.log("Exception when calling FaxApi#faxDelete:"); console.log(error.body); }); @@ -95,44 +76,19 @@ Downloads files associated with a Fax ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = faxApi.faxFiles(faxId); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = faxApi.faxFiles(faxId); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); +apiCaller.faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { + fs.createWriteStream('./file_response').write(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxApi#faxFiles:"); console.log(error.body); }); @@ -174,42 +130,19 @@ Returns information about a Fax ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.ApiAppApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - -const result = faxApi.faxGet(faxId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; -const result = faxApi.faxGet(faxId); -result.then(response => { +apiCaller.faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // faxId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxApi#faxGet:"); console.log(error.body); }); @@ -251,44 +184,20 @@ Returns properties of multiple Faxes ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -const page = 1; -const pageSize = 2; - -const result = faxApi.faxList(page, pageSize); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const page = 1; -const pageSize = 2; +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; -const result = faxApi.faxList(page, pageSize); -result.then(response => { +apiCaller.faxList( + 1, // page + 20, // pageSize +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxApi#faxList:"); console.log(error.body); }); @@ -331,104 +240,31 @@ Creates and sends a new Fax with the submitted file(s) ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.FaxSendRequest = { - files: [ file, fileBuffer, fileBufferAlt ], - testMode: true, - recipient: "16690000001", - sender: "16690000000", - coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", - coverPageFrom: "Faxer Faxerson", - title: "This is what the fax is about!", -}; - -const result = faxApi.faxSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const faxApi = new DropboxSign.FaxApi(); - -// Configure HTTP basic authorization: api_key -faxApi.username = "YOUR_API_KEY"; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data = { - files: [ file, fileBuffer, fileBufferAlt ], - testMode: true, - recipient: "16690000001", - sender: "16690000000", - coverPageTo: "Jill Fax", - coverPageMessage: "I'm sending you a fax!", - coverPageFrom: "Faxer Faxerson", - title: "This is what the fax is about!", -}; - -const result = faxApi.faxSend(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.FaxApi(); +apiCaller.username = "YOUR_API_KEY"; + +const faxSendRequest = new models.FaxSendRequest(); +faxSendRequest.recipient = "16690000001"; +faxSendRequest.sender = "16690000000"; +faxSendRequest.testMode = true; +faxSendRequest.coverPageTo = "Jill Fax"; +faxSendRequest.coverPageFrom = "Faxer Faxerson"; +faxSendRequest.coverPageMessage = "I'm sending you a fax!"; +faxSendRequest.title = "This is what the fax is about!"; +faxSendRequest.files = [ + fs.createReadStream("./example_fax.pdf"), +]; + +apiCaller.faxSend( + faxSendRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxApi#faxSend:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/FaxLineApi.md b/sdks/node/docs/api/FaxLineApi.md index dc59add61..d0d6e8b5f 100644 --- a/sdks/node/docs/api/FaxLineApi.md +++ b/sdks/node/docs/api/FaxLineApi.md @@ -26,48 +26,23 @@ Grants a user access to the specified Fax Line. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const faxLineApi = new DropboxSign.FaxLineApi(); +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; +const faxLineAddUserRequest = new models.FaxLineAddUserRequest(); +faxLineAddUserRequest.number = "[FAX_NUMBER]"; +faxLineAddUserRequest.emailAddress = "member@dropboxsign.com"; -const data: DropboxSign.FaxLineAddUserRequest = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineAddUser(data); -result.then(response => { +apiCaller.faxLineAddUser( + faxLineAddUserRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineAddUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxLineApi#faxLineAddUser:"); console.log(error.body); }); @@ -109,38 +84,22 @@ Returns a list of available area codes for a given state/province and city ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineAreaCodeGet("US", "CA"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineAreaCodeGet("US", "CA"); -result.then(response => { +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 Dropbox Sign API:"); + console.log("Exception when calling FaxLineApi#faxLineAreaCodeGet:"); console.log(error.body); }); @@ -185,48 +144,23 @@ Purchases a new Fax Line ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; -const data: DropboxSign.FaxLineCreateRequest = { - areaCode: 209, - country: "US", -}; +const faxLineCreateRequest = new models.FaxLineCreateRequest(); +faxLineCreateRequest.areaCode = 209; +faxLineCreateRequest.country = models.FaxLineCreateRequest.CountryEnum.Us; -const result = faxLineApi.faxLineCreate(data); -result.then(response => { +apiCaller.faxLineCreate( + faxLineCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data = { - areaCode: 209, - country: "US", -}; - -const result = faxLineApi.faxLineCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxLineApi#faxLineCreate:"); console.log(error.body); }); @@ -268,44 +202,20 @@ Deletes the specified Fax Line from the subscription. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineDeleteRequest = { - number: "[FAX_NUMBER]", -}; - -const result = faxLineApi.faxLineDelete(data); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; -const data = { - number: "[FAX_NUMBER]", -}; +const faxLineDeleteRequest = new models.FaxLineDeleteRequest(); +faxLineDeleteRequest.number = "[FAX_NUMBER]"; -const result = faxLineApi.faxLineDelete(data); - -result.catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.faxLineDelete( + faxLineDeleteRequest, +).catch(error => { + console.log("Exception when calling FaxLineApi#faxLineDelete:"); console.log(error.body); }); @@ -347,38 +257,19 @@ Returns the properties and settings of a Fax Line. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; -const result = faxLineApi.faxLineGet("[FAX_NUMBER]"); -result.then(response => { +apiCaller.faxLineGet( + "123-123-1234", // number +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineGet("[FAX_NUMBER]"); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxLineApi#faxLineGet:"); console.log(error.body); }); @@ -420,38 +311,22 @@ Returns the properties and settings of multiple Fax Lines. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineList(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const result = faxLineApi.faxLineList(); -result.then(response => { +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 Dropbox Sign API:"); + console.log("Exception when calling FaxLineApi#faxLineList:"); console.log(error.body); }); @@ -496,48 +371,23 @@ Removes a user\'s access to the specified Fax Line ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); - -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.FaxLineRemoveUserRequest = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; - -const result = faxLineApi.faxLineRemoveUser(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const faxLineApi = new DropboxSign.FaxLineApi(); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// Configure HTTP basic authorization: api_key -faxLineApi.username = "YOUR_API_KEY"; +const apiCaller = new api.FaxLineApi(); +apiCaller.username = "YOUR_API_KEY"; -const data = { - number: "[FAX_NUMBER]", - emailAddress: "member@dropboxsign.com", -}; +const faxLineRemoveUserRequest = new models.FaxLineRemoveUserRequest(); +faxLineRemoveUserRequest.number = "[FAX_NUMBER]"; +faxLineRemoveUserRequest.emailAddress = "member@dropboxsign.com"; -const result = faxLineApi.faxLineRemoveUser(data); -result.then(response => { +apiCaller.faxLineRemoveUser( + faxLineRemoveUserRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling FaxLineApi#faxLineRemoveUser:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/OAuthApi.md b/sdks/node/docs/api/OAuthApi.md index 81ae5b1db..ef2ac543d 100644 --- a/sdks/node/docs/api/OAuthApi.md +++ b/sdks/node/docs/api/OAuthApi.md @@ -21,44 +21,25 @@ Once you have retrieved the code from the user callback, you will need to exchan ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenGenerateRequest(); -data.state = "900e06e2"; -data.code = "1b0d28d90c86c141"; -data.clientId = "cc91c61d00f8bb2ece1428035716b"; -data.clientSecret = "1d14434088507ffa390e6f5528465"; - -const result = oAuthApi.oauthTokenGenerate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.OAuthApi(); + +const oAuthTokenGenerateRequest = new models.OAuthTokenGenerateRequest(); +oAuthTokenGenerateRequest.clientId = "cc91c61d00f8bb2ece1428035716b"; +oAuthTokenGenerateRequest.clientSecret = "1d14434088507ffa390e6f5528465"; +oAuthTokenGenerateRequest.code = "1b0d28d90c86c141"; +oAuthTokenGenerateRequest.state = "900e06e2"; +oAuthTokenGenerateRequest.grantType = "authorization_code"; + +apiCaller.oauthTokenGenerate( + oAuthTokenGenerateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenGenerateRequest(); -data.state = "900e06e2"; -data.code = "1b0d28d90c86c141"; -data.clientId = "cc91c61d00f8bb2ece1428035716b"; -data.clientSecret = "1d14434088507ffa390e6f5528465"; - -const result = oAuthApi.oauthTokenGenerate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling OAuthApi#oauthTokenGenerate:"); console.log(error.body); }); @@ -100,38 +81,22 @@ Access tokens are only valid for a given period of time (typically one hour) for ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const oAuthApi = new DropboxSign.OAuthApi(); - -const data = new DropboxSign.OAuthTokenRefreshRequest(); -data.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; - -const result = oAuthApi.oauthTokenRefresh(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const oAuthApi = new DropboxSign.OAuthApi(); +const apiCaller = new api.OAuthApi(); -const data = new DropboxSign.OAuthTokenRefreshRequest(); -data.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; +const oAuthTokenRefreshRequest = new models.OAuthTokenRefreshRequest(); +oAuthTokenRefreshRequest.grantType = "refresh_token"; +oAuthTokenRefreshRequest.refreshToken = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"; -const result = oAuthApi.oauthTokenRefresh(data); -result.then(response => { +apiCaller.oauthTokenRefresh( + oAuthTokenRefreshRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling OAuthApi#oauthTokenRefresh:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/ReportApi.md b/sdks/node/docs/api/ReportApi.md index 61c772f06..3a5678885 100644 --- a/sdks/node/docs/api/ReportApi.md +++ b/sdks/node/docs/api/ReportApi.md @@ -20,56 +20,27 @@ Request the creation of one or more report(s). When the report(s) have been gen ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const reportApi = new DropboxSign.ReportApi(); - -// Configure HTTP basic authorization: api_key -reportApi.username = "YOUR_API_KEY"; - -const data: DropboxSign.ReportCreateRequest = { - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: [ - DropboxSign.ReportCreateRequest.ReportTypeEnum.UserActivity, - DropboxSign.ReportCreateRequest.ReportTypeEnum.DocumentStatus, - ] -}; - -const result = reportApi.reportCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const reportApi = new DropboxSign.ReportApi(); - -// Configure HTTP basic authorization: api_key -reportApi.username = "YOUR_API_KEY"; - -const data = { - startDate: "09/01/2020", - endDate: "09/01/2020", - reportType: [ - "user_activity", - "document_status", - ] -}; - -const result = reportApi.reportCreate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.ReportApi(); +apiCaller.username = "YOUR_API_KEY"; + +const reportCreateRequest = new models.ReportCreateRequest(); +reportCreateRequest.startDate = "09/01/2020"; +reportCreateRequest.endDate = "09/01/2020"; +reportCreateRequest.reportType = [ + models.ReportCreateRequest.ReportTypeEnum.UserActivity, + models.ReportCreateRequest.ReportTypeEnum.DocumentStatus, +]; + +apiCaller.reportCreate( + reportCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling ReportApi#reportCreate:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/SignatureRequestApi.md b/sdks/node/docs/api/SignatureRequestApi.md index 851264e7b..4ee77ab2f 100644 --- a/sdks/node/docs/api/SignatureRequestApi.md +++ b/sdks/node/docs/api/SignatureRequestApi.md @@ -39,139 +39,87 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -const signerList1Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "ABC Corp", -}; - -const signerList1: DropboxSign.SubBulkSignerList = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "123 LLC", -}; - -const signerList2: DropboxSign.SubBulkSignerList = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data: DropboxSign.SignatureRequestBulkCreateEmbeddedWithTemplateRequest = { - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields = { - name: "company", - value: "ABC Corp", -}; - -const signerList1 = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields = { - name: "company", - value: "123 LLC", -}; - -const signerList2 = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data = { - clientId: "1a659d9ad95bccd307ecad78d72192f8", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkCreateEmbeddedWithTemplateRequest = new models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); +signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId = "1a659d9ad95bccd307ecad78d72192f8"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList = signerList; +signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate:"); console.log(error.body); }); @@ -213,140 +161,87 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "ABC Corp", -}; - -const signerList1: DropboxSign.SubBulkSignerList = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields: DropboxSign.SubBulkSignerListCustomField = { - name: "company", - value: "123 LLC", -}; - -const signerList2: DropboxSign.SubBulkSignerList = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data: DropboxSign.SignatureRequestBulkSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signerList1Signer = { - role: "Client", - name: "George", - emailAddress: "george@example.com", - pin: "d79a3td", -}; - -const signerList1CustomFields = { - name: "company", - value: "ABC Corp", -}; - -const signerList1 = { - signers: [ signerList1Signer ], - customFields: [ signerList1CustomFields ], -}; - -const signerList2Signer = { - role: "Client", - name: "Mary", - emailAddress: "mary@example.com", - pin: "gd9as5b", -}; - -const signerList2CustomFields = { - name: "company", - value: "123 LLC", -}; - -const signerList2 = { - signers: [ signerList2Signer ], - customFields: [ signerList2CustomFields ], -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signerList: [ signerList1, signerList2 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signerList2CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList2CustomFields1.name = "company"; +signerList2CustomFields1.value = "123 LLC"; + +const signerList2CustomFields = [ + signerList2CustomFields1, +]; + +const signerList2Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList2Signers1.role = "Client"; +signerList2Signers1.name = "Mary"; +signerList2Signers1.emailAddress = "mary@example.com"; +signerList2Signers1.pin = "gd9as5b"; + +const signerList2Signers = [ + signerList2Signers1, +]; + +const signerList1CustomFields1 = new models.SubBulkSignerListCustomField(); +signerList1CustomFields1.name = "company"; +signerList1CustomFields1.value = "ABC Corp"; + +const signerList1CustomFields = [ + signerList1CustomFields1, +]; + +const signerList1Signers1 = new models.SubSignatureRequestTemplateSigner(); +signerList1Signers1.role = "Client"; +signerList1Signers1.name = "George"; +signerList1Signers1.emailAddress = "george@example.com"; +signerList1Signers1.pin = "d79a3td"; + +const signerList1Signers = [ + signerList1Signers1, +]; + +const signerList1 = new models.SubBulkSignerList(); +signerList1.customFields = signerList1CustomFields; +signerList1.signers = signerList1Signers; + +const signerList2 = new models.SubBulkSignerList(); +signerList2.customFields = signerList2CustomFields; +signerList2.signers = signerList2Signers; + +const signerList = [ + signerList1, + signerList2, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const signatureRequestBulkSendWithTemplateRequest = new models.SignatureRequestBulkSendWithTemplateRequest(); +signatureRequestBulkSendWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestBulkSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestBulkSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestBulkSendWithTemplateRequest.testMode = true; +signatureRequestBulkSendWithTemplateRequest.signerList = signerList; +signatureRequestBulkSendWithTemplateRequest.ccs = ccs; + +apiCaller.signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate:"); console.log(error.body); }); @@ -388,48 +283,18 @@ Cancels an incomplete signature request. This action is **not reversible**. The ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestCancel(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = signatureRequestApi.signatureRequestCancel(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestCancel:"); console.log(error.body); }); @@ -471,116 +336,58 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestCreateEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbedded(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestCreateEmbeddedRequest = new models.SignatureRequestCreateEmbeddedRequest(); +signatureRequestCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestCreateEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestCreateEmbeddedRequest.testMode = true; +signatureRequestCreateEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestCreateEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestCreateEmbeddedRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded:"); console.log(error.body); }); @@ -622,92 +429,47 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestCreateEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestCreateEmbeddedWithTemplateRequest = new models.SignatureRequestCreateEmbeddedWithTemplateRequest(); +signatureRequestCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestCreateEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestCreateEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestCreateEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestCreateEmbeddedWithTemplateRequest.testMode = true; +signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate:"); console.log(error.body); }); @@ -749,179 +511,66 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestEditRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - -const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestEditRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditRequest = new models.SignatureRequestEditRequest(); +signatureRequestEditRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditRequest.subject = "The NDA we talked about"; +signatureRequestEditRequest.testMode = true; +signatureRequestEditRequest.title = "NDA with Acme Co."; +signatureRequestEditRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestEditRequest.fieldOptions = fieldOptions; +signatureRequestEditRequest.signingOptions = signingOptions; +signatureRequestEditRequest.signers = signers; + +apiCaller.signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestEdit:"); console.log(error.body); }); @@ -964,126 +613,59 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestEditEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data -); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestEditEmbeddedRequest = new models.SignatureRequestEditEmbeddedRequest(); +signatureRequestEditEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestEditEmbeddedRequest.subject = "The NDA we talked about"; +signatureRequestEditEmbeddedRequest.testMode = true; +signatureRequestEditEmbeddedRequest.title = "NDA with Acme Co."; +signatureRequestEditEmbeddedRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestEditEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestEditEmbeddedRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedRequest.signers = signers; + +apiCaller.signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: true, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded:"); console.log(error.body); }); @@ -1126,102 +708,48 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestEditEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data -); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const signatureRequestEditEmbeddedWithTemplateRequest = new models.SignatureRequestEditEmbeddedWithTemplateRequest(); +signatureRequestEditEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +signatureRequestEditEmbeddedWithTemplateRequest.templateIds = [ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", +]; +signatureRequestEditEmbeddedWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditEmbeddedWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditEmbeddedWithTemplateRequest.testMode = true; +signatureRequestEditEmbeddedWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate:"); console.log(error.body); }); @@ -1257,135 +785,74 @@ result.then(response => { signatureRequestEditWithTemplate(signatureRequestId: string, signatureRequestEditWithTemplateRequest: SignatureRequestEditWithTemplateRequest): SignatureRequestGetResponse ``` -Edit Signature Request With Template - -Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. - -### TypeScript Example - -```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1: DropboxSign.SubCustomField = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data -); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1 = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; +Edit Signature Request With Template -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; +Edits and sends a SignatureRequest based off of the Template(s) specified with the template_ids parameter. **NOTE:** Edit and resend will not deduct your signature request quota. -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +### TypeScript Example -const result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data, -); -result.then(response => { +```typescript +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestEditWithTemplateRequest = new models.SignatureRequestEditWithTemplateRequest(); +signatureRequestEditWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestEditWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestEditWithTemplateRequest.subject = "Purchase Order"; +signatureRequestEditWithTemplateRequest.testMode = true; +signatureRequestEditWithTemplateRequest.signingOptions = signingOptions; +signatureRequestEditWithTemplateRequest.signers = signers; +signatureRequestEditWithTemplateRequest.ccs = ccs; +signatureRequestEditWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate:"); console.log(error.body); }); @@ -1428,54 +895,21 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -const fileType = "pdf"; - -const result = signatureRequestApi.signatureRequestFiles(signatureRequestId, fileType); - -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -const fileType = "pdf"; - -const result = signatureRequestApi.signatureRequestFiles(signatureRequestId, fileType); - -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); +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 Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestFiles:"); console.log(error.body); }); @@ -1518,48 +952,20 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); -result.then(response => { +apiCaller.signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri:"); console.log(error.body); }); @@ -1601,48 +1007,21 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); -result.then(response => { +apiCaller.signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1, // forceDownload +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl:"); console.log(error.body); }); @@ -1685,48 +1064,20 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - -const result = signatureRequestApi.signatureRequestGet(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = signatureRequestApi.signatureRequestGet(signatureRequestId); -result.then(response => { +apiCaller.signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestGet:"); console.log(error.body); }); @@ -1768,50 +1119,23 @@ Returns a list of SignatureRequests that you can access. This includes Signature ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = null; -const page = 1; - -const result = signatureRequestApi.signatureRequestList(accountId, page); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = null; -const page = 1; - -const result = signatureRequestApi.signatureRequestList(accountId, page); -result.then(response => { +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 Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestList:"); console.log(error.body); }); @@ -1856,48 +1180,20 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); -result.then(response => { +apiCaller.signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestReleaseHold:"); console.log(error.body); }); @@ -1939,56 +1235,24 @@ Sends an email to the signer reminding them to sign the signature request. You c ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.SignatureRequestRemindRequest = { - emailAddress: "john@example.com", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const data = { - emailAddress: "john@example.com", -}; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +const signatureRequestRemindRequest = new models.SignatureRequestRemindRequest(); +signatureRequestRemindRequest.emailAddress = "john@example.com"; -const result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); -result.then(response => { +apiCaller.signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestRemind:"); console.log(error.body); }); @@ -2031,48 +1295,17 @@ Removes your access to a completed signature request. This action is **not rever ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestRemove(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; -const result = signatureRequestApi.signatureRequestRemove(signatureRequestId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId +).catch(error => { + console.log("Exception when calling SignatureRequestApi#signatureRequestRemove:"); console.log(error.body); }); @@ -2114,174 +1347,65 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubSignatureRequestSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer: DropboxSign.RequestDetailedFile = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt: DropboxSign.RequestDetailedFile = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data: DropboxSign.SignatureRequestSendRequest = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSend(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -// Upload a local file -const file = fs.createReadStream("example_signature_request.pdf"); - -// or, upload from buffer -const fileBuffer = { - value: fs.readFileSync("example_signature_request.pdf"), - options: { - filename: "example_signature_request.pdf", - contentType: "application/pdf", - }, -}; - -// or, upload from buffer alternative -const fileBufferAlt = { - value: Buffer.from("abc-123"), - options: { - filename: "txt-sample.txt", - contentType: "text/plain", - }, -}; - -const data = { - title: "NDA with Acme Co.", - subject: "The NDA we talked about", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ signer1, signer2 ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [ file, fileBuffer, fileBufferAlt ], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSend(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers2 = new models.SubSignatureRequestSigner(); +signers2.name = "Jill"; +signers2.emailAddress = "jill@example.com"; +signers2.order = 1; + +const signers = [ + signers1, + signers2, +]; + +const signatureRequestSendRequest = new models.SignatureRequestSendRequest(); +signatureRequestSendRequest.message = "Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."; +signatureRequestSendRequest.subject = "The NDA we talked about"; +signatureRequestSendRequest.testMode = true; +signatureRequestSendRequest.title = "NDA with Acme Co."; +signatureRequestSendRequest.ccEmailAddresses = [ + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com", +]; +signatureRequestSendRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +signatureRequestSendRequest.metadata = { + "custom_id": 1234, + "custom_text": "NDA #9" +}; +signatureRequestSendRequest.fieldOptions = fieldOptions; +signatureRequestSendRequest.signingOptions = signingOptions; +signatureRequestSendRequest.signers = signers; + +apiCaller.signatureRequestSend( + signatureRequestSendRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestSend:"); console.log(error.body); }); @@ -2323,118 +1447,66 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubSignatureRequestTemplateSigner = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1: DropboxSign.SubCustomField = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const data: DropboxSign.SignatureRequestSendWithTemplateRequest = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSendWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - emailAddress: "george@example.com", - name: "George", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@example.com", -}; - -const customField1 = { - name: "Cost", - value: "$20,000", - editor: "Client", - required: true, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const data = { - templateIds: ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject: "Purchase Order", - message: "Glad we could come to an agreement.", - signers: [ signer1 ], - ccs: [ cc1 ], - customFields: [ customField1 ], - signingOptions, - testMode: true, -}; - -const result = signatureRequestApi.signatureRequestSendWithTemplate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signingOptions = new models.SubSigningOptions(); +signingOptions.defaultType = models.SubSigningOptions.DefaultTypeEnum.Draw; +signingOptions.draw = true; +signingOptions.phone = false; +signingOptions.type = true; +signingOptions.upload = true; + +const signers1 = new models.SubSignatureRequestTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@example.com"; + +const ccs = [ + ccs1, +]; + +const customFields1 = new models.SubCustomField(); +customFields1.name = "Cost"; +customFields1.editor = "Client"; +customFields1.required = true; +customFields1.value = "$20,000"; + +const customFields = [ + customFields1, +]; + +const signatureRequestSendWithTemplateRequest = new models.SignatureRequestSendWithTemplateRequest(); +signatureRequestSendWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +signatureRequestSendWithTemplateRequest.message = "Glad we could come to an agreement."; +signatureRequestSendWithTemplateRequest.subject = "Purchase Order"; +signatureRequestSendWithTemplateRequest.testMode = true; +signatureRequestSendWithTemplateRequest.signingOptions = signingOptions; +signatureRequestSendWithTemplateRequest.signers = signers; +signatureRequestSendWithTemplateRequest.ccs = ccs; +signatureRequestSendWithTemplateRequest.customFields = customFields; + +apiCaller.signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate:"); console.log(error.body); }); @@ -2476,58 +1548,25 @@ Updates the email address and/or the name for a given signer on a signature requ ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.SignatureRequestUpdateRequest = { - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3", -}; - -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - -const result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const signatureRequestApi = new DropboxSign.SignatureRequestApi(); - -// Configure HTTP basic authorization: api_key -signatureRequestApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// signatureRequestApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const data = { - emailAddress: "john@example.com", - signatureId: "78caf2a1d01cd39cea2bc1cbb340dac3", -}; +const apiCaller = new api.SignatureRequestApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +const signatureRequestUpdateRequest = new models.SignatureRequestUpdateRequest(); +signatureRequestUpdateRequest.signatureId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +signatureRequestUpdateRequest.emailAddress = "john@example.com"; -const result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); -result.then(response => { +apiCaller.signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling SignatureRequestApi#signatureRequestUpdate:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/TeamApi.md b/sdks/node/docs/api/TeamApi.md index cc21d019a..944e03b99 100644 --- a/sdks/node/docs/api/TeamApi.md +++ b/sdks/node/docs/api/TeamApi.md @@ -29,52 +29,24 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const teamApi = new DropboxSign.TeamApi(); +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +const teamAddMemberRequest = new models.TeamAddMemberRequest(); +teamAddMemberRequest.emailAddress = "george@example.com"; -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamAddMemberRequest = { - emailAddress: "george@example.com", -}; - -const result = teamApi.teamAddMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - emailAddress: "george@example.com", -}; - -const result = teamApi.teamAddMember(data); -result.then(response => { +apiCaller.teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamAddMember:"); console.log(error.body); }); @@ -117,52 +89,23 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const teamApi = new DropboxSign.TeamApi(); +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +const teamCreateRequest = new models.TeamCreateRequest(); +teamCreateRequest.name = "New Team Name"; -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamCreateRequest = { - name: "New Team Name" -}; - -const result = teamApi.teamCreate(data); -result.then(response => { +apiCaller.teamCreate( + teamCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - name: "New Team Name" -}; - -const result = teamApi.teamCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamCreate:"); console.log(error.body); }); @@ -204,44 +147,16 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamDelete(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = teamApi.teamDelete(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.teamDelete().catch(error => { + console.log("Exception when calling TeamApi#teamDelete:"); console.log(error.body); }); @@ -281,44 +196,18 @@ Returns information about your Team as well as a list of its members. If you do ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamGet(); -result.then(response => { +apiCaller.teamGet().then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamGet(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamGet:"); console.log(error.body); }); @@ -358,44 +247,20 @@ Provides information about a team. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = teamApi.teamInfo(); -result.then(response => { +apiCaller.teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const result = teamApi.teamInfo(); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamInfo:"); console.log(error.body); }); @@ -437,48 +302,18 @@ Provides a list of team invites (and their roles). ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const emailAddress = "user@dropboxsign.com"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const result = teamApi.teamInvites(emailAddress); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const emailAddress = "user@dropboxsign.com"; - -const result = teamApi.teamInvites(emailAddress); -result.then(response => { +apiCaller.teamInvites().then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamInvites:"); console.log(error.body); }); @@ -520,48 +355,22 @@ Provides a paginated list of members (and their roles) that belong to a given te ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamMembers(teamId); -result.then(response => { +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 Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamMembers(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamMembers:"); console.log(error.body); }); @@ -605,54 +414,24 @@ Removes the provided user Account from your Team. If the Account had an outstand ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamRemoveMemberRequest = { - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com", -}; - -const result = teamApi.teamRemoveMember(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; +const teamRemoveMemberRequest = new models.TeamRemoveMemberRequest(); +teamRemoveMemberRequest.emailAddress = "teammate@dropboxsign.com"; +teamRemoveMemberRequest.newOwnerEmailAddress = "new_teammate@dropboxsign.com"; -const data = { - emailAddress: "teammate@dropboxsign.com", - newOwnerEmailAddress: "new_teammate@dropboxsign.com", -}; - -const result = teamApi.teamRemoveMember(data); -result.then(response => { +apiCaller.teamRemoveMember( + teamRemoveMemberRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamRemoveMember:"); console.log(error.body); }); @@ -694,48 +473,22 @@ Provides a paginated list of sub teams that belong to a given team. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamSubTeams(teamId); -result.then(response => { +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 Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - -const result = teamApi.teamSubTeams(teamId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamSubTeams:"); console.log(error.body); }); @@ -779,52 +532,23 @@ Updates the name of your Team. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TeamUpdateRequest = { - name: "New Team Name", -}; - -const result = teamApi.teamUpdate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const teamApi = new DropboxSign.TeamApi(); - -// Configure HTTP basic authorization: api_key -teamApi.username = "YOUR_API_KEY"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -// or, configure Bearer (JWT) authorization: oauth2 -// teamApi.accessToken = "YOUR_ACCESS_TOKEN"; +const apiCaller = new api.TeamApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const data = { - name: "New Team Name", -}; +const teamUpdateRequest = new models.TeamUpdateRequest(); +teamUpdateRequest.name = "New Team Name"; -const result = teamApi.teamUpdate(data); -result.then(response => { +apiCaller.teamUpdate( + teamUpdateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TeamApi#teamUpdate:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/TemplateApi.md b/sdks/node/docs/api/TemplateApi.md index e73e5930d..1ad876d80 100644 --- a/sdks/node/docs/api/TemplateApi.md +++ b/sdks/node/docs/api/TemplateApi.md @@ -30,56 +30,24 @@ Gives the specified Account access to the specified Template. The specified Acco ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateAddUserRequest = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateAddUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const data = { - emailAddress: "george@dropboxsign.com", -}; +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; +const templateAddUserRequest = new models.TemplateAddUserRequest(); +templateAddUserRequest.emailAddress = "george@dropboxsign.com"; -const result = templateApi.templateAddUser(templateId, data); -result.then(response => { +apiCaller.templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateAddUser:"); console.log(error.body); }); @@ -122,132 +90,99 @@ Creates a template that can then be used. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1: DropboxSign.SubTemplateRole = { - name: "Client", - order: 0, -}; - -const role2: DropboxSign.SubTemplateRole = { - name: "Witness", - order: 1, -}; - -const mergeField1: DropboxSign.SubMergeField = { - name: "Full Name", - type: DropboxSign.SubMergeField.TypeEnum.Text, -}; - -const mergeField2: DropboxSign.SubMergeField = { - name: "Is Registered?", - type: DropboxSign.SubMergeField.TypeEnum.Checkbox, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.TemplateCreateRequest = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreate(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const formFieldsPerDocument1 = new models.SubFormFieldsPerDocumentText(); +formFieldsPerDocument1.documentIndex = 0; +formFieldsPerDocument1.apiId = "uniqueIdHere_1"; +formFieldsPerDocument1.type = "text"; +formFieldsPerDocument1.required = true; +formFieldsPerDocument1.signer = "1"; +formFieldsPerDocument1.width = 100; +formFieldsPerDocument1.height = 16; +formFieldsPerDocument1.x = 112; +formFieldsPerDocument1.y = 328; +formFieldsPerDocument1.name = ""; +formFieldsPerDocument1.page = 1; +formFieldsPerDocument1.placeholder = ""; +formFieldsPerDocument1.validationType = models.SubFormFieldsPerDocumentText.ValidationTypeEnum.NumbersOnly; + +const formFieldsPerDocument2 = new models.SubFormFieldsPerDocumentSignature(); +formFieldsPerDocument2.documentIndex = 0; +formFieldsPerDocument2.apiId = "uniqueIdHere_2"; +formFieldsPerDocument2.type = "signature"; +formFieldsPerDocument2.required = true; +formFieldsPerDocument2.signer = "0"; +formFieldsPerDocument2.width = 120; +formFieldsPerDocument2.height = 30; +formFieldsPerDocument2.x = 530; +formFieldsPerDocument2.y = 415; +formFieldsPerDocument2.name = ""; +formFieldsPerDocument2.page = 1; + +const formFieldsPerDocument = [ + formFieldsPerDocument1, + formFieldsPerDocument2, +]; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const templateCreateRequest = new models.TemplateCreateRequest(); +templateCreateRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateRequest.message = "For your approval"; +templateCreateRequest.subject = "Please sign this document"; +templateCreateRequest.testMode = true; +templateCreateRequest.title = "Test Template"; +templateCreateRequest.ccRoles = [ + "Manager", +]; +templateCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateRequest.fieldOptions = fieldOptions; +templateCreateRequest.signerRoles = signerRoles; +templateCreateRequest.formFieldsPerDocument = formFieldsPerDocument; +templateCreateRequest.mergeFields = mergeFields; + +apiCaller.templateCreate( + templateCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1 = { - name: "Client", - order: 0, -}; - -const role2 = { - name: "Witness", - order: 1, -}; - -const mergeField1 = { - name: "Full Name", - type: "text", -}; - -const mergeField2 = { - name: "Is Registered?", - type: "checkbox", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateCreate:"); console.log(error.body); }); @@ -289,132 +224,65 @@ The first step in an embedded template workflow. Creates a draft template that c ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1: DropboxSign.SubTemplateRole = { - name: "Client", - order: 0, -}; - -const role2: DropboxSign.SubTemplateRole = { - name: "Witness", - order: 1, -}; - -const mergeField1: DropboxSign.SubMergeField = { - name: "Full Name", - type: DropboxSign.SubMergeField.TypeEnum.Text, -}; - -const mergeField2: DropboxSign.SubMergeField = { - name: "Is Registered?", - type: DropboxSign.SubMergeField.TypeEnum.Checkbox, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.TemplateCreateEmbeddedDraftRequest = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreateEmbeddedDraft(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const fieldOptions = new models.SubFieldOptions(); +fieldOptions.dateFormat = models.SubFieldOptions.DateFormatEnum.DD_MM_YYYY; + +const mergeFields1 = new models.SubMergeField(); +mergeFields1.name = "Full Name"; +mergeFields1.type = models.SubMergeField.TypeEnum.Text; + +const mergeFields2 = new models.SubMergeField(); +mergeFields2.name = "Is Registered?"; +mergeFields2.type = models.SubMergeField.TypeEnum.Checkbox; + +const mergeFields = [ + mergeFields1, + mergeFields2, +]; + +const signerRoles1 = new models.SubTemplateRole(); +signerRoles1.name = "Client"; +signerRoles1.order = 0; + +const signerRoles2 = new models.SubTemplateRole(); +signerRoles2.name = "Witness"; +signerRoles2.order = 1; + +const signerRoles = [ + signerRoles1, + signerRoles2, +]; + +const templateCreateEmbeddedDraftRequest = new models.TemplateCreateEmbeddedDraftRequest(); +templateCreateEmbeddedDraftRequest.clientId = "37dee8d8440c66d54cfa05d92c160882"; +templateCreateEmbeddedDraftRequest.message = "For your approval"; +templateCreateEmbeddedDraftRequest.subject = "Please sign this document"; +templateCreateEmbeddedDraftRequest.testMode = true; +templateCreateEmbeddedDraftRequest.title = "Test Template"; +templateCreateEmbeddedDraftRequest.ccRoles = [ + "Manager", +]; +templateCreateEmbeddedDraftRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +templateCreateEmbeddedDraftRequest.fieldOptions = fieldOptions; +templateCreateEmbeddedDraftRequest.mergeFields = mergeFields; +templateCreateEmbeddedDraftRequest.signerRoles = signerRoles; + +apiCaller.templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const role1 = { - name: "Client", - order: 0, -}; - -const role2 = { - name: "Witness", - order: 1, -}; - -const mergeField1 = { - name: "Full Name", - type: "text", -}; - -const mergeField2 = { - name: "Is Registered?", - type: "checkbox", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - clientId: "37dee8d8440c66d54cfa05d92c160882", - files: [fs.createReadStream("example_signature_request.pdf")], - title: "Test Template", - subject: "Please sign this document", - message: "For your approval", - signerRoles: [ - role1, - role2, - ], - ccRoles: ["Manager"], - mergeFields: [ - mergeField1, - mergeField2, - ], - fieldOptions, - testMode: true, -}; - -const result = templateApi.templateCreateEmbeddedDraft(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateCreateEmbeddedDraft:"); console.log(error.body); }); @@ -456,48 +324,18 @@ Completely deletes the template specified from the account. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateDelete(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = templateApi.templateDelete(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); +apiCaller.templateDelete( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).catch(error => { + console.log("Exception when calling TemplateApi#templateDelete:"); console.log(error.body); }); @@ -539,52 +377,21 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; -const fileType = "pdf"; - -const result = templateApi.templateFiles(templateId, fileType); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; -const fileType = "pdf"; - -const result = templateApi.templateFiles(templateId, fileType); -result.then(response => { - fs.createWriteStream('file_response.pdf').write(response.body); +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 Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateFiles:"); console.log(error.body); }); @@ -627,48 +434,20 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsDataUri(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = templateApi.templateFilesAsDataUri(templateId); -result.then(response => { +apiCaller.templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateFilesAsDataUri:"); console.log(error.body); }); @@ -710,48 +489,21 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateFilesAsFileUrl(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = templateApi.templateFilesAsFileUrl(templateId); -result.then(response => { +apiCaller.templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1, // forceDownload +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateFilesAsFileUrl:"); console.log(error.body); }); @@ -794,48 +546,20 @@ Returns the Template specified by the `template_id` parameter. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateGet(templateId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const templateId = "f57db65d3f933b5316d398057a36176831451a35"; +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const result = templateApi.templateGet(templateId); -result.then(response => { +apiCaller.templateGet( + "f57db65d3f933b5316d398057a36176831451a35", // templateId +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateGet:"); console.log(error.body); }); @@ -877,48 +601,23 @@ Returns a list of the Templates that are accessible by you. Take a look at our ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateList(accountId); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const accountId = "f57db65d3f933b5316d398057a36176831451a35"; - -const result = templateApi.templateList(accountId); -result.then(response => { +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 Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateList:"); console.log(error.body); }); @@ -963,56 +662,24 @@ Removes the specified Account\'s access to the specified Template. ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateRemoveUserRequest = { - emailAddress: "george@dropboxsign.com", -}; - -const templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - -const result = templateApi.templateRemoveUser(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const data = { - emailAddress: "george@dropboxsign.com", -}; +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; +const templateRemoveUserRequest = new models.TemplateRemoveUserRequest(); +templateRemoveUserRequest.emailAddress = "george@dropboxsign.com"; -const result = templateApi.templateRemoveUser(templateId, data); -result.then(response => { +apiCaller.templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateRemoveUser:"); console.log(error.body); }); @@ -1055,58 +722,26 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import fs from "fs"; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.TemplateUpdateFilesRequest = { - files: [fs.createReadStream("example_signature_request.pdf")], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateUpdateFiles(templateId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const templateApi = new DropboxSign.TemplateApi(); - -// Configure HTTP basic authorization: api_key -templateApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// templateApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - files: [fs.createReadStream("example_signature_request.pdf")], -}; - -const templateId = "5de8179668f2033afac48da1868d0093bf133266"; - -const result = templateApi.templateUpdateFiles(templateId, data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.TemplateApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const templateUpdateFilesRequest = new models.TemplateUpdateFilesRequest(); +templateUpdateFilesRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling TemplateApi#templateUpdateFiles:"); console.log(error.body); }); diff --git a/sdks/node/docs/api/UnclaimedDraftApi.md b/sdks/node/docs/api/UnclaimedDraftApi.md index 068a54986..330f6f4fa 100644 --- a/sdks/node/docs/api/UnclaimedDraftApi.md +++ b/sdks/node/docs/api/UnclaimedDraftApi.md @@ -23,138 +23,37 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubUnclaimedDraftSigner = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2: DropboxSign.SubUnclaimedDraftSigner = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions: DropboxSign.SubSigningOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: DropboxSign.SubSigningOptions.DefaultTypeEnum.Draw, -}; - -const fieldOptions: DropboxSign.SubFieldOptions = { - dateFormat: DropboxSign.SubFieldOptions.DateFormatEnum.DD_MM_YYYY, -}; - -const data: DropboxSign.UnclaimedDraftCreateRequest = { - subject: "The NDA we talked about", - type: DropboxSign.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature, - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ - signer1, - signer2, - ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - emailAddress: "jack@example.com", - name: "Jack", - order: 0, -}; - -const signer2 = { - emailAddress: "jill@example.com", - name: "Jill", - order: 1, -}; - -const signingOptions = { - draw: true, - type: true, - upload: true, - phone: false, - defaultType: "draw", -}; - -const fieldOptions = { - dateFormat: "DD - MM - YYYY", -}; - -const data = { - subject: "The NDA we talked about", - type: "request_signature", - message: "Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers: [ - signer1, - signer2, - ], - ccEmailAddresses: [ - "lawyer1@dropboxsign.com", - "lawyer2@example.com", - ], - files: [fs.createReadStream("example_signature_request.pdf")], - metadata: { - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signingOptions, - fieldOptions, - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreate(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const signers1 = new models.SubUnclaimedDraftSigner(); +signers1.name = "Jack"; +signers1.emailAddress = "jack@example.com"; +signers1.order = 0; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateRequest = new models.UnclaimedDraftCreateRequest(); +unclaimedDraftCreateRequest.type = models.UnclaimedDraftCreateRequest.TypeEnum.RequestSignature; +unclaimedDraftCreateRequest.testMode = true; +unclaimedDraftCreateRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; +unclaimedDraftCreateRequest.signers = signers; + +apiCaller.unclaimedDraftCreate( + unclaimedDraftCreateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate:"); console.log(error.body); }); @@ -196,60 +95,28 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; -import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.UnclaimedDraftCreateEmbeddedRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: [fs.createReadStream("example_signature_request.pdf")], - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; import * as fs from 'fs'; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - files: [fs.createReadStream("example_signature_request.pdf")], - requesterEmailAddress: "jack@dropboxsign.com", - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); -result.then(response => { +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const unclaimedDraftCreateEmbeddedRequest = new models.UnclaimedDraftCreateEmbeddedRequest(); +unclaimedDraftCreateEmbeddedRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedRequest.testMode = true; +unclaimedDraftCreateEmbeddedRequest.files = [ + fs.createReadStream("./example_signature_request.pdf"), +]; + +apiCaller.unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded:"); console.log(error.body); }); @@ -291,84 +158,47 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1: DropboxSign.SubUnclaimedDraftTemplateSigner = { - role: "Client", - name: "George", - emailAddress: "george@example.com", -}; - -const cc1: DropboxSign.SubCC = { - role: "Accounting", - emailAddress: "accounting@dropboxsign.com", -}; - -const data: DropboxSign.UnclaimedDraftCreateEmbeddedWithTemplateRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requesterEmailAddress: "jack@dropboxsign.com", - signers: [ signer1 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const signer1 = { - role: "Client", - name: "George", - emailAddress: "george@example.com", -}; - -const cc1 = { - role: "Accounting", - emailAddress: "accounting@dropboxsign.com", -}; - -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - templateIds: ["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requesterEmailAddress: "jack@dropboxsign.com", - signers: [ signer1 ], - ccs: [ cc1 ], - testMode: true, -}; - -const result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); -result.then(response => { +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" + +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; + +const ccs1 = new models.SubCC(); +ccs1.role = "Accounting"; +ccs1.emailAddress = "accounting@dropboxsign.com"; + +const ccs = [ + ccs1, +]; + +const signers1 = new models.SubUnclaimedDraftTemplateSigner(); +signers1.role = "Client"; +signers1.name = "George"; +signers1.emailAddress = "george@example.com"; + +const signers = [ + signers1, +]; + +const unclaimedDraftCreateEmbeddedWithTemplateRequest = new models.UnclaimedDraftCreateEmbeddedWithTemplateRequest(); +unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress = "jack@dropboxsign.com"; +unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds = [ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", +]; +unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode = false; +unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs = ccs; +unclaimedDraftCreateEmbeddedWithTemplateRequest.signers = signers; + +apiCaller.unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate:"); console.log(error.body); }); @@ -410,58 +240,25 @@ Creates a new signature request from an embedded request that can be edited prio ### TypeScript Example ```typescript -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; - -const data: DropboxSign.UnclaimedDraftEditAndResendRequest = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - testMode: true, -}; - -const signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - -const result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); -result.then(response => { - console.log(response.body); -}).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); - console.log(error.body); -}); - -``` - -### JavaScript Example - -```javascript -import * as DropboxSign from "@dropbox/sign"; - -const unclaimedDraftApi = new DropboxSign.UnclaimedDraftApi(); - -// Configure HTTP basic authorization: api_key -unclaimedDraftApi.username = "YOUR_API_KEY"; - -// or, configure Bearer (JWT) authorization: oauth2 -// unclaimedDraftApi.accessToken = "YOUR_ACCESS_TOKEN"; +import * as fs from 'fs'; +import api from "@dropbox/sign" +import models from "@dropbox/sign" -const data = { - clientId: "ec64a202072370a737edf4a0eb7f4437", - testMode: true, -}; +const apiCaller = new api.UnclaimedDraftApi(); +apiCaller.username = "YOUR_API_KEY"; +// apiCaller.accessToken = "YOUR_ACCESS_TOKEN"; -const signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; +const unclaimedDraftEditAndResendRequest = new models.UnclaimedDraftEditAndResendRequest(); +unclaimedDraftEditAndResendRequest.clientId = "b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"; +unclaimedDraftEditAndResendRequest.testMode = false; -const result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); -result.then(response => { +apiCaller.unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest, +).then(response => { console.log(response.body); }).catch(error => { - console.log("Exception when calling Dropbox Sign API:"); + console.log("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend:"); console.log(error.body); }); diff --git a/sdks/node/openapi-config.yaml b/sdks/node/openapi-config.yaml index 130c3ace0..e7dabc881 100644 --- a/sdks/node/openapi-config.yaml +++ b/sdks/node/openapi-config.yaml @@ -9,6 +9,10 @@ additionalProperties: sortModelPropertiesByRequiredFlag: true useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.npmName: "@dropbox/sign-sandbox" + oseg.printApiCallProperty: true + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-npmignore: templateType: SupportingFiles diff --git a/sdks/node/templates/dropbox-README.mustache b/sdks/node/templates/dropbox-README.mustache index de052d20b..828b0ec46 100644 --- a/sdks/node/templates/dropbox-README.mustache +++ b/sdks/node/templates/dropbox-README.mustache @@ -56,12 +56,6 @@ REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_TypeScript_CODE ``` -### JavaScript Example - -```javascript -REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_JavaScript_CODE -``` - {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}} ## API Endpoints diff --git a/sdks/node/templates/dropbox-api-doc.mustache b/sdks/node/templates/dropbox-api-doc.mustache index b85a3ea2f..432d2afc4 100644 --- a/sdks/node/templates/dropbox-api-doc.mustache +++ b/sdks/node/templates/dropbox-api-doc.mustache @@ -25,12 +25,6 @@ All URIs are relative to {{basePath}}. REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_TypeScript_CODE ``` -### JavaScript Example - -```javascript -REPLACE_ME_WITH_EXAMPLE_FOR__{{{operationId}}}_JavaScript_CODE -``` - ### Parameters {{#vendorExtensions.x-group-parameters}} diff --git a/sdks/php/README.md b/sdks/php/README.md index c2c3feb33..26a9ce8b7 100644 --- a/sdks/php/README.md +++ b/sdks/php/README.md @@ -75,28 +75,28 @@ Please follow the [installation procedure](#installation--usage) and then run th ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com"); try { - $result = $accountApi->accountCreate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/AccountApi.md b/sdks/php/docs/Api/AccountApi.md index 9c8e8c9f0..6d0f700ef 100644 --- a/sdks/php/docs/Api/AccountApi.md +++ b/sdks/php/docs/Api/AccountApi.md @@ -24,28 +24,28 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountCreateRequest(); -$data->setEmailAddress("newuser@dropboxsign.com"); +$account_create_request = (new Dropbox\Sign\Model\AccountCreateRequest()) + ->setEmailAddress("newuser@dropboxsign.com"); try { - $result = $accountApi->accountCreate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountCreate( + account_create_request: $account_create_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling AccountApi#accountCreate: {$e->getMessage()}"; } ``` @@ -87,25 +87,23 @@ Returns the properties and settings of your Account. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - try { - $result = $accountApi->accountGet(null, 'jack@example.com'); - print_r($result); + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountGet(); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling AccountApi#accountGet: {$e->getMessage()}"; } ``` @@ -148,28 +146,29 @@ Updates the properties and settings of your Account. Currently only allows for u ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountUpdateRequest(); -$data->setCallbackUrl("https://www.example.com/callback"); +$account_update_request = (new Dropbox\Sign\Model\AccountUpdateRequest()) + ->setCallbackUrl("https://www.example.com/callback") + ->setLocale("en-US"); try { - $result = $accountApi->accountUpdate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountUpdate( + account_update_request: $account_update_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling AccountApi#accountUpdate: {$e->getMessage()}"; } ``` @@ -211,28 +210,28 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$accountApi = new Dropbox\Sign\Api\AccountApi($config); - -$data = new Dropbox\Sign\Model\AccountVerifyRequest(); -$data->setEmailAddress("some_user@dropboxsign.com"); +$account_verify_request = (new Dropbox\Sign\Model\AccountVerifyRequest()) + ->setEmailAddress("some_user@dropboxsign.com"); try { - $result = $accountApi->accountVerify($data); - print_r($result); + $response = (new Dropbox\Sign\Api\AccountApi(config: $config))->accountVerify( + account_verify_request: $account_verify_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling AccountApi#accountVerify: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/ApiAppApi.md b/sdks/php/docs/Api/ApiAppApi.md index 45604a821..eb5e933ca 100644 --- a/sdks/php/docs/Api/ApiAppApi.md +++ b/sdks/php/docs/Api/ApiAppApi.md @@ -25,45 +25,45 @@ Creates a new API App. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$oauth = new Dropbox\Sign\Model\SubOAuth(); -$oauth->setCallbackUrl("https://example.com/oauth") +$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, ]); -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") ->setPrimaryButtonTextColor("#ffffff"); -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppCreateRequest(); -$data->setName("My Production App") - ->setDomains(["example.com"]) +$api_app_create_request = (new Dropbox\Sign\Model\ApiAppCreateRequest()) + ->setName("My Production App") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) ->setOauth($oauth) - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); + ->setWhiteLabelingOptions($white_labeling_options); try { - $result = $apiAppApi->apiAppCreate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling ApiAppApi#apiAppCreate: {$e->getMessage()}"; } ``` @@ -105,26 +105,23 @@ Deletes an API App. Can only be invoked for apps you own. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - try { - $apiAppApi->apiAppDelete($clientId); + (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppDelete( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling ApiAppApi#apiAppDelete: {$e->getMessage()}"; } ``` @@ -166,27 +163,25 @@ Returns an object with information about an API App. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - try { - $result = $apiAppApi->apiAppGet($clientId); - print_r($result); + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppGet( + client_id: "0dd3b823a682527788c4e40cb7b6f7e9", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling ApiAppApi#apiAppGet: {$e->getMessage()}"; } ``` @@ -228,28 +223,26 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); - -$page = 1; -$pageSize = 2; - try { - $result = $apiAppApi->apiAppList($page, $pageSize); - print_r($result); + $response = (new Dropbox\Sign\Api\ApiAppApi(config: $config))->apiAppList( + page: 1, + page_size: 20, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling ApiAppApi#apiAppList: {$e->getMessage()}"; } ``` @@ -292,39 +285,47 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$apiAppApi = new Dropbox\Sign\Api\ApiAppApi($config); +$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, + ]); -$whiteLabelingOptions = new Dropbox\Sign\Model\SubWhiteLabelingOptions(); -$whiteLabelingOptions->setPrimaryButtonColor("#00b3e6") +$white_labeling_options = (new Dropbox\Sign\Model\SubWhiteLabelingOptions()) + ->setPrimaryButtonColor("#00b3e6") ->setPrimaryButtonTextColor("#ffffff"); -$customLogoFile = new SplFileObject(__DIR__ . "/CustomLogoFile.png"); - -$data = new Dropbox\Sign\Model\ApiAppUpdateRequest(); -$data->setName("New Name") +$api_app_update_request = (new Dropbox\Sign\Model\ApiAppUpdateRequest()) ->setCallbackUrl("https://example.com/dropboxsign") - ->setWhiteLabelingOptions($whiteLabelingOptions) - ->setCustomLogoFile($customLogoFile); - -$clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; + ->setName("New Name") + ->setDomains([ + "example.com", + ]) + ->setCustomLogoFile(new SplFileObject("CustomLogoFile.png")) + ->setOauth($oauth) + ->setWhiteLabelingOptions($white_labeling_options); try { - $result = $apiAppApi->apiAppUpdate($clientId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling ApiAppApi#apiAppUpdate: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/BulkSendJobApi.md b/sdks/php/docs/Api/BulkSendJobApi.md index ede4f3415..a58d6349b 100644 --- a/sdks/php/docs/Api/BulkSendJobApi.md +++ b/sdks/php/docs/Api/BulkSendJobApi.md @@ -22,27 +22,27 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - try { - $result = $bulkSendJobApi->bulkSendJobGet($bulkSendJobId); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling BulkSendJobApi#bulkSendJobGet: {$e->getMessage()}"; } ``` @@ -86,28 +86,26 @@ Returns a list of BulkSendJob that you can access. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$bulkSendJobApi = new Dropbox\Sign\Api\BulkSendJobApi($config); - -$page = 1; -$pageSize = 20; - try { - $result = $bulkSendJobApi->bulkSendJobList($page, $pageSize); - print_r($result); + $response = (new Dropbox\Sign\Api\BulkSendJobApi(config: $config))->bulkSendJobList( + page: 1, + page_size: 20, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling BulkSendJobApi#bulkSendJobList: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/EmbeddedApi.md b/sdks/php/docs/Api/EmbeddedApi.md index 8b1acfbc4..c186d9420 100644 --- a/sdks/php/docs/Api/EmbeddedApi.md +++ b/sdks/php/docs/Api/EmbeddedApi.md @@ -22,31 +22,35 @@ Retrieves an embedded object containing a template url that can be opened in an ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); +$merge_fields = [ +]; -$data = new Dropbox\Sign\Model\EmbeddedEditUrlRequest(); -$data->setCcRoles([""]) - ->setMergeFields([]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; +$embedded_edit_url_request = (new Dropbox\Sign\Model\EmbeddedEditUrlRequest()) + ->setCcRoles([ + "", + ]) + ->setMergeFields($merge_fields); try { - $result = $embeddedApi->embeddedEditUrl($templateId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling EmbeddedApi#embeddedEditUrl: {$e->getMessage()}"; } ``` @@ -89,27 +93,25 @@ Retrieves an embedded object containing a signature url that can be opened in an ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$embeddedApi = new Dropbox\Sign\Api\EmbeddedApi($config); - -$signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - try { - $result = $embeddedApi->embeddedSignUrl($signatureId); - print_r($result); + $response = (new Dropbox\Sign\Api\EmbeddedApi(config: $config))->embeddedSignUrl( + signature_id: "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling EmbeddedApi#embeddedSignUrl: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/FaxApi.md b/sdks/php/docs/Api/FaxApi.md index 85450d672..aeb7a3949 100644 --- a/sdks/php/docs/Api/FaxApi.md +++ b/sdks/php/docs/Api/FaxApi.md @@ -25,21 +25,22 @@ Deletes the specified Fax from the system ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxApi = new Dropbox\Sign\Api\FaxApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $faxApi->faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); + (new Dropbox\Sign\Api\FaxApi(config: $config))->faxDelete( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxApi#faxDelete: {$e->getMessage()}"; } ``` @@ -81,24 +82,24 @@ Downloads files associated with a Fax ```php setUsername("YOUR_API_KEY"); +require_once __DIR__ . '/../vendor/autoload.php'; -$faxApi = new Dropbox\Sign\Api\FaxApi($config); +use SplFileObject; +use Dropbox; -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $result = $faxApi->faxFiles($faxId); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxFiles( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxApi#faxFiles: {$e->getMessage()}"; } ``` @@ -140,24 +141,24 @@ Returns information about a Fax ```php setUsername("YOUR_API_KEY"); +require_once __DIR__ . '/../vendor/autoload.php'; -$faxApi = new Dropbox\Sign\Api\FaxApi($config); +use SplFileObject; +use Dropbox; -$faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $result = $faxApi->faxGet($faxId); - print_r($result); + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxGet( + fax_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxApi#faxGet: {$e->getMessage()}"; } ``` @@ -199,25 +200,25 @@ Returns properties of multiple Faxes ```php setUsername("YOUR_API_KEY"); +require_once __DIR__ . '/../vendor/autoload.php'; -$faxApi = new Dropbox\Sign\Api\FaxApi($config); +use SplFileObject; +use Dropbox; -$page = 1; -$pageSize = 2; +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $result = $faxApi->faxList($page, $pageSize); - print_r($result); + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxList( + page: 1, + page_size: 20, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxApi#faxList: {$e->getMessage()}"; } ``` @@ -260,32 +261,35 @@ Creates and sends a new Fax with the submitted file(s) ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxApi = new Dropbox\Sign\Api\FaxApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); -$data = new Dropbox\Sign\Model\FaxSendRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTestMode(true) +$fax_send_request = (new Dropbox\Sign\Model\FaxSendRequest()) ->setRecipient("16690000001") ->setSender("16690000000") + ->setTestMode(true) ->setCoverPageTo("Jill Fax") - ->setCoverPageMessage("I'm sending you a fax!") ->setCoverPageFrom("Faxer Faxerson") - ->setTitle("This is what the fax is about!"); + ->setCoverPageMessage("I'm sending you a fax!") + ->setTitle("This is what the fax is about!") + ->setFiles([ + ]); try { - $result = $faxApi->faxSend($data); - print_r($result); + $response = (new Dropbox\Sign\Api\FaxApi(config: $config))->faxSend( + fax_send_request: $fax_send_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxApi#faxSend: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/FaxLineApi.md b/sdks/php/docs/Api/FaxLineApi.md index eb8df874f..234a18e69 100644 --- a/sdks/php/docs/Api/FaxLineApi.md +++ b/sdks/php/docs/Api/FaxLineApi.md @@ -27,26 +27,28 @@ Grants a user access to the specified Fax Line. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); -$data = new Dropbox\Sign\Model\FaxLineAddUserRequest(); -$data->setNumber("[FAX_NUMBER]") +$fax_line_add_user_request = (new Dropbox\Sign\Model\FaxLineAddUserRequest()) + ->setNumber("[FAX_NUMBER]") ->setEmailAddress("member@dropboxsign.com"); try { - $result = $faxLineApi->faxLineAddUser($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineAddUser: {$e->getMessage()}"; } ``` @@ -88,22 +90,27 @@ Returns a list of available area codes for a given state/province and city ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $result = $faxLineApi->faxLineAreaCodeGet("US", "CA"); - print_r($result); + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineAreaCodeGet( + country: "US", + state: null, + province: null, + city: null, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineAreaCodeGet: {$e->getMessage()}"; } ``` @@ -148,26 +155,28 @@ Purchases a new Fax Line ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); -$data = new Dropbox\Sign\Model\FaxLineCreateRequest(); -$data->setAreaCode(209) - ->setCountry("US"); +$fax_line_create_request = (new Dropbox\Sign\Model\FaxLineCreateRequest()) + ->setAreaCode(209) + ->setCountry(Dropbox\Sign\Model\FaxLineCreateRequest::COUNTRY_US); try { - $result = $faxLineApi->faxLineCreate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineCreate: {$e->getMessage()}"; } ``` @@ -209,24 +218,25 @@ Deletes the specified Fax Line from the subscription. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); -$data = new Dropbox\Sign\Model\FaxLineDeleteRequest(); -$data->setNumber("[FAX_NUMBER]"); +$fax_line_delete_request = (new Dropbox\Sign\Model\FaxLineDeleteRequest()) + ->setNumber("[FAX_NUMBER]"); try { - $faxLineApi->faxLineDelete($data); + (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineDelete( + fax_line_delete_request: $fax_line_delete_request, + ); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineDelete: {$e->getMessage()}"; } ``` @@ -268,22 +278,24 @@ Returns the properties and settings of a Fax Line. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $result = $faxLineApi->faxLineGet("[FAX_NUMBER]"); - print_r($result); + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineGet( + number: "123-123-1234", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineGet: {$e->getMessage()}"; } ``` @@ -325,22 +337,27 @@ Returns the properties and settings of multiple Fax Lines. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $result = $faxLineApi->faxLineList(); - print_r($result); + $response = (new Dropbox\Sign\Api\FaxLineApi(config: $config))->faxLineList( + account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page: 1, + page_size: 20, + show_team_lines: null, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineList: {$e->getMessage()}"; } ``` @@ -385,26 +402,28 @@ Removes a user's access to the specified Fax Line ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$faxLineApi = new Dropbox\Sign\Api\FaxLineApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); -$data = new Dropbox\Sign\Model\FaxLineRemoveUserRequest(); -$data->setNumber("[FAX_NUMBER]") +$fax_line_remove_user_request = (new Dropbox\Sign\Model\FaxLineRemoveUserRequest()) + ->setNumber("[FAX_NUMBER]") ->setEmailAddress("member@dropboxsign.com"); try { - $result = $faxLineApi->faxLineRemoveUser($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling FaxLineApi#faxLineRemoveUser: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/OAuthApi.md b/sdks/php/docs/Api/OAuthApi.md index 854b4b7a0..398664ffb 100644 --- a/sdks/php/docs/Api/OAuthApi.md +++ b/sdks/php/docs/Api/OAuthApi.md @@ -22,25 +22,30 @@ Once you have retrieved the code from the user callback, you will need to exchan ```php setState("900e06e2") - ->setCode("1b0d28d90c86c141") +use SplFileObject; +use Dropbox; + +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); + +$o_auth_token_generate_request = (new Dropbox\Sign\Model\OAuthTokenGenerateRequest()) ->setClientId("cc91c61d00f8bb2ece1428035716b") - ->setClientSecret("1d14434088507ffa390e6f5528465"); + ->setClientSecret("1d14434088507ffa390e6f5528465") + ->setCode("1b0d28d90c86c141") + ->setState("900e06e2") + ->setGrantType("authorization_code"); try { - $result = $oauthApi->oauthTokenGenerate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling OAuthApi#oauthTokenGenerate: {$e->getMessage()}"; } ``` @@ -82,22 +87,27 @@ Access tokens are only valid for a given period of time (typically one hour) for ```php setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); + +$o_auth_token_refresh_request = (new Dropbox\Sign\Model\OAuthTokenRefreshRequest()) + ->setGrantType("refresh_token") + ->setRefreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); try { - $result = $oauthApi->oauthTokenRefresh($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling OAuthApi#oauthTokenRefresh: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/ReportApi.md b/sdks/php/docs/Api/ReportApi.md index 285a20e83..2609a12d9 100644 --- a/sdks/php/docs/Api/ReportApi.md +++ b/sdks/php/docs/Api/ReportApi.md @@ -21,17 +21,18 @@ Request the creation of one or more report(s). When the report(s) have been gen ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -$reportApi = new Dropbox\Sign\Api\ReportApi($config); +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); -$data = new Dropbox\Sign\Model\ReportCreateRequest(); -$data->setStartDate("09/01/2020") +$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, @@ -39,12 +40,13 @@ $data->setStartDate("09/01/2020") ]); try { - $result = $reportApi->reportCreate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\ReportApi(config: $config))->reportCreate( + report_create_request: $report_create_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling ReportApi#reportCreate: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/SignatureRequestApi.md b/sdks/php/docs/Api/SignatureRequestApi.md index 7fa0c8108..7f1c6ec49 100644 --- a/sdks/php/docs/Api/SignatureRequestApi.md +++ b/sdks/php/docs/Api/SignatureRequestApi.md @@ -40,63 +40,92 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ```php setUsername("YOUR_API_KEY"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$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, +]; -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") +$signer_list_1_signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") ->setName("George") ->setEmailAddress("george@example.com") ->setPin("d79a3td"); -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); - -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") ->setEmailAddress("accounting@example.com"); -$data = new Dropbox\Sign\Model\SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); -$data->setClientId("1a659d9ad95bccd307ecad78d72192f8") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") +$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.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); try { - $result = $signatureRequestApi->signatureRequestBulkCreateEmbeddedWithTemplate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate: {$e->getMessage()}"; } ``` @@ -138,65 +167,92 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$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, +]; -$signerList1Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList1Signer->setRole("Client") +$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"); -$signerList1CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList1CustomFields->setName("company") - ->setValue("ABC Corp"); +$signer_list_1_signers = [ + $signer_list_1_signers_1, +]; -$signerList1 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList1->setSigners([$signerList1Signer]) - ->setCustomFields([$signerList1CustomFields]); +$signer_list_1 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_1_custom_fields) + ->setSigners($signer_list_1_signers); -$signerList2Signer = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signerList2Signer->setRole("Client") - ->setName("Mary") - ->setEmailAddress("mary@example.com") - ->setPin("gd9as5b"); +$signer_list_2 = (new Dropbox\Sign\Model\SubBulkSignerList()) + ->setCustomFields($signer_list_2_custom_fields) + ->setSigners($signer_list_2_signers); -$signerList2CustomFields = new Dropbox\Sign\Model\SubBulkSignerListCustomField(); -$signerList2CustomFields->setName("company") - ->setValue("123 LLC"); - -$signerList2 = new Dropbox\Sign\Model\SubBulkSignerList(); -$signerList2->setSigners([$signerList2Signer]) - ->setCustomFields([$signerList2CustomFields]); +$signer_list = [ + $signer_list_1, + $signer_list_2, +]; -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") ->setEmailAddress("accounting@example.com"); -$data = new Dropbox\Sign\Model\SignatureRequestBulkSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") +$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.") - ->setSignerList([$signerList1, $signerList2]) - ->setCcs([$cc1]) - ->setTestMode(true); + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSignerList($signer_list) + ->setCcs($ccs); try { - $result = $signatureRequestApi->signatureRequestBulkSendWithTemplate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate: {$e->getMessage()}"; } ``` @@ -238,26 +294,23 @@ Cancels an incomplete signature request. This action is **not reversible**. The ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - $signatureRequestApi->signatureRequestCancel($signatureRequestId); + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestCancel( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestCancel: {$e->getMessage()}"; } ``` @@ -299,56 +352,62 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") + ->setEmailAddress("jack@example.com") ->setOrder(0); -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jill") + ->setEmailAddress("jill@example.com") ->setOrder(1); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$signers = [ + $signers_1, + $signers_2, +]; -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") +$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") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") ->setCcEmailAddresses([ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); try { - $result = $signatureRequestApi->signatureRequestCreateEmbedded($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded: {$e->getMessage()}"; } ``` @@ -390,46 +449,52 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$signers = [ + $signers_1, +]; -$data = new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") +$signature_request_create_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); try { - $result = $signatureRequestApi->signatureRequestCreateEmbeddedWithTemplate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate: {$e->getMessage()}"; } ``` @@ -471,65 +536,72 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$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); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") + ->setEmailAddress("jack@example.com") ->setOrder(0); -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jill") + ->setEmailAddress("jill@example.com") ->setOrder(1); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$signers = [ + $signers_1, + $signers_2, +]; -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\SignatureRequestEditRequest(); -$data->setTitle("NDA with Acme Co.") +$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") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") ->setCcEmailAddresses([ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", + ->setFiles([ ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); try { - $result = $signatureRequestApi->signatureRequestEdit($signatureRequestId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestEdit: {$e->getMessage()}"; } ``` @@ -572,61 +644,63 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jack") + ->setEmailAddress("jack@example.com") ->setOrder(0); -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jill") + ->setEmailAddress("jill@example.com") ->setOrder(1); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(true) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$signers = [ + $signers_1, + $signers_2, +]; -$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTitle("NDA with Acme Co.") +$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") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") ->setCcEmailAddresses([ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + ->setFiles([ + ]) + ->setSigningOptions($signing_options) + ->setSigners($signers); try { - $result = $signatureRequestApi->signatureRequestEditEmbedded( - $signatureRequestId, - $data + $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($result); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbedded: {$e->getMessage()}"; } ``` @@ -669,51 +743,53 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$signers = [ + $signers_1, +]; -$data = new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") +$signature_request_edit_embedded_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTemplateIds([ + "c26b8a16784a872da37ea946b9ddec7c1e11dff6", + ]) ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers); try { - $result = $signatureRequestApi->signatureRequestEditEmbeddedWithTemplate( - $signatureRequestId, - $data + $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($result); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate: {$e->getMessage()}"; } ``` @@ -756,59 +832,72 @@ Edits and sends a SignatureRequest based off of the Template(s) specified with t ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") +$signers = [ + $signers_1, +]; + +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") ->setEmailAddress("accounting@example.com"); -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") ->setEditor("Client") - ->setRequired(true); + ->setRequired(true) + ->setValue('$20,000'); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$custom_fields = [ + $custom_fields_1, +]; -$data = new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") +$signature_request_edit_with_template_request = (new Dropbox\Sign\Model\SignatureRequestEditWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); try { - $result = $signatureRequestApi->signatureRequestEditWithTemplate($signatureRequestId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate: {$e->getMessage()}"; } ``` @@ -851,28 +940,26 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; -$fileType = "pdf"; - try { - $result = $signatureRequestApi->signatureRequestFiles($signatureRequestId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestFiles: {$e->getMessage()}"; } ``` @@ -915,27 +1002,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - try { - $result = $signatureRequestApi->signatureRequestFilesAsDataUri($signatureRequestId); - print_r($result); + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsDataUri( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri: {$e->getMessage()}"; } ``` @@ -977,27 +1062,26 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - try { - $result = $signatureRequestApi->signatureRequestFilesAsFileUrl($signatureRequestId); - print_r($result); + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestFilesAsFileUrl( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + force_download: 1, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl: {$e->getMessage()}"; } ``` @@ -1040,27 +1124,25 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - try { - $result = $signatureRequestApi->signatureRequestGet($signatureRequestId); - print_r($result); + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestGet( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestGet: {$e->getMessage()}"; } ``` @@ -1102,28 +1184,28 @@ Returns a list of SignatureRequests that you can access. This includes Signature ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$accountId = null; -$page = 1; - try { - $result = $signatureRequestApi->signatureRequestList($accountId, $page); - print_r($result); + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}"; } ``` @@ -1168,27 +1250,25 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - try { - $result = $signatureRequestApi->signatureRequestReleaseHold($signatureRequestId); - print_r($result); + $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestReleaseHold( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestReleaseHold: {$e->getMessage()}"; } ``` @@ -1230,30 +1310,29 @@ Sends an email to the signer reminding them to sign the signature request. You c ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestRemindRequest(); -$data->setEmailAddress("john@example.com"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +$signature_request_remind_request = (new Dropbox\Sign\Model\SignatureRequestRemindRequest()) + ->setEmailAddress("john@example.com"); try { - $result = $signatureRequestApi->signatureRequestRemind($signatureRequestId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestRemind: {$e->getMessage()}"; } ``` @@ -1296,23 +1375,22 @@ Removes your access to a completed signature request. This action is **not rever ```php setUsername("YOUR_API_KEY"); +require_once __DIR__ . '/../vendor/autoload.php'; -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +use SplFileObject; +use Dropbox; -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); try { - $signatureRequestApi->signatureRequestRemove($signatureRequestId); + (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestRemove( + signature_request_id: "fa5c8a0b0f492d768749333ad6fcc214c111e967", + ); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestRemove: {$e->getMessage()}"; } ``` @@ -1354,63 +1432,71 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer1->setEmailAddress("jack@example.com") +$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); -$signer2 = new Dropbox\Sign\Model\SubSignatureRequestSigner(); -$signer2->setEmailAddress("jill@example.com") +$signers_2 = (new Dropbox\Sign\Model\SubSignatureRequestSigner()) ->setName("Jill") + ->setEmailAddress("jill@example.com") ->setOrder(1); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); - -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); +$signers = [ + $signers_1, + $signers_2, +]; -$data = new Dropbox\Sign\Model\SignatureRequestSendRequest(); -$data->setTitle("NDA with Acme Co.") +$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") - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) + ->setTestMode(true) + ->setTitle("NDA with Acme Co.") ->setCcEmailAddresses([ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", + ->setFiles([ ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); + ->setMetadata(json_decode(<<<'EOD' + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + EOD, true)) + ->setFieldOptions($field_options) + ->setSigningOptions($signing_options) + ->setSigners($signers); try { - $result = $signatureRequestApi->signatureRequestSend($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestSend: {$e->getMessage()}"; } ``` @@ -1452,57 +1538,71 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); +$signing_options = (new Dropbox\Sign\Model\SubSigningOptions()) + ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW) + ->setDraw(true) + ->setPhone(false) + ->setType(true) + ->setUpload(true); -$signer1 = new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner(); -$signer1->setRole("Client") - ->setEmailAddress("george@example.com") - ->setName("George"); +$signers_1 = (new Dropbox\Sign\Model\SubSignatureRequestTemplateSigner()) + ->setRole("Client") + ->setName("George") + ->setEmailAddress("george@example.com"); + +$signers = [ + $signers_1, +]; -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") ->setEmailAddress("accounting@example.com"); -$customField1 = new Dropbox\Sign\Model\SubCustomField(); -$customField1->setName("Cost") - ->setValue("$20,000") +$ccs = [ + $ccs_1, +]; + +$custom_fields_1 = (new Dropbox\Sign\Model\SubCustomField()) + ->setName("Cost") ->setEditor("Client") - ->setRequired(true); + ->setRequired(true) + ->setValue('$20,000'); -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$custom_fields = [ + $custom_fields_1, +]; -$data = new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest(); -$data->setTemplateIds(["c26b8a16784a872da37ea946b9ddec7c1e11dff6"]) - ->setSubject("Purchase Order") +$signature_request_send_with_template_request = (new Dropbox\Sign\Model\SignatureRequestSendWithTemplateRequest()) + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) ->setMessage("Glad we could come to an agreement.") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setCustomFields([$customField1]) - ->setSigningOptions($signingOptions) - ->setTestMode(true); + ->setSubject("Purchase Order") + ->setTestMode(true) + ->setSigningOptions($signing_options) + ->setSigners($signers) + ->setCcs($ccs) + ->setCustomFields($custom_fields); try { - $result = $signatureRequestApi->signatureRequestSendWithTemplate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate: {$e->getMessage()}"; } ``` @@ -1544,31 +1644,30 @@ Updates the email address and/or the name for a given signer on a signature requ ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$signatureRequestApi = new Dropbox\Sign\Api\SignatureRequestApi($config); - -$data = new Dropbox\Sign\Model\SignatureRequestUpdateRequest(); -$data->setEmailAddress("john@example.com") - ->setSignatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - -$signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +$signature_request_update_request = (new Dropbox\Sign\Model\SignatureRequestUpdateRequest()) + ->setSignatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f") + ->setEmailAddress("john@example.com"); try { - $result = $signatureRequestApi->signatureRequestUpdate($signatureRequestId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling SignatureRequestApi#signatureRequestUpdate: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/TeamApi.md b/sdks/php/docs/Api/TeamApi.md index 1f46c6b3f..059036e13 100644 --- a/sdks/php/docs/Api/TeamApi.md +++ b/sdks/php/docs/Api/TeamApi.md @@ -30,28 +30,29 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamAddMemberRequest(); -$data->setEmailAddress("george@example.com"); +$team_add_member_request = (new Dropbox\Sign\Model\TeamAddMemberRequest()) + ->setEmailAddress("george@example.com"); try { - $result = $teamApi->teamAddMember($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamAddMember: {$e->getMessage()}"; } ``` @@ -94,28 +95,28 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamCreateRequest(); -$data->setName("New Team Name"); +$team_create_request = (new Dropbox\Sign\Model\TeamCreateRequest()) + ->setName("New Team Name"); try { - $result = $teamApi->teamCreate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamCreate( + team_create_request: $team_create_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamCreate: {$e->getMessage()}"; } ``` @@ -157,24 +158,21 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - try { - $teamApi->teamDelete(); + (new Dropbox\Sign\Api\TeamApi(config: $config))->teamDelete(); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamDelete: {$e->getMessage()}"; } ``` @@ -214,25 +212,23 @@ Returns information about your Team as well as a list of its members. If you do ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - try { - $result = $teamApi->teamGet(); - print_r($result); + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamGet(); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamGet: {$e->getMessage()}"; } ``` @@ -272,25 +268,25 @@ Provides information about a team. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - try { - $result = $teamApi->teamInfo(); - print_r($result); + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInfo( + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamInfo: {$e->getMessage()}"; } ``` @@ -332,27 +328,23 @@ Provides a list of team invites (and their roles). ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$emailAddress = "user@dropboxsign.com"; - try { - $result = $teamApi->teamInvites($emailAddress); - print_r($result); + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamInvites(); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamInvites: {$e->getMessage()}"; } ``` @@ -394,27 +386,27 @@ Provides a paginated list of members (and their roles) that belong to a given te ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - try { - $result = $teamApi->teamMembers($teamId); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamMembers: {$e->getMessage()}"; } ``` @@ -458,29 +450,29 @@ Removes the provided user Account from your Team. If the Account had an outstand ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamRemoveMemberRequest(); -$data->setEmailAddress("teammate@dropboxsign.com") +$team_remove_member_request = (new Dropbox\Sign\Model\TeamRemoveMemberRequest()) + ->setEmailAddress("teammate@dropboxsign.com") ->setNewOwnerEmailAddress("new_teammate@dropboxsign.com"); try { - $result = $teamApi->teamRemoveMember($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamRemoveMember: {$e->getMessage()}"; } ``` @@ -522,27 +514,27 @@ Provides a paginated list of sub teams that belong to a given team. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - try { - $result = $teamApi->teamSubTeams($teamId); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamSubTeams: {$e->getMessage()}"; } ``` @@ -586,28 +578,28 @@ Updates the name of your Team. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$teamApi = new Dropbox\Sign\Api\TeamApi($config); - -$data = new Dropbox\Sign\Model\TeamUpdateRequest(); -$data->setName("New Team Name"); +$team_update_request = (new Dropbox\Sign\Model\TeamUpdateRequest()) + ->setName("New Team Name"); try { - $result = $teamApi->teamUpdate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\TeamApi(config: $config))->teamUpdate( + team_update_request: $team_update_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TeamApi#teamUpdate: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/TemplateApi.md b/sdks/php/docs/Api/TemplateApi.md index 5381a8290..296d8394f 100644 --- a/sdks/php/docs/Api/TemplateApi.md +++ b/sdks/php/docs/Api/TemplateApi.md @@ -31,30 +31,29 @@ Gives the specified Account access to the specified Template. The specified Acco ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateAddUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; +$template_add_user_request = (new Dropbox\Sign\Model\TemplateAddUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); try { - $result = $templateApi->templateAddUser($templateId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateAddUser: {$e->getMessage()}"; } ``` @@ -97,56 +96,103 @@ Creates a template that can then be used. ```php setUsername('YOUR_API_KEY'); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName('Client') +$signer_roles_1 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Client") ->setOrder(0); -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName('Witness') +$signer_roles_2 = (new Dropbox\Sign\Model\SubTemplateRole()) + ->setName("Witness") ->setOrder(1); -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName('Full Name') +$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); -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName('Is Registered?') +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\TemplateCreateRequest(); -$data->setClientId('37dee8d8440c66d54cfa05d92c160882') - ->setFiles([new SplFileObject(__DIR__ . '/example_signature_request.pdf')]) - ->setTitle('Test Template') - ->setSubject('Please sign this document') - ->setMessage('For your approval') - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(['Manager']) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); +$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 { - $result = $templateApi->templateCreate($data); - print_r($result); + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateCreate( + template_create_request: $template_create_request, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo 'Exception when calling Dropbox Sign API: ' - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateCreate: {$e->getMessage()}"; } ``` @@ -188,56 +234,69 @@ The first step in an embedded template workflow. Creates a draft template that c ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$role1 = new Dropbox\Sign\Model\SubTemplateRole(); -$role1->setName("Client") - ->setOrder(0); - -$role2 = new Dropbox\Sign\Model\SubTemplateRole(); -$role2->setName("Witness") - ->setOrder(1); +$field_options = (new Dropbox\Sign\Model\SubFieldOptions()) + ->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); -$mergeField1 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField1->setName("Full Name") +$merge_fields_1 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Full Name") ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_TEXT); -$mergeField2 = new Dropbox\Sign\Model\SubMergeField(); -$mergeField2->setName("Is Registered?") +$merge_fields_2 = (new Dropbox\Sign\Model\SubMergeField()) + ->setName("Is Registered?") ->setType(Dropbox\Sign\Model\SubMergeField::TYPE_CHECKBOX); -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); +$merge_fields = [ + $merge_fields_1, + $merge_fields_2, +]; -$data = new Dropbox\Sign\Model\TemplateCreateEmbeddedDraftRequest(); -$data->setClientId("37dee8d8440c66d54cfa05d92c160882") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setTitle("Test Template") - ->setSubject("Please sign this document") +$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") - ->setSignerRoles([$role1, $role2]) - ->setCcRoles(["Manager"]) - ->setMergeFields([$mergeField1, $mergeField2]) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); + ->setSubject("Please sign this document") + ->setTestMode(true) + ->setTitle("Test Template") + ->setCcRoles([ + "Manager", + ]) + ->setFiles([ + ]) + ->setFieldOptions($field_options) + ->setMergeFields($merge_fields) + ->setSignerRoles($signer_roles); try { - $result = $templateApi->templateCreateEmbeddedDraft($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateCreateEmbeddedDraft: {$e->getMessage()}"; } ``` @@ -279,26 +338,23 @@ Completely deletes the template specified from the account. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - try { - $templateApi->templateDelete($templateId); + (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateDelete( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateDelete: {$e->getMessage()}"; } ``` @@ -340,28 +396,26 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; -$fileType = "pdf"; - try { - $result = $templateApi->templateFiles($templateId, $fileType); - copy($result->getRealPath(), __DIR__ . '/file_response.pdf'); + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFiles( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + file_type: null, + ); + + copy($response->getRealPath(), __DIR__ . '/file_response'); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateFiles: {$e->getMessage()}"; } ``` @@ -404,27 +458,25 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - try { - $result = $templateApi->templateFilesAsDataUri($templateId); - print_r($result); + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsDataUri( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateFilesAsDataUri: {$e->getMessage()}"; } ``` @@ -466,27 +518,26 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; - try { - $result = $templateApi->templateFilesAsFileUrl($templateId); - print_r($result); + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateFilesAsFileUrl( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + force_download: 1, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateFilesAsFileUrl: {$e->getMessage()}"; } ``` @@ -529,27 +580,25 @@ Returns the Template specified by the `template_id` parameter. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$templateId = "f57db65d3f933b5316d398057a36176831451a35"; - try { - $result = $templateApi->templateGet($templateId); - print_r($result); + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateGet( + template_id: "f57db65d3f933b5316d398057a36176831451a35", + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateGet: {$e->getMessage()}"; } ``` @@ -591,27 +640,28 @@ Returns a list of the Templates that are accessible by you. Take a look at our ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$accountId = "f57db65d3f933b5316d398057a36176831451a35"; - try { - $result = $templateApi->templateList($accountId); - print_r($result); + $response = (new Dropbox\Sign\Api\TemplateApi(config: $config))->templateList( + account_id: null, + page: 1, + page_size: 20, + query: null, + ); + + print_r($response); } catch (Dropbox\Sign\ApiException $e) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateList: {$e->getMessage()}"; } ``` @@ -656,30 +706,29 @@ Removes the specified Account's access to the specified Template. ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateRemoveUserRequest(); -$data->setEmailAddress("george@dropboxsign.com"); - -$templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; +$template_remove_user_request = (new Dropbox\Sign\Model\TemplateRemoveUserRequest()) + ->setEmailAddress("george@dropboxsign.com"); try { - $result = $templateApi->templateRemoveUser($templateId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateRemoveUser: {$e->getMessage()}"; } ``` @@ -722,30 +771,30 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$templateApi = new Dropbox\Sign\Api\TemplateApi($config); - -$data = new Dropbox\Sign\Model\TemplateUpdateFilesRequest(); -$data->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]); - -$templateId = "5de8179668f2033afac48da1868d0093bf133266"; +$template_update_files_request = (new Dropbox\Sign\Model\TemplateUpdateFilesRequest()) + ->setFiles([ + ]); try { - $result = $templateApi->templateUpdateFiles($templateId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling TemplateApi#templateUpdateFiles: {$e->getMessage()}"; } ``` diff --git a/sdks/php/docs/Api/UnclaimedDraftApi.md b/sdks/php/docs/Api/UnclaimedDraftApi.md index a2b2f4236..caf17af70 100644 --- a/sdks/php/docs/Api/UnclaimedDraftApi.md +++ b/sdks/php/docs/Api/UnclaimedDraftApi.md @@ -24,63 +24,41 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer1->setEmailAddress("jack@example.com") +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftSigner()) ->setName("Jack") + ->setEmailAddress("jack@example.com") ->setOrder(0); -$signer2 = new Dropbox\Sign\Model\SubUnclaimedDraftSigner(); -$signer2->setEmailAddress("jill@example.com") - ->setName("Jill") - ->setOrder(1); - -$signingOptions = new Dropbox\Sign\Model\SubSigningOptions(); -$signingOptions->setDraw(true) - ->setType(true) - ->setUpload(true) - ->setPhone(false) - ->setDefaultType(Dropbox\Sign\Model\SubSigningOptions::DEFAULT_TYPE_DRAW); +$signers = [ + $signers_1, +]; -$fieldOptions = new Dropbox\Sign\Model\SubFieldOptions(); -$fieldOptions->setDateFormat(Dropbox\Sign\Model\SubFieldOptions::DATE_FORMAT_DD_MM_YYYY); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateRequest(); -$data->setSubject("The NDA we talked about") +$unclaimed_draft_create_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateRequest()) ->setType(Dropbox\Sign\Model\UnclaimedDraftCreateRequest::TYPE_REQUEST_SIGNATURE) - ->setMessage("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - ->setSigners([$signer1, $signer2]) - ->setCcEmailAddresses([ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ]) - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) - ->setMetadata([ - "custom_id" => 1234, - "custom_text" => "NDA #9", + ->setTestMode(true) + ->setFiles([ ]) - ->setSigningOptions($signingOptions) - ->setFieldOptions($fieldOptions) - ->setTestMode(true); + ->setSigners($signers); try { - $result = $unclaimedDraftApi->unclaimedDraftCreate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreate: {$e->getMessage()}"; } ``` @@ -122,31 +100,32 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setFiles([new SplFileObject(__DIR__ . "/example_signature_request.pdf")]) +$unclaimed_draft_create_embedded_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setTestMode(true); + ->setTestMode(true) + ->setFiles([ + ]); try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbedded($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded: {$e->getMessage()}"; } ``` @@ -188,42 +167,52 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); +$ccs_1 = (new Dropbox\Sign\Model\SubCC()) + ->setRole("Accounting") + ->setEmailAddress("accounting@dropboxsign.com"); + +$ccs = [ + $ccs_1, +]; -$signer1 = new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner(); -$signer1->setRole("Client") +$signers_1 = (new Dropbox\Sign\Model\SubUnclaimedDraftTemplateSigner()) + ->setRole("Client") ->setName("George") ->setEmailAddress("george@example.com"); -$cc1 = new Dropbox\Sign\Model\SubCC(); -$cc1->setRole("Accounting") - ->setEmailAddress("accounting@dropboxsign.com"); +$signers = [ + $signers_1, +]; -$data = new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTemplateIds(["61a832ff0d8423f91d503e76bfbcc750f7417c78"]) +$unclaimed_draft_create_embedded_with_template_request = (new Dropbox\Sign\Model\UnclaimedDraftCreateEmbeddedWithTemplateRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") ->setRequesterEmailAddress("jack@dropboxsign.com") - ->setSigners([$signer1]) - ->setCcs([$cc1]) - ->setTestMode(true); + ->setTemplateIds([ + "61a832ff0d8423f91d503e76bfbcc750f7417c78", + ]) + ->setTestMode(false) + ->setCcs($ccs) + ->setSigners($signers); try { - $result = $unclaimedDraftApi->unclaimedDraftCreateEmbeddedWithTemplate($data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate: {$e->getMessage()}"; } ``` @@ -265,31 +254,30 @@ Creates a new signature request from an embedded request that can be edited prio ```php setUsername("YOUR_API_KEY"); +use SplFileObject; +use Dropbox; -// or, configure Bearer (JWT) authorization: oauth2 +$config = Dropbox\Sign\Configuration::getDefaultConfiguration(); +$config->setUsername("YOUR_API_KEY"); // $config->setAccessToken("YOUR_ACCESS_TOKEN"); -$unclaimedDraftApi = new Dropbox\Sign\Api\UnclaimedDraftApi($config); - -$data = new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest(); -$data->setClientId("ec64a202072370a737edf4a0eb7f4437") - ->setTestMode(true); - -$signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; +$unclaimed_draft_edit_and_resend_request = (new Dropbox\Sign\Model\UnclaimedDraftEditAndResendRequest()) + ->setClientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a") + ->setTestMode(false); try { - $result = $unclaimedDraftApi->unclaimedDraftEditAndResend($signatureRequestId, $data); - print_r($result); + $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) { - $error = $e->getResponseObject(); - echo "Exception when calling Dropbox Sign API: " - . print_r($error->getError()); + echo "Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend: {$e->getMessage()}"; } ``` diff --git a/sdks/php/openapi-config.yaml b/sdks/php/openapi-config.yaml index 75c7f3f57..1b3f81534 100644 --- a/sdks/php/openapi-config.yaml +++ b/sdks/php/openapi-config.yaml @@ -15,6 +15,12 @@ additionalProperties: developerOrganizationEmail: "apisupport@hellosign.com" useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.composerPackageName: dropbox/sign-sandbox + oseg.namespace: Dropbox\SignSandbox + oseg.autoloadLocation: "__DIR__ . '/../vendor/autoload.php'" + oseg.ignoreOptionalUnset: true + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-EventCallbackHelper.mustache: templateType: SupportingFiles diff --git a/sdks/python/README.md b/sdks/python/README.md index 574b1bc36..736582916 100644 --- a/sdks/python/README.md +++ b/sdks/python/README.md @@ -69,29 +69,30 @@ Please follow the [installation procedure](#installation--usage) and then run th ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( + account_create_request = models.AccountCreateRequest( email_address="newuser@dropboxsign.com", ) try: - response = account_api.account_create(data) + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_create: %s\n" % e) ``` diff --git a/sdks/python/bin/generate-examples.php b/sdks/python/bin/generate-examples.php index ff3b6d302..dc872e59d 100755 --- a/sdks/python/bin/generate-examples.php +++ b/sdks/python/bin/generate-examples.php @@ -271,4 +271,3 @@ protected function getReplaceCodeString( $generate->setUseSnakeCase(true); $generate->run(); - diff --git a/sdks/python/docs/AccountApi.md b/sdks/python/docs/AccountApi.md index ce6cc0f36..baf60a9f2 100644 --- a/sdks/python/docs/AccountApi.md +++ b/sdks/python/docs/AccountApi.md @@ -23,29 +23,30 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountCreateRequest( + account_create_request = models.AccountCreateRequest( email_address="newuser@dropboxsign.com", ) try: - response = account_api.account_create(data) + response = api.AccountApi(api_client).account_create( + account_create_request=account_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_create: %s\n" % e) ``` ``` @@ -90,25 +91,24 @@ Returns the properties and settings of your Account. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - try: - response = account_api.account_get(email_address="jack@example.com") + response = api.AccountApi(api_client).account_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_get: %s\n" % e) ``` ``` @@ -154,29 +154,31 @@ Updates the properties and settings of your Account. Currently only allows for u * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountUpdateRequest( + account_update_request = models.AccountUpdateRequest( callback_url="https://www.example.com/callback", + locale="en-US", ) try: - response = account_api.account_update(data) + response = api.AccountApi(api_client).account_update( + account_update_request=account_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_update: %s\n" % e) ``` ``` @@ -221,29 +223,30 @@ Verifies whether an Dropbox Sign Account exists for the given email address. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - account_api = apis.AccountApi(api_client) - - data = models.AccountVerifyRequest( + account_verify_request = models.AccountVerifyRequest( email_address="some_user@dropboxsign.com", ) try: - response = account_api.account_verify(data) + response = api.AccountApi(api_client).account_verify( + account_verify_request=account_verify_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling AccountApi#account_verify: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/ApiAppApi.md b/sdks/python/docs/ApiAppApi.md index 2300565fb..2ee0a39e0 100644 --- a/sdks/python/docs/ApiAppApi.md +++ b/sdks/python/docs/ApiAppApi.md @@ -24,23 +24,24 @@ Creates a new API App. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - oauth = models.SubOAuth( callback_url="https://example.com/oauth", - scopes=["basic_account_info" "request_signature"], + scopes=[ + "basic_account_info", + "request_signature", + ], ) white_labeling_options = models.SubWhiteLabelingOptions( @@ -48,21 +49,24 @@ with ApiClient(configuration) as api_client: primary_button_text_color="#ffffff", ) - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppCreateRequest( + api_app_create_request = models.ApiAppCreateRequest( name="My Production App", - domains=["example.com"], + domains=[ + "example.com", + ], + custom_logo_file=open("CustomLogoFile.png", "rb").read(), oauth=oauth, white_labeling_options=white_labeling_options, - custom_logo_file=custom_logo_file, ) try: - response = api_app_api.api_app_create(data) + response = api.ApiAppApi(api_client).api_app_create( + api_app_create_request=api_app_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_create: %s\n" % e) ``` ``` @@ -107,24 +111,24 @@ Deletes an API App. Can only be invoked for apps you own. * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - try: - api_app_api.api_app_delete(client_id) + api.ApiAppApi(api_client).api_app_delete( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_delete: %s\n" % e) ``` ``` @@ -169,27 +173,26 @@ Returns an object with information about an API App. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - try: - response = api_app_api.api_app_get(client_id) + response = api.ApiAppApi(api_client).api_app_get( + client_id="0dd3b823a682527788c4e40cb7b6f7e9", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_get: %s\n" % e) ``` ``` @@ -234,31 +237,27 @@ Returns a list of API Apps that are accessible by you. If you are on a team with * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) - - page = 1 - page_size = 2 - try: - response = api_app_api.api_app_list( - page=page, - page_size=page_size, + response = api.ApiAppApi(api_client).api_app_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_list: %s\n" % e) ``` ``` @@ -304,41 +303,51 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - api_app_api = apis.ApiAppApi(api_client) + oauth = models.SubOAuth( + callback_url="https://example.com/oauth", + scopes=[ + "basic_account_info", + "request_signature", + ], + ) white_labeling_options = models.SubWhiteLabelingOptions( primary_button_color="#00b3e6", primary_button_text_color="#ffffff", ) - custom_logo_file = open("./CustomLogoFile.png", "rb") - - data = models.ApiAppUpdateRequest( - name="New Name", + 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, - custom_logo_file=custom_logo_file, ) - client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - try: - response = api_app_api.api_app_update(client_id, data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling ApiAppApi#api_app_update: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/BulkSendJobApi.md b/sdks/python/docs/BulkSendJobApi.md index cfff86e43..0e045f5ff 100644 --- a/sdks/python/docs/BulkSendJobApi.md +++ b/sdks/python/docs/BulkSendJobApi.md @@ -21,27 +21,28 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - try: - response = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e) ``` ``` @@ -88,31 +89,27 @@ Returns a list of BulkSendJob that you can access. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - bulk_send_job_api = apis.BulkSendJobApi(api_client) - - page = 1 - page_size = 20 - try: - response = bulk_send_job_api.bulk_send_job_list( - page=page, - page_size=page_size, + response = api.BulkSendJobApi(api_client).bulk_send_job_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling BulkSendJobApi#bulk_send_job_list: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/EmbeddedApi.md b/sdks/python/docs/EmbeddedApi.md index 9de8a573e..9bf1d9dbc 100644 --- a/sdks/python/docs/EmbeddedApi.md +++ b/sdks/python/docs/EmbeddedApi.md @@ -21,32 +21,36 @@ Retrieves an embedded object containing a template url that can be opened in an * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) + merge_fields = [] - data = models.EmbeddedEditUrlRequest( - cc_roles=[""], - merge_fields=[], + embedded_edit_url_request = models.EmbeddedEditUrlRequest( + cc_roles=[ + "", + ], + merge_fields=merge_fields, ) - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = embedded_api.embedded_edit_url(template_id, data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling EmbeddedApi#embedded_edit_url: %s\n" % e) ``` ``` @@ -92,27 +96,26 @@ Retrieves an embedded object containing a signature url that can be opened in an * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - embedded_api = apis.EmbeddedApi(api_client) - - signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - try: - response = embedded_api.embedded_sign_url(signature_id) + response = api.EmbeddedApi(api_client).embedded_sign_url( + signature_id="50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling EmbeddedApi#embedded_sign_url: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/FaxApi.md b/sdks/python/docs/FaxApi.md index 44b5a5c87..431d0ca9f 100644 --- a/sdks/python/docs/FaxApi.md +++ b/sdks/python/docs/FaxApi.md @@ -23,22 +23,23 @@ Deletes the specified Fax from the system * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - try: - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") + api.FaxApi(api_client).fax_delete( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_delete: %s\n" % e) ``` ``` @@ -82,25 +83,25 @@ Downloads files associated with a Fax * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = fax_api.fax_files(fax_id) - open("file_response.pdf", "wb").write(response.read()) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_files: %s\n" % e) ``` ``` @@ -144,25 +145,25 @@ Returns information about a Fax * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = fax_api.fax_get(fax_id) + response = api.FaxApi(api_client).fax_get( + fax_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_get: %s\n" % e) ``` ``` @@ -206,29 +207,26 @@ Returns properties of multiple Faxes * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - page = 1 - page_size = 2 - try: - response = fax_api.fax_list( - page=page, - page_size=page_size, + response = api.FaxApi(api_client).fax_list( + page=1, + page_size=20, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_list: %s\n" % e) ``` ``` @@ -273,34 +271,38 @@ Creates and sends a new Fax with the submitted file(s) * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_api = apis.FaxApi(api_client) - - data = models.FaxSendRequest( - files=[open("example_signature_request.pdf", "rb")], - test_mode=True, + fax_send_request = models.FaxSendRequest( recipient="16690000001", sender="16690000000", + test_mode=True, cover_page_to="Jill Fax", - cover_page_message="I'm sending you a fax!", cover_page_from="Faxer Faxerson", + cover_page_message="I'm sending you a fax!", title="This is what the fax is about!", + files=[ + open("./example_fax.pdf", "rb").read(), + ], ) try: - response = fax_api.fax_send(data) + response = api.FaxApi(api_client).fax_send( + fax_send_request=fax_send_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxApi#fax_send: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/FaxLineApi.md b/sdks/python/docs/FaxLineApi.md index 288342e81..e83991cd2 100644 --- a/sdks/python/docs/FaxLineApi.md +++ b/sdks/python/docs/FaxLineApi.md @@ -25,28 +25,30 @@ Grants a user access to the specified Fax Line. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineAddUserRequest( + fax_line_add_user_request = models.FaxLineAddUserRequest( number="[FAX_NUMBER]", email_address="member@dropboxsign.com", ) try: - response = fax_line_api.fax_line_add_user(data) + response = api.FaxLineApi(api_client).fax_line_add_user( + fax_line_add_user_request=fax_line_add_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_add_user: %s\n" % e) ``` ``` @@ -90,23 +92,28 @@ Returns a list of available area codes for a given state/province and city * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_area_code_get("US", "CA") + response = api.FaxLineApi(api_client).fax_line_area_code_get( + country="US", + state=None, + province=None, + city=None, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_area_code_get: %s\n" % e) ``` ``` @@ -153,28 +160,30 @@ Purchases a new Fax Line * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineCreateRequest( + fax_line_create_request = models.FaxLineCreateRequest( area_code=209, country="US", ) try: - response = fax_line_api.fax_line_create(data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_create: %s\n" % e) ``` ``` @@ -218,26 +227,27 @@ Deletes the specified Fax Line from the subscription. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineDeleteRequest( + fax_line_delete_request = models.FaxLineDeleteRequest( number="[FAX_NUMBER]", ) try: - fax_line_api.fax_line_delete(data) + api.FaxLineApi(api_client).fax_line_delete( + fax_line_delete_request=fax_line_delete_request, + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_delete: %s\n" % e) ``` ``` @@ -281,23 +291,25 @@ Returns the properties and settings of a Fax Line. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_get("[FAX_NUMBER]") + response = api.FaxLineApi(api_client).fax_line_get( + number="123-123-1234", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_get: %s\n" % e) ``` ``` @@ -341,23 +353,28 @@ Returns the properties and settings of multiple Fax Lines. * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - try: - response = fax_line_api.fax_line_list() + response = api.FaxLineApi(api_client).fax_line_list( + account_id="ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", + page=1, + page_size=20, + show_team_lines=None, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_list: %s\n" % e) ``` ``` @@ -404,28 +421,30 @@ Removes a user's access to the specified Fax Line * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", ) with ApiClient(configuration) as api_client: - fax_line_api = apis.FaxLineApi(api_client) - - data = models.FaxLineRemoveUserRequest( + fax_line_remove_user_request = models.FaxLineRemoveUserRequest( number="[FAX_NUMBER]", email_address="member@dropboxsign.com", ) try: - response = fax_line_api.fax_line_remove_user(data) + response = api.FaxLineApi(api_client).fax_line_remove_user( + fax_line_remove_user_request=fax_line_remove_user_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling FaxLineApi#fax_line_remove_user: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/OAuthApi.md b/sdks/python/docs/OAuthApi.md index b26775683..21bd2df27 100644 --- a/sdks/python/docs/OAuthApi.md +++ b/sdks/python/docs/OAuthApi.md @@ -19,27 +19,31 @@ Once you have retrieved the code from the user callback, you will need to exchan ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration() with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenGenerateRequest( - state="900e06e2", - code="1b0d28d90c86c141", + o_auth_token_generate_request = models.OAuthTokenGenerateRequest( client_id="cc91c61d00f8bb2ece1428035716b", client_secret="1d14434088507ffa390e6f5528465", + code="1b0d28d90c86c141", + state="900e06e2", + grant_type="authorization_code", ) try: - response = oauth_api.oauth_token_generate(data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling OAuthApi#oauth_token_generate: %s\n" % e) ``` ``` @@ -82,24 +86,28 @@ Access tokens are only valid for a given period of time (typically one hour) for ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration() with ApiClient(configuration) as api_client: - oauth_api = apis.OAuthApi(api_client) - - data = models.OAuthTokenRefreshRequest( + o_auth_token_refresh_request = models.OAuthTokenRefreshRequest( + grant_type="refresh_token", refresh_token="hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3", ) try: - response = oauth_api.oauth_token_refresh(data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling OAuthApi#oauth_token_refresh: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/ReportApi.md b/sdks/python/docs/ReportApi.md index 022e0c32b..0cbf5b5be 100644 --- a/sdks/python/docs/ReportApi.md +++ b/sdks/python/docs/ReportApi.md @@ -19,31 +19,34 @@ Request the creation of one or more report(s). When the report(s) have been gen * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - report_api = apis.ReportApi(api_client) - - data = models.ReportCreateRequest( + report_create_request = models.ReportCreateRequest( start_date="09/01/2020", end_date="09/01/2020", - report_type=["user_activity" "document_status"], + report_type=[ + "user_activity", + "document_status", + ], ) try: - response = report_api.report_create(data) + response = api.ReportApi(api_client).report_create( + report_create_request=report_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling ReportApi#report_create: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/SignatureRequestApi.md b/sdks/python/docs/SignatureRequestApi.md index 1141fb8ee..2a42ada70 100644 --- a/sdks/python/docs/SignatureRequestApi.md +++ b/sdks/python/docs/SignatureRequestApi.md @@ -38,78 +38,108 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of * Basic Authentication (api_key): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signer_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_1_signer = models.SubSignatureRequestTemplateSigner( + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", ) - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( + 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 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", + name="George", + email_address="george@example.com", + pin="d79a3td", ) - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", + 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( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, ) - cc_1 = models.SubCC( + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - data = models.SignatureRequestBulkCreateEmbeddedWithTemplateRequest( - client_id="1a659d9ad95bccd307ecad78d72192f8", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, + 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 = ( - signature_request_api.signature_request_bulk_create_embedded_with_template( - data - ) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -154,73 +184,108 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signer_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_1_signer = models.SubSignatureRequestTemplateSigner( + signer_list_2_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="George", - email_address="george@example.com", - pin="d79a3td", + name="Mary", + email_address="mary@example.com", + pin="gd9as5b", ) - signer_list_1_custom_fields = models.SubBulkSignerListCustomField( + 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 = models.SubBulkSignerList( - signers=[signer_list_1_signer], - custom_fields=[signer_list_1_custom_fields], - ) + signer_list_1_custom_fields = [ + signer_list_1_custom_fields_1, + ] - signer_list_2_signer = models.SubSignatureRequestTemplateSigner( + signer_list_1_signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - name="Mary", - email_address="mary@example.com", - pin="gd9as5b", + name="George", + email_address="george@example.com", + pin="d79a3td", ) - signer_list_2_custom_fields = models.SubBulkSignerListCustomField( - name="company", - value="123 LLC", + 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( - signers=[signer_list_2_signer], - custom_fields=[signer_list_2_custom_fields], + custom_fields=signer_list_2_custom_fields, + signers=signer_list_2_signers, ) - cc_1 = models.SubCC( + signer_list = [ + signer_list_1, + signer_list_2, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - data = models.SignatureRequestBulkSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signer_list=[signer_list_1, signer_list_2], - ccs=[cc_1], - test_mode=True, + 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 = signature_request_api.signature_request_bulk_send_with_template(data) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: %s\n" + % e + ) ``` ``` @@ -265,24 +330,27 @@ Cancels an incomplete signature request. This action is **not reversible**. The * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - signature_request_api.signature_request_cancel(signature_request_id) + api.SignatureRequestApi(api_client).signature_request_cancel( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_cancel: %s\n" + % e + ) ``` ``` @@ -327,57 +395,73 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", + signers_1 = models.SubSignatureRequestSigner( name="Jack", + email_address="jack@example.com", order=0, ) - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", + signers_2 = models.SubSignatureRequestSigner( name="Jill", + email_address="jill@example.com", order=1, ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) + signers = [ + signers_1, + signers_2, + ] - data = models.SignatureRequestCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", + 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", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, test_mode=True, + 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 = signature_request_api.signature_request_create_embedded(data) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded: %s\n" + % e + ) ``` ``` @@ -422,51 +506,63 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - data = models.SignatureRequestCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, + 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 = ( - signature_request_api.signature_request_create_embedded_with_template(data) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -511,72 +607,84 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - data = models.SignatureRequestEditRequest( - title="NDA with Acme Co.", + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_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", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_edit( - signature_request_id, data + response = api.SignatureRequestApi(api_client).signature_request_edit( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + signature_request_edit_request=signature_request_edit_request, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit: %s\n" + % e + ) ``` ``` @@ -622,61 +730,72 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", + signers_1 = models.SubSignatureRequestSigner( name="Jack", + email_address="jack@example.com", order=0, ) - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", + signers_2 = models.SubSignatureRequestSigner( name="Jill", + email_address="jill@example.com", order=1, ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=True, - default_type="draw", - ) + signers = [ + signers_1, + signers_2, + ] - data = models.SignatureRequestEditEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - title="NDA with Acme Co.", + 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", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"], - files=[open("example_signature_request.pdf", "rb")], - signing_options=signing_options, test_mode=True, + 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, ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_edit_embedded( - signature_request_id, data + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded: %s\n" + % e + ) ``` ``` @@ -722,53 +841,64 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestTemplateSigner( - role="Client", - email_address="jack@example.com", - name="Jack", - ) - signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - data = models.SignatureRequestEditEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - signing_options=signing_options, - test_mode=True, + signers_1 = models.SubSignatureRequestTemplateSigner( + role="Client", + name="George", + email_address="george@example.com", ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" + 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 = signature_request_api.signature_request_edit_embedded_with_template( - signature_request_id, data + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -814,66 +944,85 @@ Edits and sends a SignatureRequest based off of the Template(s) specified with t * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubSignatureRequestTemplateSigner( + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - email_address="george@example.com", name="George", + email_address="george@example.com", ) - cc_1 = models.SubCC( + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - custom_field_1 = models.SubCustomField( + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( name="Cost", - value="$20,000", editor="Client", required=True, + value="$20,000", ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, + 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, + ) ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_edit_with_template( - signature_request_id, data + response = api.SignatureRequestApi( + api_client + ).signature_request_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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_edit_with_template: %s\n" + % e + ) ``` ``` @@ -919,29 +1068,30 @@ Obtain a copy of the current documents specified by the `signature_request_id` p * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_files( - signature_request_id, file_type="pdf" + response = api.SignatureRequestApi(api_client).signature_request_files( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + file_type="pdf", ) - open("file_response.pdf", "wb").write(response.read()) + + open("./file_response", "wb").write(response.read()) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_files: %s\n" + % e + ) ``` ``` @@ -987,29 +1137,31 @@ Obtain a copy of the current documents specified by the `signature_request_id` p * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_files_as_data_uri( - signature_request_id + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: %s\n" + % e + ) ``` ``` @@ -1054,29 +1206,32 @@ Obtain a copy of the current documents specified by the `signature_request_id` p * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_files_as_file_url( - signature_request_id + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: %s\n" + % e + ) ``` ``` @@ -1122,27 +1277,28 @@ Returns the status of the SignatureRequest specified by the `signature_request_i * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - try: - response = signature_request_api.signature_request_get(signature_request_id) + response = api.SignatureRequestApi(api_client).signature_request_get( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_get: %s\n" % e + ) ``` ``` @@ -1187,31 +1343,32 @@ Returns a list of SignatureRequests that you can access. This includes Signature * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - account_id = None - page = 1 - try: - response = signature_request_api.signature_request_list( - account_id=account_id, - page=page, + response = api.SignatureRequestApi(api_client).signature_request_list( + account_id=None, + page=1, + page_size=20, + query=None, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_list: %s\n" + % e + ) ``` ``` @@ -1259,29 +1416,29 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_release_hold( - signature_request_id + response = api.SignatureRequestApi(api_client).signature_request_release_hold( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_release_hold: %s\n" + % e + ) ``` ``` @@ -1326,33 +1483,34 @@ Sends an email to the signer reminding them to sign the signature request. You c * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestRemindRequest( + signature_request_remind_request = models.SignatureRequestRemindRequest( email_address="john@example.com", ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_remind( - signature_request_id, data + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_remind: %s\n" + % e + ) ``` ``` @@ -1397,24 +1555,26 @@ Removes your access to a completed signature request. This action is **not rever * Basic Authentication (api_key): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 - # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - signature_request_api.signature_request_remove(signature_request_id) + api.SignatureRequestApi(api_client).signature_request_remove( + signature_request_id="fa5c8a0b0f492d768749333ad6fcc214c111e967", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_remove: %s\n" + % e + ) ``` ``` @@ -1459,68 +1619,83 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - signer_1 = models.SubSignatureRequestSigner( - email_address="jack@example.com", - name="Jack", - order=0, - ) - - signer_2 = models.SubSignatureRequestSigner( - email_address="jill@example.com", - name="Jill", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) signing_options = models.SubSigningOptions( + default_type="draw", draw=True, + phone=False, type=True, upload=True, - phone=True, - default_type="draw", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + signers_1 = models.SubSignatureRequestSigner( + name="Jack", + email_address="jack@example.com", + order=0, ) - data = models.SignatureRequestSendRequest( - title="NDA with Acme Co.", + signers_2 = models.SubSignatureRequestSigner( + name="Jill", + email_address="jill@example.com", + order=1, + ) + + signers = [ + signers_1, + signers_2, + ] + + signature_request_send_request = models.SignatureRequestSendRequest( + message="Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions.", subject="The NDA we talked about", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], + test_mode=True, + title="NDA with Acme Co.", cc_email_addresses=[ "lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com", ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + metadata=json.loads( + """ + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """ + ), field_options=field_options, - test_mode=True, + signing_options=signing_options, + signers=signers, ) try: - response = signature_request_api.signature_request_send(data) + response = api.SignatureRequestApi(api_client).signature_request_send( + signature_request_send_request=signature_request_send_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_send: %s\n" + % e + ) ``` ``` @@ -1565,62 +1740,84 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) + signing_options = models.SubSigningOptions( + default_type="draw", + draw=True, + phone=False, + type=True, + upload=True, + ) - signer_1 = models.SubSignatureRequestTemplateSigner( + signers_1 = models.SubSignatureRequestTemplateSigner( role="Client", - email_address="george@example.com", name="George", + email_address="george@example.com", ) - cc_1 = models.SubCC( + signers = [ + signers_1, + ] + + ccs_1 = models.SubCC( role="Accounting", email_address="accounting@example.com", ) - custom_field_1 = models.SubCustomField( + ccs = [ + ccs_1, + ] + + custom_fields_1 = models.SubCustomField( name="Cost", - value="$20,000", editor="Client", required=True, + value="$20,000", ) - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - data = models.SignatureRequestSendWithTemplateRequest( - template_ids=["c26b8a16784a872da37ea946b9ddec7c1e11dff6"], - subject="Purchase Order", - message="Glad we could come to an agreement.", - signers=[signer_1], - ccs=[cc_1], - custom_fields=[custom_field_1], - signing_options=signing_options, - test_mode=True, + 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 = signature_request_api.signature_request_send_with_template(data) + response = api.SignatureRequestApi( + api_client + ).signature_request_send_with_template( + signature_request_send_with_template_request=signature_request_send_with_template_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_send_with_template: %s\n" + % e + ) ``` ``` @@ -1665,34 +1862,35 @@ Updates the email address and/or the name for a given signer on a signature requ * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - signature_request_api = apis.SignatureRequestApi(api_client) - - data = models.SignatureRequestUpdateRequest( + signature_request_update_request = models.SignatureRequestUpdateRequest( + signature_id="2f9781e1a8e2045224d808c153c2e1d3df6f8f2f", email_address="john@example.com", - signature_id="78caf2a1d01cd39cea2bc1cbb340dac3", ) - signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - try: - response = signature_request_api.signature_request_update( - signature_request_id, data + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling SignatureRequestApi#signature_request_update: %s\n" + % e + ) ``` ``` diff --git a/sdks/python/docs/TeamApi.md b/sdks/python/docs/TeamApi.md index 34b61523a..9a2c5c47f 100644 --- a/sdks/python/docs/TeamApi.md +++ b/sdks/python/docs/TeamApi.md @@ -29,29 +29,31 @@ Invites a user (specified using the `email_address` parameter) to your Team. If * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamAddMemberRequest( + team_add_member_request = models.TeamAddMemberRequest( email_address="george@example.com", ) try: - response = team_api.team_add_member(data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_add_member: %s\n" % e) ``` ``` @@ -97,29 +99,30 @@ Creates a new Team and makes you a member. You must not currently belong to a Te * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamCreateRequest( + team_create_request = models.TeamCreateRequest( name="New Team Name", ) try: - response = team_api.team_create(data) + response = api.TeamApi(api_client).team_create( + team_create_request=team_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_create: %s\n" % e) ``` ``` @@ -164,22 +167,22 @@ Deletes your Team. Can only be invoked when you have a Team with only one member * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - team_api.team_delete() + api.TeamApi(api_client).team_delete() except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_delete: %s\n" % e) ``` ``` @@ -222,25 +225,24 @@ Returns information about your Team as well as a list of its members. If you do * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_get() + response = api.TeamApi(api_client).team_get() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_get: %s\n" % e) ``` ``` @@ -283,25 +285,26 @@ Provides information about a team. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - try: - response = team_api.team_info() + response = api.TeamApi(api_client).team_info( + team_id="4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_info: %s\n" % e) ``` ``` @@ -346,27 +349,24 @@ Provides a list of team invites (and their roles). * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - email_address = "user@dropboxsign.com" - try: - response = team_api.team_invites(email_address=email_address) + response = api.TeamApi(api_client).team_invites() + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_invites: %s\n" % e) ``` ``` @@ -411,27 +411,28 @@ Provides a paginated list of members (and their roles) that belong to a given te * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - try: - response = team_api.team_members(team_id) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_members: %s\n" % e) ``` ``` @@ -478,30 +479,31 @@ Removes the provided user Account from your Team. If the Account had an outstand * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamRemoveMemberRequest( + team_remove_member_request = models.TeamRemoveMemberRequest( email_address="teammate@dropboxsign.com", new_owner_email_address="new_teammate@dropboxsign.com", ) try: - response = team_api.team_remove_member(data) + response = api.TeamApi(api_client).team_remove_member( + team_remove_member_request=team_remove_member_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_remove_member: %s\n" % e) ``` ``` @@ -546,27 +548,28 @@ Provides a paginated list of sub teams that belong to a given team. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - try: - response = team_api.team_sub_teams(team_id) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_sub_teams: %s\n" % e) ``` ``` @@ -613,29 +616,30 @@ Updates the name of your Team. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - team_api = apis.TeamApi(api_client) - - data = models.TeamUpdateRequest( + team_update_request = models.TeamUpdateRequest( name="New Team Name", ) try: - response = team_api.team_update(data) + response = api.TeamApi(api_client).team_update( + team_update_request=team_update_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TeamApi#team_update: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/TemplateApi.md b/sdks/python/docs/TemplateApi.md index 153be9c2e..e6f14735f 100644 --- a/sdks/python/docs/TemplateApi.md +++ b/sdks/python/docs/TemplateApi.md @@ -30,31 +30,31 @@ Gives the specified Account access to the specified Template. The specified Acco * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateAddUserRequest( + template_add_user_request = models.TemplateAddUserRequest( email_address="george@dropboxsign.com", ) - template_id = "f57db65d3f933b5316d398057a36176831451a35" - try: - response = template_api.template_add_user(template_id, data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_add_user: %s\n" % e) ``` ``` @@ -100,62 +100,113 @@ Creates a template that can then be used. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", + ) - role_1 = models.SubTemplateRole( + signer_roles_1 = models.SubTemplateRole( name="Client", order=0, ) - role_2 = models.SubTemplateRole( + signer_roles_2 = models.SubTemplateRole( name="Witness", order=1, ) - merge_field_1 = models.SubMergeField( + 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_field_2 = models.SubMergeField( + merge_fields_2 = models.SubMergeField( name="Is Registered?", type="checkbox", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) + merge_fields = [ + merge_fields_1, + merge_fields_2, + ] - data = models.TemplateCreateRequest( + template_create_request = models.TemplateCreateRequest( client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, + 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 = template_api.template_create(data) + response = api.TemplateApi(api_client).template_create( + template_create_request=template_create_request, + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_create: %s\n" % e) ``` ``` @@ -200,62 +251,80 @@ The first step in an embedded template workflow. Creates a draft template that c * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - role_1 = models.SubTemplateRole( - name="Client", - order=0, - ) - - role_2 = models.SubTemplateRole( - name="Witness", - order=1, + field_options = models.SubFieldOptions( + date_format="DD - MM - YYYY", ) - merge_field_1 = models.SubMergeField( + merge_fields_1 = models.SubMergeField( name="Full Name", type="text", ) - merge_field_2 = models.SubMergeField( + merge_fields_2 = models.SubMergeField( name="Is Registered?", type="checkbox", ) - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", + 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, ) - data = models.TemplateCreateEmbeddedDraftRequest( + signer_roles = [ + signer_roles_1, + signer_roles_2, + ] + + template_create_embedded_draft_request = models.TemplateCreateEmbeddedDraftRequest( client_id="37dee8d8440c66d54cfa05d92c160882", - files=[open("example_signature_request.pdf", "rb")], - title="Test Template", - subject="Please sign this document", message="For your approval", - signer_roles=[role_1, role_2], - cc_roles=["Manager"], - merge_fields=[merge_field_1, merge_field_2], - field_options=field_options, + 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 = template_api.template_create_embedded_draft(data) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling TemplateApi#template_create_embedded_draft: %s\n" + % e + ) ``` ``` @@ -300,24 +369,24 @@ Completely deletes the template specified from the account. * Bearer (JWT) Authentication (oauth2): ```python -from dropbox_sign import ApiClient, ApiException, Configuration, apis +import json +from datetime import date, datetime +from pprint import pprint + +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - template_api.template_delete(template_id) + api.TemplateApi(api_client).template_delete( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_delete: %s\n" % e) ``` ``` @@ -362,27 +431,27 @@ Obtain a copy of the current documents specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_files(template_id, file_type="pdf") - open("file_response.pdf", "wb").write(response.read()) + response = api.TemplateApi(api_client).template_files( + template_id="f57db65d3f933b5316d398057a36176831451a35", + file_type=None, + ) + + open("./file_response", "wb").write(response.read()) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_files: %s\n" % e) ``` ``` @@ -428,27 +497,26 @@ Obtain a copy of the current documents specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_files_as_data_uri(template_id) + response = api.TemplateApi(api_client).template_files_as_data_uri( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_files_as_data_uri: %s\n" % e) ``` ``` @@ -493,27 +561,27 @@ Obtain a copy of the current documents specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_files_as_file_url(template_id) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_files_as_file_url: %s\n" % e) ``` ``` @@ -559,27 +627,26 @@ Returns the Template specified by the `template_id` parameter. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - template_id = "f57db65d3f933b5316d398057a36176831451a35" - try: - response = template_api.template_get(template_id) + response = api.TemplateApi(api_client).template_get( + template_id="f57db65d3f933b5316d398057a36176831451a35", + ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_get: %s\n" % e) ``` ``` @@ -624,29 +691,29 @@ Returns a list of the Templates that are accessible by you. Take a look at our * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - account_id = "f57db65d3f933b5316d398057a36176831451a35" - try: - response = template_api.template_list( - account_id=account_id, + response = api.TemplateApi(api_client).template_list( + account_id=None, + page=1, + page_size=20, + query=None, ) + pprint(response) except ApiException as e: - print("Exception when calling Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_list: %s\n" % e) ``` ``` @@ -694,31 +761,31 @@ Removes the specified Account's access to the specified Template. * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateRemoveUserRequest( + template_remove_user_request = models.TemplateRemoveUserRequest( email_address="george@dropboxsign.com", ) - template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" - try: - response = template_api.template_remove_user(template_id, data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_remove_user: %s\n" % e) ``` ``` @@ -764,31 +831,33 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - template_api = apis.TemplateApi(api_client) - - data = models.TemplateUpdateFilesRequest( - files=[open("example_signature_request.pdf", "rb")], + template_update_files_request = models.TemplateUpdateFilesRequest( + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], ) - template_id = "5de8179668f2033afac48da1868d0093bf133266" - try: - response = template_api.template_update_files(template_id, data) + 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 Dropbox Sign API: %s\n" % e) + print("Exception when calling TemplateApi#template_update_files: %s\n" % e) ``` ``` diff --git a/sdks/python/docs/UnclaimedDraftApi.md b/sdks/python/docs/UnclaimedDraftApi.md index 4ed79a34d..8cb87c6e1 100644 --- a/sdks/python/docs/UnclaimedDraftApi.md +++ b/sdks/python/docs/UnclaimedDraftApi.md @@ -23,68 +23,47 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - signer_1 = models.SubUnclaimedDraftSigner( - email_address="jack@example.com", + signers_1 = models.SubUnclaimedDraftSigner( name="Jack", + email_address="jack@example.com", order=0, ) - signer_2 = models.SubUnclaimedDraftSigner( - email_address="jill@example.com", - name="Jill", - order=1, - ) + signers = [ + signers_1, + ] - signing_options = models.SubSigningOptions( - draw=True, - type=True, - upload=True, - phone=False, - default_type="draw", - ) - - field_options = models.SubFieldOptions( - date_format="DD - MM - YYYY", - ) - - data = models.UnclaimedDraftCreateRequest( - subject="The NDA we talked about", + unclaimed_draft_create_request = models.UnclaimedDraftCreateRequest( type="request_signature", - message="Please sign this NDA and then we can discuss more. Let me know if you have any questions.", - signers=[signer_1, signer_2], - cc_email_addresses=[ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", - ], - files=[open("example_signature_request.pdf", "rb")], - metadata={ - "custom_id": 1234, - "custom_text": "NDA #9", - }, - signing_options=signing_options, - field_options=field_options, test_mode=True, + files=[ + open("./example_signature_request.pdf", "rb").read(), + ], + signers=signers, ) try: - response = unclaimed_draft_api.unclaimed_draft_create(data) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: %s\n" % e + ) ``` ``` @@ -129,32 +108,40 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftCreateEmbeddedRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - files=[open("example_signature_request.pdf", "rb")], - requester_email_address="jack@dropboxsign.com", - test_mode=True, + 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 = unclaimed_draft_api.unclaimed_draft_create_embedded(data) + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: %s\n" + % e + ) ``` ``` @@ -199,47 +186,63 @@ Creates a new Draft with a previously saved template(s) that can be claimed and * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) + ccs_1 = models.SubCC( + role="Accounting", + email_address="accounting@dropboxsign.com", + ) + + ccs = [ + ccs_1, + ] - signer_1 = models.SubUnclaimedDraftTemplateSigner( + signers_1 = models.SubUnclaimedDraftTemplateSigner( role="Client", name="George", email_address="george@example.com", ) - cc_1 = models.SubCC( - role="Accounting", - email_address="accounting@example.com", - ) - - data = models.UnclaimedDraftCreateEmbeddedWithTemplateRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - template_ids=["61a832ff0d8423f91d503e76bfbcc750f7417c78"], - requester_email_address="jack@dropboxsign.com", - signers=[signer_1], - ccs=[cc_1], - test_mode=True, + 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 = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template( - data + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: %s\n" + % e + ) ``` ``` @@ -284,34 +287,35 @@ Creates a new signature request from an embedded request that can be edited prio * Bearer (JWT) Authentication (oauth2): ```python +import json +from datetime import date, datetime from pprint import pprint -from dropbox_sign import ApiClient, ApiException, Configuration, apis, models +from dropbox_sign import ApiClient, ApiException, Configuration, api, models configuration = Configuration( - # Configure HTTP basic authorization: api_key username="YOUR_API_KEY", - # or, configure Bearer (JWT) authorization: oauth2 # access_token="YOUR_ACCESS_TOKEN", ) with ApiClient(configuration) as api_client: - unclaimed_draft_api = apis.UnclaimedDraftApi(api_client) - - data = models.UnclaimedDraftEditAndResendRequest( - client_id="ec64a202072370a737edf4a0eb7f4437", - test_mode=True, + unclaimed_draft_edit_and_resend_request = models.UnclaimedDraftEditAndResendRequest( + client_id="b6b8e7deaf8f0b95c029dca049356d4a2cf9710a", + test_mode=False, ) - signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" - try: - response = unclaimed_draft_api.unclaimed_draft_edit_and_resend( - signature_request_id, data + 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 Dropbox Sign API: %s\n" % e) + print( + "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: %s\n" + % e + ) ``` ``` diff --git a/sdks/python/openapi-config.yaml b/sdks/python/openapi-config.yaml index 6f67258bc..1d3dbc9b3 100644 --- a/sdks/python/openapi-config.yaml +++ b/sdks/python/openapi-config.yaml @@ -13,6 +13,9 @@ additionalProperties: infoName: Official Python SDK for the Dropbox Sign API useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.propertyNamingConvention: snake_case + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-__init__apis.mustache: templateType: SupportingFiles diff --git a/sdks/ruby/README.md b/sdks/ruby/README.md index a7d3b1847..28d9334d9 100644 --- a/sdks/ruby/README.md +++ b/sdks/ruby/README.md @@ -77,26 +77,25 @@ Please follow the [installation](#installation) procedure and then run the follo ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" begin - result = account_api.account_create(data) - p result + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_create: #{e}" end ``` diff --git a/sdks/ruby/docs/AccountApi.md b/sdks/ruby/docs/AccountApi.md index d2c439de5..ebae7148b 100644 --- a/sdks/ruby/docs/AccountApi.md +++ b/sdks/ruby/docs/AccountApi.md @@ -21,26 +21,25 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountCreateRequest.new -data.email_address = "newuser@dropboxsign.com" +account_create_request = Dropbox::Sign::AccountCreateRequest.new +account_create_request.email_address = "newuser@dropboxsign.com" begin - result = account_api.account_create(data) - p result + response = Dropbox::Sign::AccountApi.new.account_create( + account_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_create: #{e}" end ``` @@ -94,23 +93,20 @@ Returns the properties and settings of your Account. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -account_api = Dropbox::Sign::AccountApi.new - begin - result = account_api.account_get({ email_address: "jack@example.com" }) - p result + response = Dropbox::Sign::AccountApi.new.account_get + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_get: #{e}" end ``` @@ -165,26 +161,26 @@ Updates the properties and settings of your Account. Currently only allows for u ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountUpdateRequest.new -data.callback_url = "https://www.example.com/callback" +account_update_request = Dropbox::Sign::AccountUpdateRequest.new +account_update_request.callback_url = "https://www.example.com/callback" +account_update_request.locale = "en-US" begin - result = account_api.account_update(data) - p result + response = Dropbox::Sign::AccountApi.new.account_update( + account_update_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_update: #{e}" end ``` @@ -238,26 +234,25 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -account_api = Dropbox::Sign::AccountApi.new - -data = Dropbox::Sign::AccountVerifyRequest.new -data.email_address = "some_user@dropboxsign.com" +account_verify_request = Dropbox::Sign::AccountVerifyRequest.new +account_verify_request.email_address = "some_user@dropboxsign.com" begin - result = account_api.account_verify(data) - p result + response = Dropbox::Sign::AccountApi.new.account_verify( + account_verify_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling AccountApi#account_verify: #{e}" end ``` diff --git a/sdks/ruby/docs/ApiAppApi.md b/sdks/ruby/docs/ApiAppApi.md index b225cc8d1..10b5fac53 100644 --- a/sdks/ruby/docs/ApiAppApi.md +++ b/sdks/ruby/docs/ApiAppApi.md @@ -22,40 +22,42 @@ Creates a new API App. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api_app_api = Dropbox::Sign::ApiAppApi.new - oauth = Dropbox::Sign::SubOAuth.new oauth.callback_url = "https://example.com/oauth" -oauth.scopes = %w[basic_account_info request_signature] +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" -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppCreateRequest.new -data.name = "My Production App" -data.domains = ["example.com"] -data.oauth = oauth -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file +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 - result = api_app_api.api_app_create(data) - p result + response = Dropbox::Sign::ApiAppApi.new.api_app_create( + api_app_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_create: #{e}" end ``` @@ -109,25 +111,20 @@ Deletes an API App. Can only be invoked for apps you own. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - begin - result = api_app_api.api_app_delete(client_id) - p result + Dropbox::Sign::ApiAppApi.new.api_app_delete( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_delete: #{e}" end ``` @@ -181,25 +178,22 @@ Returns an object with information about an API App. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api_app_api = Dropbox::Sign::ApiAppApi.new - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" - begin - result = api_app_api.api_app_get(client_id) - p result + response = Dropbox::Sign::ApiAppApi.new.api_app_get( + "0dd3b823a682527788c4e40cb7b6f7e9", # client_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_get: #{e}" end ``` @@ -253,26 +247,25 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api_app_api = Dropbox::Sign::ApiAppApi.new - -page = 1 -page_size = 2 - begin - result = api_app_api.api_app_list({ page: page, page_size: page_size }) - p result + response = Dropbox::Sign::ApiAppApi.new.api_app_list( + { + page: 1, + page_size: 20, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_list: #{e}" end ``` @@ -327,37 +320,44 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api_app_api = Dropbox::Sign::ApiAppApi.new +oauth = Dropbox::Sign::SubOAuth.new +oauth.callback_url = "https://example.com/oauth" +oauth.scopes = [ + "basic_account_info", + "request_signature", +] white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new white_labeling_options.primary_button_color = "#00b3e6" white_labeling_options.primary_button_text_color = "#ffffff" -custom_logo_file = File.new('./CustomLogoFile.png') - -data = Dropbox::Sign::ApiAppUpdateRequest.new -data.name = "New Name" -data.callback_url = "https://example.com/dropboxsign" -data.white_labeling_options = white_labeling_options -data.custom_logo_file = custom_logo_file - -client_id = "0dd3b823a682527788c4e40cb7b6f7e9" +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 - result = api_app_api.api_app_update(client_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling ApiAppApi#api_app_update: #{e}" end ``` diff --git a/sdks/ruby/docs/BulkSendJobApi.md b/sdks/ruby/docs/BulkSendJobApi.md index bb42dd625..0771fbcde 100644 --- a/sdks/ruby/docs/BulkSendJobApi.md +++ b/sdks/ruby/docs/BulkSendJobApi.md @@ -19,25 +19,26 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -bulk_send_job_id = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174" - begin - result = bulk_send_job_api.bulk_send_job_get(bulk_send_job_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling BulkSendJobApi#bulk_send_job_get: #{e}" end ``` @@ -93,26 +94,25 @@ Returns a list of BulkSendJob that you can access. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -bulk_send_job_api = Dropbox::Sign::BulkSendJobApi.new - -page = 1 -page_size = 20 - begin - result = bulk_send_job_api.bulk_send_job_list({ page: page, page_size: page_size }) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling BulkSendJobApi#bulk_send_job_list: #{e}" end ``` diff --git a/sdks/ruby/docs/EmbeddedApi.md b/sdks/ruby/docs/EmbeddedApi.md index af26da64d..998c914b3 100644 --- a/sdks/ruby/docs/EmbeddedApi.md +++ b/sdks/ruby/docs/EmbeddedApi.md @@ -19,29 +19,32 @@ Retrieves an embedded object containing a template url that can be opened in an ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api = Dropbox::Sign::EmbeddedApi.new - -data = Dropbox::Sign::EmbeddedEditUrlRequest.new -data.cc_roles = [""] -data.merge_fields = [] +merge_fields = [ +] -template_id = "5de8179668f2033afac48da1868d0093bf133266" +embedded_edit_url_request = Dropbox::Sign::EmbeddedEditUrlRequest.new +embedded_edit_url_request.cc_roles = [ + "", +] +embedded_edit_url_request.merge_fields = merge_fields begin - result = embedded_api.embedded_edit_url(template_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling EmbeddedApi#embedded_edit_url: #{e}" end ``` @@ -96,25 +99,22 @@ Retrieves an embedded object containing a signature url that can be opened in an ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -api = Dropbox::Sign::EmbeddedApi.new - -signature_id = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" - begin - result = embedded_api.embedded_sign_url(signature_id) - p result + response = Dropbox::Sign::EmbeddedApi.new.embedded_sign_url( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b", # signature_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling EmbeddedApi#embedded_sign_url: #{e}" end ``` diff --git a/sdks/ruby/docs/FaxApi.md b/sdks/ruby/docs/FaxApi.md index a260d58dc..310c9a34b 100644 --- a/sdks/ruby/docs/FaxApi.md +++ b/sdks/ruby/docs/FaxApi.md @@ -22,19 +22,19 @@ Deletes the specified Fax from the system ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - begin - fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967") + Dropbox::Sign::FaxApi.new.fax_delete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_delete: #{e}" end ``` @@ -88,22 +88,21 @@ Downloads files associated with a Fax ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - file_bin = fax_api.fax_files(data) - FileUtils.cp(file_bin.path, "path/to/file.pdf") + 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 Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_files: #{e}" end ``` @@ -157,22 +156,21 @@ Returns information about a Fax ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = fax_api.fax_get(fax_id) - p result + response = Dropbox::Sign::FaxApi.new.fax_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # fax_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_get: #{e}" end ``` @@ -226,23 +224,24 @@ Returns properties of multiple Faxes ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -page = 1 -page_size = 2 - begin - result = fax_api.fax_list({ page: page, page_size: page_size }) - p result + response = Dropbox::Sign::FaxApi.new.fax_list( + { + page: 1, + page_size: 20, + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_list: #{e}" end ``` @@ -297,30 +296,33 @@ Creates and sends a new Fax with the submitted file(s) ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_api = Dropbox::Sign::FaxApi.new - -data = Dropbox::Sign::FaxSendRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] -data.test_mode = true -data.recipient = "16690000001" -data.sender = "16690000000" -data.cover_page_to = "Jill Fax" -data.cover_page_message = "I'm sending you a fax!" -data.cover_page_from = "Faxer Faxerson" -data.title = "This is what the fax is about!" +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 - result = fax_api.fax_send(data) - p result + response = Dropbox::Sign::FaxApi.new.fax_send( + fax_send_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxApi#fax_send: #{e}" end ``` diff --git a/sdks/ruby/docs/FaxLineApi.md b/sdks/ruby/docs/FaxLineApi.md index f7687b9e3..a52f30c55 100644 --- a/sdks/ruby/docs/FaxLineApi.md +++ b/sdks/ruby/docs/FaxLineApi.md @@ -24,24 +24,25 @@ Grants a user access to the specified Fax Line. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineAddUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" +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 - result = fax_line_api.fax_line_add_user(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_add_user: #{e}" end ``` @@ -95,20 +96,21 @@ Returns a list of available area codes for a given state/province and city ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - begin - result = fax_line_api.fax_line_area_code_get("US", "CA") - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get( + "US", # country + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_area_code_get: #{e}" end ``` @@ -165,24 +167,25 @@ Purchases a new Fax Line ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineCreateRequest.new -data.area_code = 209 -data.country = "US" +fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new +fax_line_create_request.area_code = 209 +fax_line_create_request.country = "US" begin - result = fax_line_api.fax_line_create(data) - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_create( + fax_line_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_create: #{e}" end ``` @@ -236,22 +239,22 @@ Deletes the specified Fax Line from the subscription. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineDeleteRequest.new -data.number = "[FAX_NUMBER]" +fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new +fax_line_delete_request.number = "[FAX_NUMBER]" begin - fax_line_api.fax_line_delete(data) + Dropbox::Sign::FaxLineApi.new.fax_line_delete( + fax_line_delete_request, + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_delete: #{e}" end ``` @@ -305,20 +308,21 @@ Returns the properties and settings of a Fax Line. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - begin - result = fax_line_api.fax_line_get("[NUMBER]") - p result + response = Dropbox::Sign::FaxLineApi.new.fax_line_get( + "123-123-1234", # number + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_get: #{e}" end ``` @@ -372,20 +376,26 @@ Returns the properties and settings of multiple Fax Lines. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - begin - result = fax_line_api.fax_line_list() - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_list: #{e}" end ``` @@ -442,24 +452,25 @@ Removes a user's access to the specified Fax Line ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" end -fax_line_api = Dropbox::Sign::FaxLineApi.new - -data = Dropbox::Sign::FaxLineRemoveUserRequest.new -data.number = "[FAX_NUMBER]" -data.email_address = "member@dropboxsign.com" +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 - result = fax_line_api.fax_line_remove_user(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling FaxLineApi#fax_line_remove_user: #{e}" end ``` diff --git a/sdks/ruby/docs/OAuthApi.md b/sdks/ruby/docs/OAuthApi.md index b9ff0295d..579602d37 100644 --- a/sdks/ruby/docs/OAuthApi.md +++ b/sdks/ruby/docs/OAuthApi.md @@ -19,21 +19,27 @@ Once you have retrieved the code from the user callback, you will need to exchan ### Examples ```ruby +require "json" require "dropbox-sign" -oauth_api = Dropbox::Sign::OAuthApi.new +Dropbox::Sign.configure do |config| +end -data = Dropbox::Sign::OAuthTokenGenerateRequest.new -data.state = "900e06e2" -data.code = "1b0d28d90c86c141" -data.client_id = "cc91c61d00f8bb2ece1428035716b" -data.client_secret = "1d14434088507ffa390e6f5528465" +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 - result = oauth_api.oauth_token_generate(data) - p result + response = Dropbox::Sign::OAuthApi.new.oauth_token_generate( + o_auth_token_generate_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling OAuthApi#oauth_token_generate: #{e}" end ``` @@ -87,18 +93,24 @@ Access tokens are only valid for a given period of time (typically one hour) for ### Examples ```ruby +require "json" require "dropbox-sign" -oauth_api = Dropbox::Sign::OAuthApi.new +Dropbox::Sign.configure do |config| +end -data = Dropbox::Sign::OAuthTokenRefreshRequest.new -data.refresh_token = "hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3" +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 - result = oauth_api.oauth_token_refresh(data) - p result + response = Dropbox::Sign::OAuthApi.new.oauth_token_refresh( + o_auth_token_refresh_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling OAuthApi#oauth_token_refresh: #{e}" end ``` diff --git a/sdks/ruby/docs/ReportApi.md b/sdks/ruby/docs/ReportApi.md index d612c7ed5..9b0b90317 100644 --- a/sdks/ruby/docs/ReportApi.md +++ b/sdks/ruby/docs/ReportApi.md @@ -18,28 +18,29 @@ Request the creation of one or more report(s). When the report(s) have been gen ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" end -report_api = Dropbox::Sign::ReportApi.new - -data = Dropbox::Sign::ReportCreateRequest.new -data.start_date = "09/01/2020" -data.end_date = "09/01/2020" -data.report_type = %w[user_activity document_status] +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 - result = report_api.report_create(data) - p result + response = Dropbox::Sign::ReportApi.new.report_create( + report_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling ReportApi#report_create: #{e}" end ``` diff --git a/sdks/ruby/docs/SignatureRequestApi.md b/sdks/ruby/docs/SignatureRequestApi.md index 6e7299b54..04f0c0bbf 100644 --- a/sdks/ruby/docs/SignatureRequestApi.md +++ b/sdks/ruby/docs/SignatureRequestApi.md @@ -37,64 +37,89 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new +signer_list_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_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" +signer_list_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_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" +signer_list_2_signers = [ + signer_list_2_signers_1, +] -signer_list_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] +signer_list_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_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" +signer_list_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_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" +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.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -data = Dropbox::Sign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest.new -data.client_id = "1a659d9ad95bccd307ecad78d72192f8" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true +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 - result = signature_request_api.signature_request_bulk_create_embedded_with_template(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_bulk_create_embedded_with_template: #{e}" end ``` @@ -148,63 +173,89 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new +signer_list_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_1_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_1_signer.role = "Client" -signer_list_1_signer.name = "George" -signer_list_1_signer.email_address = "george@example.com" -signer_list_1_signer.pin = "d79a3td" +signer_list_2_custom_fields = [ + signer_list_2_custom_fields_1, +] -signer_list_1_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_1_custom_fields.name = "company" -signer_list_1_custom_fields.value = "ABC Corp" +signer_list_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_1 = Dropbox::Sign::SubBulkSignerList.new -signer_list_1.signers = [signer_list_1_signer] -signer_list_1.custom_fields = [signer_list_1_custom_fields] +signer_list_2_signers = [ + signer_list_2_signers_1, +] -signer_list_2_signer = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_list_2_signer.role = "Client" -signer_list_2_signer.name = "Mary" -signer_list_2_signer.email_address = "mary@example.com" -signer_list_2_signer.pin = "gd9as5b" +signer_list_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_2_custom_fields = Dropbox::Sign::SubBulkSignerListCustomField.new -signer_list_2_custom_fields.name = "company" -signer_list_2_custom_fields.value = "123 LLC" +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.signers = [signer_list_2_signer] -signer_list_2.custom_fields = [signer_list_2_custom_fields] +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" -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" +ccs = [ + ccs_1, +] -data = Dropbox::Sign::SignatureRequestBulkSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signer_list = [signer_list_1, signer_list_2] -data.ccs = [cc_1] -data.test_mode = true +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 - result = signature_request_api.signature_request_bulk_send_with_template(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_bulk_send_with_template: #{e}" end ``` @@ -258,25 +309,20 @@ Cancels an incomplete signature request. This action is **not reversible**. The ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - begin - result = signature_request_api.signature_request_cancel(signature_request_id) - p result + Dropbox::Sign::SignatureRequestApi.new.signature_request_cancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_cancel: #{e}" end ``` @@ -330,51 +376,60 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true +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 - result = signature_request_api.signature_request_create_embedded(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded: #{e}" end ``` @@ -428,44 +483,49 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true +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 - result = signature_request_api.signature_request_create_embedded_with_template(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_create_embedded_with_template: #{e}" end ``` @@ -519,63 +579,71 @@ Edits and sends a SignatureRequest with the submitted documents. If `form_fields ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 +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.phone = true -signing_options.default_type = "draw" -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" +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 -data = Dropbox::Sign::SignatureRequestEditRequest.new -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", +signers = [ + signers_1, + signers_2, ] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +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 - result = signature_request_api.signature_request_edit(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_edit: #{e}" end ``` @@ -630,53 +698,61 @@ Edits a SignatureRequest with the submitted documents to be signed in an embedde ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestEditEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"] -data.files = [File.new("example_signature_request.pdf", "r")] -data.signing_options = signing_options -data.test_mode = true +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_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +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 - result = signature_request_api.signature_request_edit_embedded(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded: #{e}" end ``` @@ -731,46 +807,50 @@ Edits a SignatureRequest based on the given Template(s) to be signed in an embed ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" - signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = true -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestEditEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.signing_options = signing_options -data.test_mode = true +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_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +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 - result = signature_request_api.signature_request_edit_embedded_with_template(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_edit_embedded_with_template: #{e}" end ``` @@ -825,57 +905,69 @@ Edits and sends a SignatureRequest based off of the Template(s) specified with t ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "george@example.com" -signer_1.name = "George" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -custom_field_1 = Dropbox::Sign::SubCustomField.new -custom_field_1.name = "Cost" -custom_field_1.value = "$20,000" -custom_field_1.editor = "Client" -custom_field_1.required = true - signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.ccs = [cc_1] -data.custom_fields = [custom_field_1] -data.signing_options = signing_options -data.test_mode = true +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" -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +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 - result = signature_request_api.signature_request_edit_with_template(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_edit_with_template: #{e}" end ``` @@ -930,25 +1022,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - file_bin = signature_request_api.signature_request_files(signature_request_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_files: #{e}" end ``` @@ -1003,25 +1095,22 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = signature_request_api.signature_request_files_as_data_uri(signature_request_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_files_as_data_uri: #{e}" end ``` @@ -1075,25 +1164,25 @@ Obtain a copy of the current documents specified by the `signature_request_id` p ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = signature_request_api.signature_request_files_as_file_url(signature_request_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_files_as_file_url: #{e}" end ``` @@ -1148,25 +1237,22 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967" - begin - result = signature_request_api.signature_request_get(signature_request_id) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_get( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_get: #{e}" end ``` @@ -1220,26 +1306,27 @@ Returns a list of SignatureRequests that you can access. This includes Signature ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -account_id = null -page = 1 - begin - result = signature_request_api.signature_request_list({ account_id: account_id, page: page }) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_list: #{e}" end ``` @@ -1296,25 +1383,22 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - begin - result = signature_request_api.signature_request_release_hold(signature_request_id) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_release_hold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_release_hold: #{e}" end ``` @@ -1368,28 +1452,26 @@ Sends an email to the signer reminding them to sign the signature request. You c ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestRemindRequest.new -data.email_address = "john@example.com" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +signature_request_remind_request = Dropbox::Sign::SignatureRequestRemindRequest.new +signature_request_remind_request.email_address = "john@example.com" begin - result = signature_request_api.signature_request_remind(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_remind: #{e}" end ``` @@ -1444,25 +1526,19 @@ Removes your access to a completed signature request. This action is **not rever ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 - # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" - begin - result = signature_request_api.signature_request_remove(signature_request_id) - p result + Dropbox::Sign::SignatureRequestApi.new.signature_request_remove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", # signature_request_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_remove: #{e}" end ``` @@ -1516,61 +1592,70 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubSignatureRequestSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 +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.phone = true -signing_options.default_type = "draw" -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" +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 -data = Dropbox::Sign::SignatureRequestSendRequest.new -data.title = "NDA with Acme Co." -data.subject = "The NDA we talked about" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", +signers = [ + signers_1, + signers_2, ] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true + +signature_request_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 - result = signature_request_api.signature_request_send(data) - p result + response = Dropbox::Sign::SignatureRequestApi.new.signature_request_send( + signature_request_send_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_send: #{e}" end ``` @@ -1624,55 +1709,68 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -signer_1 = Dropbox::Sign::SubSignatureRequestTemplateSigner.new -signer_1.role = "Client" -signer_1.email_address = "george@example.com" -signer_1.name = "George" - -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" - -custom_field_1 = Dropbox::Sign::SubCustomField.new -custom_field_1.name = "Cost" -custom_field_1.value = "$20,000" -custom_field_1.editor = "Client" -custom_field_1.required = true - signing_options = Dropbox::Sign::SubSigningOptions.new +signing_options.default_type = "draw" signing_options.draw = true +signing_options.phone = false signing_options.type = true signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" -data = Dropbox::Sign::SignatureRequestSendWithTemplateRequest.new -data.template_ids = ["c26b8a16784a872da37ea946b9ddec7c1e11dff6"] -data.subject = "Purchase Order" -data.message = "Glad we could come to an agreement." -data.signers = [signer_1] -data.ccs = [cc_1] -data.custom_fields = [custom_field_1] -data.signing_options = signing_options -data.test_mode = true +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 - result = signature_request_api.signature_request_send_with_template(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_send_with_template: #{e}" end ``` @@ -1726,29 +1824,27 @@ Updates the email address and/or the name for a given signer on a signature requ ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -signature_request_api = Dropbox::Sign::SignatureRequestApi.new - -data = Dropbox::Sign::SignatureRequestUpdateRequest.new -data.email_address = "john@example.com" -data.signature_id = "78caf2a1d01cd39cea2bc1cbb340dac3" - -signature_request_id = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f" +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 - result = signature_request_api.signature_request_update(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling SignatureRequestApi#signature_request_update: #{e}" end ``` diff --git a/sdks/ruby/docs/TeamApi.md b/sdks/ruby/docs/TeamApi.md index 846491457..b8279a3b9 100644 --- a/sdks/ruby/docs/TeamApi.md +++ b/sdks/ruby/docs/TeamApi.md @@ -27,26 +27,28 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamAddMemberRequest.new -data.email_address = "george@example.com" +team_add_member_request = Dropbox::Sign::TeamAddMemberRequest.new +team_add_member_request.email_address = "george@example.com" begin - result = team_api.team_add_member(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_add_member: #{e}" end ``` @@ -101,26 +103,25 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamCreateRequest.new -data.name = "New Team Name" +team_create_request = Dropbox::Sign::TeamCreateRequest.new +team_create_request.name = "New Team Name" begin - result = team_api.team_create(data) - p result + response = Dropbox::Sign::TeamApi.new.team_create( + team_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_create: #{e}" end ``` @@ -174,23 +175,18 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - begin - result = team_api.team_delete - p result + Dropbox::Sign::TeamApi.new.team_delete rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_delete: #{e}" end ``` @@ -242,23 +238,20 @@ Returns information about your Team as well as a list of its members. If you do ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - begin - result = team_api.team_get - p result + response = Dropbox::Sign::TeamApi.new.team_get + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_get: #{e}" end ``` @@ -310,23 +303,24 @@ Provides information about a team. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - begin - result = team_api.team_info - p result + response = Dropbox::Sign::TeamApi.new.team_info( + { + team_id: "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", + }, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_info: #{e}" end ``` @@ -380,25 +374,20 @@ Provides a list of team invites (and their roles). ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -email_address = "user@dropboxsign.com" - begin - result = team_api.team_invites({ email_address: email_address }) - p result + response = Dropbox::Sign::TeamApi.new.team_invites + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_invites: #{e}" end ``` @@ -452,25 +441,26 @@ Provides a paginated list of members (and their roles) that belong to a given te ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - begin - result = team_api.team_members(team_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_members: #{e}" end ``` @@ -526,27 +516,26 @@ Removes the provided user Account from your Team. If the Account had an outstand ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamRemoveMemberRequest.new -data.email_address = "teammate@dropboxsign.com" -data.new_owner_email_address = "new_teammate@dropboxsign.com" +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 - result = team_api.team_remove_member(data) - p result + response = Dropbox::Sign::TeamApi.new.team_remove_member( + team_remove_member_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_remove_member: #{e}" end ``` @@ -600,25 +589,26 @@ Provides a paginated list of sub teams that belong to a given team. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -team_id = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" - begin - result = team_api.team_sub_teams(team_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_sub_teams: #{e}" end ``` @@ -674,26 +664,25 @@ Updates the name of your Team. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -team_api = Dropbox::Sign::TeamApi.new - -data = Dropbox::Sign::TeamUpdateRequest.new -data.name = "New Team Name" +team_update_request = Dropbox::Sign::TeamUpdateRequest.new +team_update_request.name = "New Team Name" begin - result = team_api.team_update(data) - p result + response = Dropbox::Sign::TeamApi.new.team_update( + team_update_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TeamApi#team_update: #{e}" end ``` diff --git a/sdks/ruby/docs/TemplateApi.md b/sdks/ruby/docs/TemplateApi.md index bcd27fae0..315ced97c 100644 --- a/sdks/ruby/docs/TemplateApi.md +++ b/sdks/ruby/docs/TemplateApi.md @@ -28,28 +28,26 @@ Gives the specified Account access to the specified Template. The specified Acco ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateAddUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "f57db65d3f933b5316d398057a36176831451a35" +template_add_user_request = Dropbox::Sign::TemplateAddUserRequest.new +template_add_user_request.email_address = "george@dropboxsign.com" begin - result = template_api.template_add_user(template_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_add_user: #{e}" end ``` @@ -104,54 +102,101 @@ Creates a template that can then be used. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -role_1 = Dropbox::Sign::SubTemplateRole.new -role_1.name = "Client" -role_1.order = 0 - -role_2 = Dropbox::Sign::SubTemplateRole.new -role_2.name = "Witness" -role_2.order = 1 - -merge_field_1 = Dropbox::Sign::SubMergeField.new -merge_field_1.name = "Full Name" -merge_field_1.type = "text" - -merge_field_2 = Dropbox::Sign::SubMergeField.new -merge_field_2.name = "Is Registered?" -merge_field_2.type = "checkbox" - field_options = Dropbox::Sign::SubFieldOptions.new field_options.date_format = "DD - MM - YYYY" -data = Dropbox::Sign::TemplateCreateRequest.new -data.client_id = "37dee8d8440c66d54cfa05d92c160882" -data.files = [File.new("example_signature_request.pdf", "r")] -data.title = "Test Template" -data.subject = "Please sign this document" -data.message = "For your approval" -data.signer_roles = [role_1, role_2] -data.cc_roles = ["Manager"] -data.merge_fields = [merge_field_1, merge_field_2] -data.field_options = field_options -data.test_mode = true +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 - result = template_api.template_create(data) - p result + response = Dropbox::Sign::TemplateApi.new.template_create( + template_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_create: #{e}" end ``` @@ -205,54 +250,67 @@ The first step in an embedded template workflow. Creates a draft template that c ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -role_1 = Dropbox::Sign::SubTemplateRole.new -role_1.name = "Client" -role_1.order = 0 - -role_2 = Dropbox::Sign::SubTemplateRole.new -role_2.name = "Witness" -role_2.order = 1 - -merge_field_1 = Dropbox::Sign::SubMergeField.new -merge_field_1.name = "Full Name" -merge_field_1.type = "text" - -merge_field_2 = Dropbox::Sign::SubMergeField.new -merge_field_2.name = "Is Registered?" -merge_field_2.type = "checkbox" - field_options = Dropbox::Sign::SubFieldOptions.new field_options.date_format = "DD - MM - YYYY" -data = Dropbox::Sign::TemplateCreateEmbeddedDraftRequest.new -data.client_id = "37dee8d8440c66d54cfa05d92c160882" -data.files = [File.new("example_signature_request.pdf", "r")] -data.title = "Test Template" -data.subject = "Please sign this document" -data.message = "For your approval" -data.signer_roles = [role_1, role_2] -data.cc_roles = ["Manager"] -data.merge_fields = [merge_field_1, merge_field_2] -data.field_options = field_options -data.test_mode = true +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 - result = template_api.template_create_embedded_draft(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_create_embedded_draft: #{e}" end ``` @@ -306,25 +364,20 @@ Completely deletes the template specified from the account. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - result = template_api.template_delete(template_id) - p result + Dropbox::Sign::TemplateApi.new.template_delete( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_delete: #{e}" end ``` @@ -378,25 +431,22 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - file_bin = template_api.template_files(template_id) - FileUtils.cp(file_bin.path, "path/to/file.pdf") + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_files: #{e}" end ``` @@ -451,25 +501,22 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - result = template_api.template_files_as_data_uri(template_id) - p result + response = Dropbox::Sign::TemplateApi.new.template_files_as_data_uri( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_files_as_data_uri: #{e}" end ``` @@ -523,25 +570,25 @@ Obtain a copy of the current documents specified by the `template_id` parameter. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "5de8179668f2033afac48da1868d0093bf133266" - begin - result = template_api.template_files_as_file_url(template_id) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_files_as_file_url: #{e}" end ``` @@ -596,25 +643,22 @@ Returns the Template specified by the `template_id` parameter. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -template_id = "f57db65d3f933b5316d398057a36176831451a35" - begin - result = template_api.template_get(template_id) - p result + response = Dropbox::Sign::TemplateApi.new.template_get( + "f57db65d3f933b5316d398057a36176831451a35", # template_id + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_get: #{e}" end ``` @@ -668,25 +712,27 @@ Returns a list of the Templates that are accessible by you. Take a look at our ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -account_id = "f57db65d3f933b5316d398057a36176831451a35" - begin - result = template_api.template_list({ account_id: account_id }) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_list: #{e}" end ``` @@ -743,28 +789,26 @@ Removes the specified Account's access to the specified Template. ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateRemoveUserRequest.new -data.email_address = "george@dropboxsign.com" - -template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536" +template_remove_user_request = Dropbox::Sign::TemplateRemoveUserRequest.new +template_remove_user_request.email_address = "george@dropboxsign.com" begin - result = template_api.template_remove_user(template_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_remove_user: #{e}" end ``` @@ -819,28 +863,28 @@ Overlays a new file with the overlay of an existing template. The new file(s) mu ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -template_api = Dropbox::Sign::TemplateApi.new - -data = Dropbox::Sign::TemplateUpdateFilesRequest.new -data.files = [File.new("example_signature_request.pdf", "r")] - -template_id = "5de8179668f2033afac48da1868d0093bf133266" +template_update_files_request = Dropbox::Sign::TemplateUpdateFilesRequest.new +template_update_files_request.files = [ + File.new("./example_signature_request.pdf", "r"), +] begin - result = template_api.template_update_files(template_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling TemplateApi#template_update_files: #{e}" end ``` diff --git a/sdks/ruby/docs/UnclaimedDraftApi.md b/sdks/ruby/docs/UnclaimedDraftApi.md index 8858f002d..2ce820254 100644 --- a/sdks/ruby/docs/UnclaimedDraftApi.md +++ b/sdks/ruby/docs/UnclaimedDraftApi.md @@ -21,61 +21,39 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -signer_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new -signer_1.email_address = "jack@example.com" -signer_1.name = "Jack" -signer_1.order = 0 - -signer_2 = Dropbox::Sign::SubUnclaimedDraftSigner.new -signer_2.email_address = "jill@example.com" -signer_2.name = "Jill" -signer_2.order = 1 - -signing_options = Dropbox::Sign::SubSigningOptions.new -signing_options.draw = true -signing_options.type = true -signing_options.upload = true -signing_options.phone = false -signing_options.default_type = "draw" - -field_options = Dropbox::Sign::SubFieldOptions.new -field_options.date_format = "DD - MM - YYYY" - -data = Dropbox::Sign::UnclaimedDraftCreateRequest.new -data.subject = "The NDA we talked about" -data.type = "request_signature" -data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions." -data.signers = [signer_1, signer_2] -data.cc_email_addresses = [ - "lawyer1@dropboxsign.com", - "lawyer2@dropboxsign.com", +signers_1 = Dropbox::Sign::SubUnclaimedDraftSigner.new +signers_1.name = "Jack" +signers_1.email_address = "jack@example.com" +signers_1.order = 0 + +signers = [ + signers_1, ] -data.files = [File.new("example_signature_request.pdf", "r")] -data.metadata = { - custom_id: 1234, - custom_text: "NDA #9", -} -data.signing_options = signing_options -data.field_options = field_options -data.test_mode = true + +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 - result = unclaimed_draft_api.unclaimed_draft_create(data) - p result + response = Dropbox::Sign::UnclaimedDraftApi.new.unclaimed_draft_create( + unclaimed_draft_create_request, + ) + + p response rescue Dropbox::Sign::ApiError => e - puts "Exception when calling Dropbox Sign API: #{e}" + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create: #{e}" end ``` @@ -129,29 +107,30 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.files = [File.new("example_signature_request.pdf", "r")] -data.requester_email_address = "jack@dropboxsign.com" -data.test_mode = true +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 - result = unclaimed_draft_api.unclaimed_draft_create_embedded(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded: #{e}" end ``` @@ -205,40 +184,49 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new +ccs_1 = Dropbox::Sign::SubCC.new +ccs_1.role = "Accounting" +ccs_1.email_address = "accounting@dropboxsign.com" -signer_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new -signer_1.role = "Client" -signer_1.name = "George" -signer_1.email_address = "george@example.com" +ccs = [ + ccs_1, +] -cc_1 = Dropbox::Sign::SubCC.new -cc_1.role = "Accounting" -cc_1.email_address = "accounting@example.com" +signers_1 = Dropbox::Sign::SubUnclaimedDraftTemplateSigner.new +signers_1.role = "Client" +signers_1.name = "George" +signers_1.email_address = "george@example.com" -data = Dropbox::Sign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.template_ids = ["61a832ff0d8423f91d503e76bfbcc750f7417c78"] -data.requester_email_address = "jack@dropboxsign.com" -data.signers = [signer_1] -data.ccs = [cc_1] -data.test_mode = true +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 - result = unclaimed_draft_api.unclaimed_draft_create_embedded_with_template(data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_create_embedded_with_template: #{e}" end ``` @@ -292,29 +280,27 @@ Creates a new signature request from an embedded request that can be edited prio ### Examples ```ruby +require "json" require "dropbox-sign" Dropbox::Sign.configure do |config| - # Configure HTTP basic authorization: api_key config.username = "YOUR_API_KEY" - - # or, configure Bearer (JWT) authorization: oauth2 # config.access_token = "YOUR_ACCESS_TOKEN" end -unclaimed_draft_api = Dropbox::Sign::UnclaimedDraftApi.new - -data = Dropbox::Sign::UnclaimedDraftEditAndResendRequest.new -data.client_id = "ec64a202072370a737edf4a0eb7f4437" -data.test_mode = true - -signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f" +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 - result = unclaimed_draft_api.unclaimed_draft_edit_and_resend(signature_request_id, data) - p result + 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 Dropbox Sign API: #{e}" + puts "Exception when calling UnclaimedDraftApi#unclaimed_draft_edit_and_resend: #{e}" end ``` diff --git a/sdks/ruby/openapi-config.yaml b/sdks/ruby/openapi-config.yaml index ccbf1d9b6..2e700b355 100644 --- a/sdks/ruby/openapi-config.yaml +++ b/sdks/ruby/openapi-config.yaml @@ -16,6 +16,9 @@ additionalProperties: gitRepoId: dropbox-sign-ruby useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.printApiCallProperty: true + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-event_callback_helper.mustache: templateType: SupportingFiles