Class: PlatformAPI::Organization

Inherits:
Object
  • Object
show all
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 collapse

Constructor Details

#initialize(client) ⇒ Organization

Returns a new instance of Organization.


1954
1955
1956
# File 'lib/platform-api/client.rb', line 1954

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a new organization.

Parameters:

  • body:

    the object to pass as the request payload


1981
1982
1983
# File 'lib/platform-api/client.rb', line 1981

def create(body = {})
  @client.organization.create(body)
end

#delete(organization_name_or_organization_id) ⇒ Object

Delete an existing organization.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization


1988
1989
1990
# File 'lib/platform-api/client.rb', line 1988

def delete(organization_name_or_organization_id)
  @client.organization.delete(organization_name_or_organization_id)
end

#info(organization_name_or_organization_id) ⇒ Object

Info for an organization.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization


1966
1967
1968
# File 'lib/platform-api/client.rb', line 1966

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

#listObject

List organizations in which you are a member.


1959
1960
1961
# File 'lib/platform-api/client.rb', line 1959

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

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

Update organization properties.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization

  • body:

    the object to pass as the request payload


1974
1975
1976
# File 'lib/platform-api/client.rb', line 1974

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