Module: HelloSign::Api::Account

Included in:
Client
Defined in:
lib/hello_sign/api/account.rb

Overview

Contains all the api calls for the Account resource. Take a look at our account api document for more information about this.

Author:

  • hellosign

Instance Method Summary collapse

Instance Method Details

#create_account(opts) ⇒ HelloSign::Resource::Account

Creates a new HelloSign account. The user will still need to validate their email address to complete the creation process.

Note: This request does not require authentication.

Examples:

 = @client. :email_address => '[email protected]', :password => 'securePW'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • email_address (String) —

    New user’s email address

  • password (String) —

    New user’s password

Returns:



39
40
41
 
# File 'lib/hello_sign/api/account.rb', line 39

def (opts)
  HelloSign::Resource::Account.new post('/account/create', :body => opts)
end

#get_account ⇒ HelloSign::Resource::Account

Returns the current user’s account information.

Examples:

 = @client.

Returns:



21
22
23
 
# File 'lib/hello_sign/api/account.rb', line 21

def 
  HelloSign::Resource::Account.new get('/account')
end

#update_account(opts) ⇒ HelloSign::Resource::Account

Updates the current user’s callback URL

Examples:

 = @client. :callback_url => 'https://www.example.com/callback'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • callback_url (String) —

    New user’s callback url

Returns:



52
53
54
 
# File 'lib/hello_sign/api/account.rb', line 52

def (opts)
  HelloSign::Resource::Account.new post('/account', :body => opts)
end

#verify(opts) ⇒ Bool

Check whether an account exists

Examples:

 = @client.verify :email_address => '[email protected]'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • email_address (String) —

    user email

Returns:

  • (Bool) —

    true if exists, else false



64
65
66
 
# File 'lib/hello_sign/api/account.rb', line 64

def verify(opts)
  post('/account/verify', :body => opts).empty? ? false : true
end