Class: PlatformAPI::OrganizationFeature

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

Overview

Deprecated: An organization feature represents a feature enabled on an organization account.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ OrganizationFeature

Returns a new instance of OrganizationFeature.



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

def initialize(client)
  @client = client
end

Instance Method Details

#info(organization_name_or_organization_id, organization_feature_id_or_organization_feature_name) ⇒ Object

Info for an existing organization feature.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization

  • organization_feature_id_or_organization_feature_name:

    unique identifier of organization feature or unique name of organization feature



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

def info(organization_name_or_organization_id, organization_feature_id_or_organization_feature_name)
  @client.organization_feature.info(organization_name_or_organization_id, organization_feature_id_or_organization_feature_name)
end

#list(organization_name_or_organization_id) ⇒ Object

List existing organization features.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization



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

def list(organization_name_or_organization_id)
  @client.organization_feature.list(organization_name_or_organization_id)
end

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

Update an existing organization feature.

Parameters:

  • organization_name_or_organization_id:

    unique name of organization or unique identifier of organization

  • organization_feature_id_or_organization_feature_name:

    unique identifier of organization feature or unique name of organization feature

  • body:

    the object to pass as the request payload



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

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