Class: PlatformAPI::Plan

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

Overview

Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Plan

Returns a new instance of Plan.



2634
2635
2636
# File 'lib/platform-api/client.rb', line 2634

def initialize(client)
  @client = client
end

Instance Method Details

#info(plan_id_or_plan_name) ⇒ Object

Info for existing plan.

Parameters:

  • plan_id_or_plan_name:

    unique identifier of this plan or unique name of this plan



2641
2642
2643
# File 'lib/platform-api/client.rb', line 2641

def info(plan_id_or_plan_name)
  @client.plan.info(plan_id_or_plan_name)
end

#info_by_addon(addon_service_id_or_addon_service_name, plan_id_or_plan_name) ⇒ Object

Info for existing plan by Add-on.

Parameters:

  • addon_service_id_or_addon_service_name:

    unique identifier of this add-on-service or unique name of this add-on-service

  • plan_id_or_plan_name:

    unique identifier of this plan or unique name of this plan



2649
2650
2651
# File 'lib/platform-api/client.rb', line 2649

def info_by_addon(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
  @client.plan.info_by_addon(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
end

#list_by_addon(addon_service_id_or_addon_service_name) ⇒ Object

List existing plans by Add-on.

Parameters:

  • addon_service_id_or_addon_service_name:

    unique identifier of this add-on-service or unique name of this add-on-service



2656
2657
2658
# File 'lib/platform-api/client.rb', line 2656

def list_by_addon(addon_service_id_or_addon_service_name)
  @client.plan.list_by_addon(addon_service_id_or_addon_service_name)
end