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 API Documentation on the Account resource (app.hellosign.com/api/reference#Account) 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 need to confirm the email address to complete the creation process.

Examples:

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

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • email_address (String) —

    New user’s email address

Returns:



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

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:



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

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

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

Updates the current user’s Account 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 callback URL

Returns:



62
63
64
 
# File 'lib/hello_sign/api/account.rb', line 62

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

#verify(opts) ⇒ Bool

Checks 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’s email address

Returns:

  • (Bool) —

    true if exists, else false



73
74
75
 
# File 'lib/hello_sign/api/account.rb', line 73

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