class Twilio::REST::IpMessaging::V2::ServiceContext::BindingList

Public Class Methods

new(version, service_sid: nil) click to toggle source

Initialize the BindingList @param [Version] version Version that contains the resource @param [String] service_sid The service_sid @return [BindingList] BindingList

Calls superclass method Twilio::REST::ListResource::new
   # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
20 def initialize(version, service_sid: nil)
21   super(version)
22 
23   # Path Solution
24   @solution = {service_sid: service_sid}
25   @uri = "/Services/#{@solution[:service_sid]}/Bindings"
26 end

Public Instance Methods

each() { |x| ... } click to toggle source

When passed a block, yields BindingInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
75 def each
76   limits = @version.read_limits
77 
78   page = self.page(page_size: limits[:page_size], )
79 
80   @version.stream(page,
81                   limit: limits[:limit],
82                   page_limit: limits[:page_limit]).each {|x| yield x}
83 end
get_page(target_url) click to toggle source

Retrieve a single page of BindingInstance records from the API. Request is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page of BindingInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
113 def get_page(target_url)
114   response = @version.domain.request(
115       'GET',
116       target_url
117   )
118   BindingPage.new(@version, response, @solution)
119 end
list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) click to toggle source

Lists BindingInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Array] binding_type The binding_type @param [Array] identity The identity @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit.  Default is no limit

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records.  If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Array] Array of up to limit results

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
41 def list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
42   self.stream(
43       binding_type: binding_type,
44       identity: identity,
45       limit: limit,
46       page_size: page_size
47   ).entries
48 end
page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) click to toggle source

Retrieve a single page of BindingInstance records from the API. Request is executed immediately. @param [Array] binding_type The binding_type @param [Array] identity The identity @param [String] page_token PageToken provided by the API @param [Integer] page_number Page Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page of BindingInstance

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
 94 def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
 95   params = Twilio::Values.of({
 96       'BindingType' => Twilio.serialize_list(binding_type) { |e| e },
 97       'Identity' => Twilio.serialize_list(identity) { |e| e },
 98       'PageToken' => page_token,
 99       'Page' => page_number,
100       'PageSize' => page_size,
101   })
102 
103   response = @version.page('GET', @uri, params: params)
104 
105   BindingPage.new(@version, response, @solution)
106 end
stream(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) click to toggle source

Streams BindingInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Array] binding_type The binding_type @param [Array] identity The identity @param [Integer] limit Upper limit for the number of records to return. stream()

guarantees to never return more than limit. Default is no limit.

@param [Integer] page_size Number of records to fetch per request, when

not set will use the default value of 50 records. If no page_size is defined
but a limit is defined, stream() will attempt to read the limit with the most
efficient page size, i.e. min(limit, 1000)

@return [Enumerable] Enumerable that will yield up to limit results

   # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
63 def stream(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
64   limits = @version.read_limits(limit, page_size)
65 
66   page = self.page(binding_type: binding_type, identity: identity, page_size: limits[:page_size], )
67 
68   @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
69 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb
123 def to_s
124   '#<Twilio.IpMessaging.V2.BindingList>'
125 end