Class: Twilio::REST::IpMessaging::V2::ServiceContext::BindingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ BindingList

Initialize the BindingList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 20

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Bindings"
end

Instance Method Details

#each ⇒ Object

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



75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 75

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of BindingInstance records from the API. Request is executed immediately.



113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 113

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  BindingPage.new(@version, response, @solution)
end

#list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) ⇒ Array

Lists BindingInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.



41
42
43
44
45
46
47
48
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 41

def list(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
  self.stream(
      binding_type: binding_type,
      identity: identity,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of BindingInstance records from the API. Request is executed immediately.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 94

def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'BindingType' => Twilio.serialize_list(binding_type) { |e| e },
      'Identity' => Twilio.serialize_list(identity) { |e| e },
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  BindingPage.new(@version, response, @solution)
end

#stream(binding_type: :unset, identity: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams BindingInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



63
64
65
66
67
68
69
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 63

def stream(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(binding_type: binding_type, identity: identity, page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



123
124
125
 
# File 'lib/twilio-ruby/rest/ip_messaging/v2/service/binding.rb', line 123

def to_s
  '#<Twilio.IpMessaging.V2.BindingList>'
end