Skip to content

AccountApi.md

Latest commit

 

History

History
296 lines (198 loc) · 7.39 KB

AccountApi.md

File metadata and controls

296 lines (198 loc) · 7.39 KB

Dropbox::Sign::AccountApi

All URIs are relative to https://api.hellosign.com/v3

Method HTTP request Description
account_create POST /account/create Create Account
account_get GET /account Get Account
account_update PUT /account Update Account
account_verify POST /account/verify Verify Account

account_create

<AccountCreateResponse> account_create(account_create_request)

Create Account

Creates a new Dropbox Sign Account that is associated with the specified email_address.

Examples

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

Using the account_create_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<AccountCreateResponse>, Integer, Hash)> account_create_with_http_info(account_create_request)

begin
  # Create Account
  data, status_code, headers = api_instance.account_create_with_http_info(account_create_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountCreateResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling AccountApi->account_create_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_create_request AccountCreateRequest

Return type

AccountCreateResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

account_get

<AccountGetResponse> account_get(opts)

Get Account

Returns the properties and settings of your Account.

Examples

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

Using the account_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<AccountGetResponse>, Integer, Hash)> account_get_with_http_info(opts)

begin
  # Get Account
  data, status_code, headers = api_instance.account_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountGetResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling AccountApi->account_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_id String account_id or email_address is required. If both are provided, the account id prevails. The ID of the Account. [optional]
email_address String account_id or email_address is required, If both are provided, the account id prevails. The email address of the Account. [optional]

Return type

AccountGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

account_update

<AccountGetResponse> account_update(account_update_request)

Update Account

Updates the properties and settings of your Account. Currently only allows for updates to the Callback URL and locale.

Examples

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

Using the account_update_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<AccountGetResponse>, Integer, Hash)> account_update_with_http_info(account_update_request)

begin
  # Update Account
  data, status_code, headers = api_instance.account_update_with_http_info(account_update_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountGetResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling AccountApi->account_update_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_update_request AccountUpdateRequest

Return type

AccountGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

account_verify

<AccountVerifyResponse> account_verify(account_verify_request)

Verify Account

Verifies whether an Dropbox Sign Account exists for the given email address.

Examples

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

Using the account_verify_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<AccountVerifyResponse>, Integer, Hash)> account_verify_with_http_info(account_verify_request)

begin
  # Verify Account
  data, status_code, headers = api_instance.account_verify_with_http_info(account_verify_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountVerifyResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling AccountApi->account_verify_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_verify_request AccountVerifyRequest

Return type

AccountVerifyResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json