module HelloSign::Api::Team
Contains all the API calls for the Team
resource. Take a look at our API Documentation on the Team
Resource
(app.hellosign.com/api/reference#Team) for more information about this.
@author [hellosign]
Public Instance Methods
Adds or invites a user to the 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 be emailed an invitation to join the Team
. If a user is already a part of a Team
, a “team_invite_failed” error will be returned. @option opts [String] account_id The user's Account
ID to invite to the Team
. @option opts [String] email_address The user's email address to invite to your Team
. Note: The account_id prevails if both email_address and acccount_id are provided.
@return [HelloSign::Resource::Team] a Team
@example
team = @client.add_member_to_team email_address: 'george@example.com'
# File lib/hello_sign/api/team.rb, line 88 def add_member_to_team(opts) HelloSign::Resource::Team.new post('/team/add_member', body: opts) end
Creates a new Team
and adds you as a member. You must not currently belong to a Team
. @option opts [String] name The name of the Team
.
@return [HelloSign::Resource::Team] a Team
@example
team = @client.create_team name: 'Team America World Police'
# File lib/hello_sign/api/team.rb, line 51 def create_team(opts) HelloSign::Resource::Team.new post('/team/create', body: opts) end
Returns member list and information about your Team
. If you do not belong to a Team
, HelloSign::Error::NotFound
will be raised
@return [HelloSign::Resource::Team] Current Team
@example
team = @client.get_team
# File lib/hello_sign/api/team.rb, line 40 def get_team HelloSign::Resource::Team.new get('/team') end
Removes a user from the Team
. If the user had an outstanding invitation to your Team
, the original invitation will expire. @option opts [String] account_id The user's Account
ID to remove from the Team
. @option opts [String] email_address The user's email address to remove from your Team
. @option opts [String] new_owner_email_address The Account's email address to receive all documents, API Apps (if applicable), and API key from removed account. (optional) Note: The account_id prevails if both email_address and acccount_id are provided.
@return [HelloSign::Resource::Team] updated Team
@example
team = @client.remove_member_from_team email_address: 'george@example.com'
# File lib/hello_sign/api/team.rb, line 102 def remove_member_from_team(opts) HelloSign::Resource::Team.new post('/team/remove_member', body: opts) end