class Twilio::REST::Verify::V2::ServiceContext::MessagingConfigurationList
Public Class Methods
Initialize the MessagingConfigurationList
@param [Version] version Version
that contains the resource @param [String] service_sid The SID of the
{Service}[https://www.twilio.com/docs/verify/api/service] that the resource is associated with.
@return [MessagingConfigurationList] MessagingConfigurationList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb 22 def initialize(version, service_sid: nil) 23 super(version) 24 25 # Path Solution 26 @solution = {service_sid: service_sid} 27 @uri = "/Services/#{@solution[:service_sid]}/MessagingConfigurations" 28 end
Public Instance Methods
Create the MessagingConfigurationInstance
@param [String] country The
{ISO-3166-1}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
@param [String] messaging_service_sid The SID of the {Messaging
Service}[https://www.twilio.com/docs/sms/services/api] to be used to send SMS to the country of this configuration.
@return [MessagingConfigurationInstance] Created MessagingConfigurationInstance
# File lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb 40 def create(country: nil, messaging_service_sid: nil) 41 data = Twilio::Values.of({'Country' => country, 'MessagingServiceSid' => messaging_service_sid, }) 42 43 payload = @version.create('POST', @uri, data: data) 44 45 MessagingConfigurationInstance.new(@version, payload, service_sid: @solution[:service_sid], ) 46 end
When passed a block, yields MessagingConfigurationInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb 86 def each 87 limits = @version.read_limits 88 89 page = self.page(page_size: limits[:page_size], ) 90 91 @version.stream(page, 92 limit: limits[:limit], 93 page_limit: limits[:page_limit]).each {|x| yield x} 94 end
Retrieve a single page of MessagingConfigurationInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of MessagingConfigurationInstance
# File lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb 120 def get_page(target_url) 121 response = @version.domain.request( 122 'GET', 123 target_url 124 ) 125 MessagingConfigurationPage.new(@version, response, @solution) 126 end
Lists MessagingConfigurationInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @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/verify/v2/service/messaging_configuration.rb 59 def list(limit: nil, page_size: nil) 60 self.stream(limit: limit, page_size: page_size).entries 61 end
Retrieve a single page of MessagingConfigurationInstance
records from the API. Request
is executed immediately. @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 MessagingConfigurationInstance
# File lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb 103 def page(page_token: :unset, page_number: :unset, page_size: :unset) 104 params = Twilio::Values.of({ 105 'PageToken' => page_token, 106 'Page' => page_number, 107 'PageSize' => page_size, 108 }) 109 110 response = @version.page('GET', @uri, params: params) 111 112 MessagingConfigurationPage.new(@version, response, @solution) 113 end
Streams MessagingConfigurationInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @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/verify/v2/service/messaging_configuration.rb 74 def stream(limit: nil, page_size: nil) 75 limits = @version.read_limits(limit, page_size) 76 77 page = self.page(page_size: limits[:page_size], ) 78 79 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 80 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb 130 def to_s 131 '#<Twilio.Verify.V2.MessagingConfigurationList>' 132 end