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.

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'

Options Hash (opts):

  • email_address (String) —

    New user’s email address

  • password (String) —

    New user’s password



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

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

#get_account ⇒ HelloSign::Resource::Account

Returns the current user’s account information.

Examples:

 = @client.



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

def 
  HelloSign::Resource::.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'

Options Hash (opts):

  • callback_url (String) —

    New user’s callback url



54
55
56
 
# File 'lib/hello_sign/api/account.rb', line 54

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

#verify(opts) ⇒ Bool

Check whether an account exists

Examples:

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

Options Hash (opts):

  • email_address (String) —

    user email



67
68
69
 
# File 'lib/hello_sign/api/account.rb', line 67

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