class Textmagic::REST::Schedules

Public Instance Methods

create(params={}) click to toggle source

Creating is not supported

   # File lib/textmagic-ruby/rest/scheduleds.rb
62 def create(params={})
63   raise '`create` method is not supported for this resource.'
64 end
delete(uid) click to toggle source

Delete scheduled message by ID. Returns true if success.

uid

Schedule message ID. Required.

Example:

r = client.schedules.delete 182981
Calls superclass method Textmagic::REST::ListResource#delete
   # File lib/textmagic-ruby/rest/scheduleds.rb
55 def delete(uid)
56   super uid
57 end
get(uid) click to toggle source

Get Schedule by ID. Returns Schedule object.

uid

Schedule ID. Required.

Example:

@scheduled = client.schedules.get 19011
Calls superclass method Textmagic::REST::ListResource#get
   # File lib/textmagic-ruby/rest/scheduleds.rb
14 def get(uid)
15   super uid
16 end
list(params={}) click to toggle source

Get all user scheduled messages. Returns PaginateResource object, contains array of Schedule objects.

The following params keys are supported:

page

Fetch specified results page. Defaults 1

limit

How many results on page. Defaults 10

Example:

@schedules = client.schedules.list
Calls superclass method Textmagic::REST::ListResource#list
   # File lib/textmagic-ruby/rest/scheduleds.rb
32 def list(params={})
33   [:search, 'search'].each do |search|
34     params.delete search
35   end
36   super params
37 end
update(uid, params={}) click to toggle source

Updating is not supported

   # File lib/textmagic-ruby/rest/scheduleds.rb
42 def update(uid, params={})
43   raise '`update` method is not supported for this resource.'
44 end