Class: Komoju::Subscriptions

Inherits:
Object
  • Object
show all
Defined in:
lib/komoju/client.rb

Overview

Subscription Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Subscriptions

Returns a new instance of Subscriptions.



262
263
264
 
# File 'lib/komoju/client.rb', line 262

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



283
284
285
 
# File 'lib/komoju/client.rb', line 283

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

#destroy(subscriptions_id) ⇒ Object

Destroy a subscription

Parameters:

  • subscriptions_id: —

    A unique identifier for a subscription.



290
291
292
 
# File 'lib/komoju/client.rb', line 290

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

#list(collection_options = {}) ⇒ Object

List subscriptions

Parameters:

  • collection_options: —

    additional collection options to pass with the request



269
270
271
 
# File 'lib/komoju/client.rb', line 269

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

#show(subscriptions_id) ⇒ Object

Show a subscription

Parameters:

  • subscriptions_id: —

    A unique identifier for a subscription.



276
277
278
 
# File 'lib/komoju/client.rb', line 276

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