Class: Twilio::REST::Verify::V2::ServiceContext::MessagingConfigurationList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ MessagingConfigurationList

Initialize the MessagingConfigurationList



22
23
24
25
26
27
28
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 22

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

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

Instance Method Details

#create(country: nil, messaging_service_sid: nil) ⇒ MessagingConfigurationInstance

Create the MessagingConfigurationInstance



40
41
42
43
44
45
46
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 40

def create(country: nil, messaging_service_sid: nil)
  data = Twilio::Values.of({'Country' => country, 'MessagingServiceSid' => messaging_service_sid, })

  payload = @version.create('POST', @uri, data: data)

  MessagingConfigurationInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

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



86
87
88
89
90
91
92
93
94
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 86

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 MessagingConfigurationInstance records from the API. Request is executed immediately.



120
121
122
123
124
125
126
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 120

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

#list(limit: nil, page_size: nil) ⇒ Array

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



59
60
61
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 59

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

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

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



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 103

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

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

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

#stream(limit: nil, page_size: nil) ⇒ Enumerable

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



74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 74

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

  page = self.page(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



130
131
132
 
# File 'lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb', line 130

def to_s
  '#<Twilio.Verify.V2.MessagingConfigurationList>'
end