Class: PlatformAPI::OrganizationMember

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

An organization member is an individual with access to an organization.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OrganizationMember

Returns a new instance of OrganizationMember.



1703
1704
1705
 
# File 'lib/platform-api/client.rb', line 1703

def initialize(client)
  @client = client
end

Instance Method Details

#create_or_update(organization_name, body = {}) ⇒ Object

Create a new organization member, or update their role.

Parameters:

  • organization_name: —

    unique name of organization

  • body: —

    the object to pass as the request payload



1711
1712
1713
 
# File 'lib/platform-api/client.rb', line 1711

def create_or_update(organization_name, body = {})
  @client.organization_member.create_or_update(organization_name, body)
end

#delete(organization_name, organization_member_email_or_app_id) ⇒ Object

Remove a member from the organization.

Parameters:

  • organization_name: —

    unique name of organization

  • organization_member_email_or_app_id: —

    email address of the organization member or unique identifier of app



1719
1720
1721
 
# File 'lib/platform-api/client.rb', line 1719

def delete(organization_name, organization_member_email_or_app_id)
  @client.organization_member.delete(organization_name, organization_member_email_or_app_id)
end

#list(organization_name) ⇒ Object

List members of the organization.

Parameters:

  • organization_name: —

    unique name of organization



1726
1727
1728
 
# File 'lib/platform-api/client.rb', line 1726

def list(organization_name)
  @client.organization_member.list(organization_name)
end