Module: HelloSign::Api::Team

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

Overview

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

Author:

  • hellosign

Instance Method Summary collapse

Instance Method Details

#add_member_to_team(opts) ⇒ HelloSign::Resource::Team

Adds or invites a user (specified using the email_address parameter) to your Team. If the user does not currently have a HelloSign Account, a new one will be created for them. If the user currently has a paid subscription, they will not automatically join the Team but instead will be sent an invitation to join. If a user is already a part of another Team, a “team_invite_failed” error will be returned.

Examples:

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

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • account_id (String) —

    The id of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.

  • email_address (String) —

    The email address of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.

Returns:



70
71
72
 
# File 'lib/hello_sign/api/team.rb', line 70

def add_member_to_team opts
  HelloSign::Resource::Team.new post("/team/add_member", :body => opts)
end

#create_team(opts) ⇒ HelloSign::Resource::Team

Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.

Examples:

team = @client.create_team :name => 'Team America World Police'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • name (String) —

    The name of your Team

Returns:



33
34
35
 
# File 'lib/hello_sign/api/team.rb', line 33

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

#destroy_team ⇒ Object

Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).

Examples:

team = @client.destroy_team


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

def destroy_team
  post("/team/destroy")
end

#get_team ⇒ HelloSign::Resource::Team

Returns information about your Team as well as a list of its members. If you do not belong to a Team, HelloSign::Error::NotFound will be raised

Examples:

team = @client.get_team

Returns:



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

def get_team
  HelloSign::Resource::Team.new get("/team")
end

#remove_member_from_team(opts) ⇒ HelloSign::Resource::Team

Removes a user from your Team. If the user had an outstanding invitation to your Team the invitation will be expired.

Examples:

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

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • account_id (String) —

    The id of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.

  • email_address (String) —

    The email address of the Account of the user to invite to your Team. The account id prevails if both email_address and acccount_id are provided.

Returns:



83
84
85
 
# File 'lib/hello_sign/api/team.rb', line 83

def remove_member_from_team opts
  HelloSign::Resource::Team.new post("/team/remove_member", :body => opts)
end

#update_team(opts) ⇒ HelloSign::Resource::Team

Updates the name of your Team.

Examples:

team = @client.update_team :name => 'New Team Name'

Parameters:

  • opts (Hash) —

    a customizable set of options

Options Hash (opts):

  • name (String) —

    The name of your Team

Returns:



45
46
47
 
# File 'lib/hello_sign/api/team.rb', line 45

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