Class: Twilio::REST::ListResource
- Inherits:
-
Object
- Object
- Twilio::REST::ListResource
- Includes:
- Utils
- Defined in:
- lib/twilio-ruby/rest/list_resource.rb
Direct Known Subclasses
Accounts, Applications, AuthorizedConnectApps, AvailablePhoneNumbers, Calls, Conferences, ConnectApps, IncomingPhoneNumbers, Local, Members, Messages, Notifications, OutgoingCallerIds, Participants, Queues, Recordings, Records, ShortCodes, TollFree, Transcriptions, Triggers
Instance Method Summary collapse
-
#create(params = {}) ⇒ Object
Return a newly created resource.
-
#get(sid) ⇒ Object
(also: #find)
Return an empty instance resource object with the proper path.
-
#initialize(path, client) ⇒ ListResource
constructor
A new instance of ListResource.
-
#inspect ⇒ Object
:nodoc:.
-
#list(params = {}, full_path = false) ⇒ Object
Grab a list of this kind of resource and return it as an array.
-
#total ⇒ Object
Ask Twilio for the total number of items in the list.
Methods included from Utils
Constructor Details
#initialize(path, client) ⇒ ListResource
Returns a new instance of ListResource.
6 7 8 9 10 11 |
# File 'lib/twilio-ruby/rest/list_resource.rb', line 6 def initialize(path, client) @path, @client = path, client resource_name = self.class.name.split('::')[-1] @instance_class = Twilio::REST.const_get resource_name.chop @list_key, @instance_id_key = detwilify(resource_name), 'sid' end |
Instance Method Details
#create(params = {}) ⇒ Object
Return a newly created resource. Some params
may be required. Consult the Twilio REST API documentation related to the kind of resource you are attempting to create for details. Calling this method makes an HTTP POST request to @path
with the given params
80 81 82 83 84 85 |
# File 'lib/twilio-ruby/rest/list_resource.rb', line 80 def create(params={}) raise "Can't create a resource without a REST Client" unless @client response = @client.post @path, params @instance_class.new "#{@path}/#{response[@instance_id_key]}", @client, response end |
#get(sid) ⇒ Object Also known as: find
Return an empty instance resource object with the proper path. Note that this will never raise a Twilio::REST::RequestError on 404 since no HTTP request is made. The HTTP request is made when attempting to access an attribute of the returned instance resource object, such as its #date_created or #voice_url attributes.
70 71 72 |
# File 'lib/twilio-ruby/rest/list_resource.rb', line 70 def get(sid) @instance_class.new "#{@path}/#{sid}", @client end |
#inspect ⇒ Object
:nodoc:
13 14 15 |
# File 'lib/twilio-ruby/rest/list_resource.rb', line 13 def inspect # :nodoc: "<#{self.class} @path=#{@path}>" end |
#list(params = {}, full_path = false) ⇒ Object
Grab a list of this kind of resource and return it as an array. The array includes a special attribute named total
which will return the total number of items in the list on Twilio’s server. This may differ from the size
and length
attributes of the returned array since by default Twilio will only return 50 resources, and the maximum number of resources you can request is 1000.
The optional params
hash allows you to filter the list returned. The filters for each list resource type are defined by Twilio.
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/twilio-ruby/rest/list_resource.rb', line 27 def list(params={}, full_path=false) raise "Can't get a resource list without a REST Client" unless @client response = @client.get @path, params, full_path resources = response[@list_key] path = full_path ? @path.split('.')[0] : @path resource_list = resources.map do |resource| @instance_class.new "#{path}/#{resource[@instance_id_key]}", @client, resource end # set the +total+ and +next_page+ properties on the array client, list_class = @client, self.class resource_list.instance_eval do eigenclass = class << self; self; end eigenclass.send :define_method, :total, &lambda {response['total']} eigenclass.send :define_method, :next_page, &lambda { if response['next_page_uri'] list_class.new(response['next_page_uri'], client).list({}, true) else [] end } end resource_list end |
#total ⇒ Object
Ask Twilio for the total number of items in the list. Calling this method makes an HTTP GET request to @path
with a page size parameter of 1 to minimize data over the wire while still obtaining the total. Don’t use this if you are planning to call #list anyway, since the array returned from #list will have a total
attribute as well.
59 60 61 62 |
# File 'lib/twilio-ruby/rest/list_resource.rb', line 59 def total raise "Can't get a resource total without a REST Client" unless @client @client.get(@path, :page_size => 1)['total'] end |