Class: Komoju::Subscriptions

Inherits:

Object

• Object
• Komoju::Subscriptions

Defined in:

lib/komoju/client.rb

Overview

Subscription Resource

Instance Method Summary

• #create(body = {}) ⇒ Object

  Create a subscription.

• #destroy(subscriptions_id, body = {}) ⇒ Object

  Destroy a subscription.

• #initialize(client) ⇒ Subscriptions constructor

  A new instance of Subscriptions.

• #list(body = {}) ⇒ Object

  List subscriptions.

• #show(subscriptions_id) ⇒ Object

  Show a subscription.

Constructor Details

#initialize(client) ⇒ Subscriptions

Returns a new instance of Subscriptions.

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

def initialize(client)
  @client = client
end

Instance Method Details

#create(body = {}) ⇒ Object

Create a subscription

Parameters:

• body: —

  the object to pass as the request payload

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

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

#destroy(subscriptions_id, body = {}) ⇒ Object

Destroy a subscription

Parameters:

• subscriptions_id: —

  A unique identifier for a subscription.

• body: —

  the object to pass as the request payload

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

def destroy(subscriptions_id, body = {})
  @client.subscriptions.destroy(subscriptions_id, body)
end

#list(body = {}) ⇒ Object

List subscriptions

Parameters:

• body: —

  the object to pass as the request payload

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

def list(body = {})
  @client.subscriptions.list(body)
end

#show(subscriptions_id) ⇒ Object

Show a subscription

Parameters:

• subscriptions_id: —

  A unique identifier for a subscription.

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

def show(subscriptions_id)
  @client.subscriptions.show(subscriptions_id)
end