Class: Komoju::Plans

Inherits:

Object

• Object
• Komoju::Plans

Defined in:

lib/komoju/client.rb

Overview

Subscription Plans

Instance Method Summary

• #create(body) ⇒ Object

  Create a plan.

• #delete(plans_name) ⇒ Object

  Delete a plan.

• #initialize(client) ⇒ Plans constructor

  A new instance of Plans.

• #list(collection_options = {}) ⇒ Object

  List plans.

• #show(plans_name) ⇒ Object

  Show a plan.

Constructor Details

#initialize(client) ⇒ Plans

Returns a new instance of Plans.

# File 'lib/komoju/client.rb', line 419

def initialize(client)
  @client = client
end

Instance Method Details

#create(body) ⇒ Object

Create a plan

Parameters:

• body: —

  the object to pass as the request payload

# File 'lib/komoju/client.rb', line 440

def create(body)
  @client.plans.create(body)
end

#delete(plans_name) ⇒ Object

Delete a plan

Parameters:

• plans_name: —

  Name of the plan.

# File 'lib/komoju/client.rb', line 447

def delete(plans_name)
  @client.plans.delete(plans_name)
end

#list(collection_options = {}) ⇒ Object

List plans

Parameters:

• collection_options: —

  additional collection options to pass with the request

# File 'lib/komoju/client.rb', line 426

def list(collection_options = {})
  @client.plans.list(collection_options)
end

#show(plans_name) ⇒ Object

Show a plan

Parameters:

• plans_name: —

  Name of the plan.

# File 'lib/komoju/client.rb', line 433

def show(plans_name)
  @client.plans.show(plans_name)
end