Module: Insightly2::DSL::TeamMembers

Included in:
Insightly2::DSL
Defined in:
lib/insightly2/dsl/team_members.rb

Instance Method Summary collapse

Instance Method Details

#create_team_member(team_member: nil) ⇒ Insightly2::Resources::TeamMember?

POST /v2.1/TeamMembers Create a team member.

Parameters:

  • team_member (Hash) (defaults to: nil) —

    The team_member we’re creating.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



28
29
30
31
 
# File 'lib/insightly2/dsl/team_members.rb', line 28

def create_team_member(team_member: nil)
  raise ArgumentError, "Team member cannot be blank" if team_member.blank?
  Resources::TeamMember.parse(request(:post, "TeamMembers", team_member))
end

#delete_team_member(id: nil) ⇒ Faraday::Response

DELETE /v2.1/TeamMembers/id Delete a team member.

Parameters:

  • id (String, Fixnum) (defaults to: nil) —

    A team member’s ID.

Returns:

  • (Faraday::Response) —

    .

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



48
49
50
51
 
# File 'lib/insightly2/dsl/team_members.rb', line 48

def delete_team_member(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  request(:delete, "TeamMembers/#{id}")
end

#get_team_member(id: nil) ⇒ Insightly2::Resources::TeamMember?

GET /v2.1/TeamMembers/id Get a team member.

Parameters:

  • id (String, Fixnum) (defaults to: nil) —

    A team member’s ID.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



10
11
12
13
 
# File 'lib/insightly2/dsl/team_members.rb', line 10

def get_team_member(id: nil)
  raise ArgumentError, "ID cannot be blank" if id.blank?
  Resources::TeamMember.parse(request(:get, "TeamMembers/#{id}"))
end

#get_team_members(team_id: nil) ⇒ Array?

GET /v2.1/TeamMembers?teamid=teamid Get a list of team members.

Parameters:

  • team_id: (String, Fixnum) (defaults to: nil) —

    The ID of the team we’re getting members for (optional).

Returns:

  • (Array, nil) 


19
20
21
 
# File 'lib/insightly2/dsl/team_members.rb', line 19

def get_team_members(team_id: nil)
  Resources::TeamMember.parse(request(:get, "TeamMembers/?teamid=#{team_id}"))
end

#update_team_member(team_member: nil) ⇒ Insightly2::Resources::TeamMember?

PUT /v2.1/TeamMembers Update a team member.

Parameters:

  • team_member (Hash) (defaults to: nil) —

    The team_member we’re updating.

Returns:

Raises:

  • (ArgumentError) —

    If the method arguments are blank.



38
39
40
41
 
# File 'lib/insightly2/dsl/team_members.rb', line 38

def update_team_member(team_member: nil)
  raise ArgumentError, "Team member cannot be blank" if team_member.blank?
  Resources::TeamMember.parse(request(:put, "TeamMembers", team_member))
end