Class: PlatformAPI::Organization

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

Overview

Deprecated: 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.



2350
2351
2352
 
# File 'lib/platform-api/client.rb', line 2350

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



2377
2378
2379
 
# File 'lib/platform-api/client.rb', line 2377

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



2384
2385
2386
 
# File 'lib/platform-api/client.rb', line 2384

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



2362
2363
2364
 
# File 'lib/platform-api/client.rb', line 2362

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

#list ⇒ Object

List organizations in which you are a member.



2355
2356
2357
 
# File 'lib/platform-api/client.rb', line 2355

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



2370
2371
2372
 
# File 'lib/platform-api/client.rb', line 2370

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