Class: PlatformAPI::Organization

Inherits:

Object

• Object
• PlatformAPI::Organization

Defined in:

lib/platform-api/client.rb

Overview

Organizations allow you to manage access to a shared group of applications across your development team.

Instance Method Summary

• #info(organization_name) ⇒ Object

  Info for an organization.

• #initialize(client) ⇒ Organization constructor

  A new instance of Organization.

• #list ⇒ Object

  List organizations in which you are a member.

• #update(organization_name, body = {}) ⇒ Object

  Set or unset the organization as your default organization.

Constructor Details

#initialize(client) ⇒ Organization

Returns a new instance of Organization.

# File 'lib/platform-api/client.rb', line 1777

def initialize(client)
  @client = client
end

Instance Method Details

#info(organization_name) ⇒ Object

Info for an organization.

Parameters:

• organization_name: —

  unique name of organization

# File 'lib/platform-api/client.rb', line 1789

def info(organization_name)
  @client.organization.info(organization_name)
end

#list ⇒ Object

List organizations in which you are a member.

# File 'lib/platform-api/client.rb', line 1782

def list()
  @client.organization.list()
end

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

Set or unset the organization as your default organization.

Parameters:

• organization_name: —

  unique name of organization

• body: —

  the object to pass as the request payload

# File 'lib/platform-api/client.rb', line 1797

def update(organization_name, body = {})
  @client.organization.update(organization_name, body)
end