Module: Pivit::Client::Membership

Included in:
Pivit::Client
Defined in:
lib/pivit/client/membership.rb

Overview

Membership management

See Also:

Instance Method Summary collapse

Instance Method Details

#create_membership(project_id, email, role, options = {}) ⇒ Hashie::Mash

Create a membership

Provide the parameters you want to use for the membership via the options hash.

Examples:

Pivit::Client.create_membership(12345, "[email protected]", "Member")

Parameters:

  • project_id (Integer) —

    the id of the project that contains the membership

  • email (String) —

    the email address of the member that is being added

  • role (String) —

    the role of the member that is being added

Returns:

  • (Hashie::Mash) —

    membership created response

See Also:

Author:

  • Jason Truluck



58
59
60
61
 
# File 'lib/pivit/client/membership.rb', line 58

def create_membership(project_id, email, role,  options = {})
  options.merge!({ :membership => { :role => role, :person => { :email => email }}})
  post("projects/#{project_id}/memberships", options).membership
end

#delete_membership(project_id, membership_id, options = {}) ⇒ Hashie::Mash

Delete a membership

Examples:

Pivit::Client.update_membership(12345, 11111)

Parameters:

  • project_id (Integer) —

    the id of the project that contains the membership

  • membership_id (Integer) —

    the id of the membership that is getting deleted

Returns:

  • (Hashie::Mash) —

    membership deleted response

See Also:

Author:

  • Jason Truluck



76
77
78
 
# File 'lib/pivit/client/membership.rb', line 76

def delete_membership(project_id, membership_id, options = {})
  delete("projects/#{project_id}/memberships/#{membership_id}", options).membership
end

#membership(project_id, membership_id, options = {}) ⇒ Hashie::Mash

Retrieve a single membership from your account

Examples:

Pivit::Client.membership(1111111, 123456)

Parameters:

  • project_id (Integer) —

    the id of the project that you want to retrieve memberships from

  • membership_id (Integer) —

    the id of the membership that you want to retrieve

Returns:

  • (Hashie::Mash) —

    membership response

See Also:

Author:

  • Jason Truluck



22
23
24
 
# File 'lib/pivit/client/membership.rb', line 22

def membership(project_id, membership_id, options = {})
  get("projects/#{project_id}/memberships/#{membership_id}", options).memberships.first
end

#memberships(project_id, options = {}) ⇒ Hashie::Mash

Retrieve all memberships from your account

Examples:

Pivit::Client.memberships(1111111)

Parameters:

  • project_id (Integer) —

    the id of the project that contains the memberships

Returns:

  • (Hashie::Mash) —

    memberships response

See Also:

Author:

  • Jason Truluck



38
39
40
 
# File 'lib/pivit/client/membership.rb', line 38

def memberships(project_id, options = {})
  get("projects/#{project_id}/memberships", options).memberships
end