Module: Lelylan::Client::Subscription
- Included in:
- Lelylan::Client
- Defined in:
- lib/lelylan/client/subscription.rb
Instance Method Summary collapse
-
#create_subscription(params = {}) ⇒ Object
Public: Create a subscription and returns extended information for it.
-
#delete_subscription(id) ⇒ Object
Public: Delete a subscription identified from its ID and returns extended information for it.
-
#subscription(id) ⇒ Object
Public: Returns extended information for a given subscription identified from its ID.
-
#subscriptions(params = {}) ⇒ Object
Public: Returns a list of owned subscriptions.
-
#update_subscription(id, params = {}) ⇒ Object
Public: Update a subscription identified from its ID and returns extended information for it.
Instance Method Details
#create_subscription(params = {}) ⇒ Object
Public: Create a subscription and returns extended information for it.
params - The Hash used to create the resource (default: {}).
Returns Hashie The created subscription.
34 35 36 |
# File 'lib/lelylan/client/subscription.rb', line 34 def create_subscription(params = {}) post('/subscriptions', params) end |
#delete_subscription(id) ⇒ Object
Public: Delete a subscription identified from its ID and returns extended information for it.
id - A String that represent the subscription ID.
Returns Hashie The deleted subscription.
57 58 59 |
# File 'lib/lelylan/client/subscription.rb', line 57 def delete_subscription(id) delete("/subscriptions/#{id}") end |
#subscription(id) ⇒ Object
Public: Returns extended information for a given subscription identified from its ID.
id - A String that represent the subscription ID.
Returns Hashie The subscription.
12 13 14 |
# File 'lib/lelylan/client/subscription.rb', line 12 def subscription(id) get("/subscriptions/#{id}") end |
#subscriptions(params = {}) ⇒ Object
Public: Returns a list of owned subscriptions.
params - The Hash used to refine the search (default: {}).
Returns Array List of subscriptions.
23 24 25 |
# File 'lib/lelylan/client/subscription.rb', line 23 def subscriptions(params = {}) get('/subscriptions', params) end |
#update_subscription(id, params = {}) ⇒ Object
Public: Update a subscription identified from its ID and returns extended information for it.
id - A String that represent the subscription ID. params - The Hash used to update the resource (default: {}).
Returns Hashie The updated subscription.
46 47 48 |
# File 'lib/lelylan/client/subscription.rb', line 46 def update_subscription(id, params = {}) put("/subscriptions/#{id}", params) end |