class Twilio::REST::Messaging::V1::BrandRegistrationList
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Public Class Methods
Initialize the BrandRegistrationList
@param [Version] version Version
that contains the resource @return [BrandRegistrationList] BrandRegistrationList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/messaging/v1/brand_registration.rb 20 def initialize(version) 21 super(version) 22 23 # Path Solution 24 @solution = {} 25 @uri = "/a2p/BrandRegistrations" 26 end
Public Instance Methods
Create the BrandRegistrationInstance
@param [String] customer_profile_bundle_sid Customer Profile Bundle Sid. @param [String] a2p_profile_bundle_sid A2P Messaging
Profile Bundle Sid. @param [String] brand_type Type of brand being created. One of: “STANDARD”,
"STARTER". STARTER is for low volume, starter use cases. STANDARD is for all other use cases.
@param [Boolean] mock A boolean that specifies whether brand should be a mock or
not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
@return [BrandRegistrationInstance] Created BrandRegistrationInstance
# File lib/twilio-ruby/rest/messaging/v1/brand_registration.rb 119 def create(customer_profile_bundle_sid: nil, a2p_profile_bundle_sid: nil, brand_type: :unset, mock: :unset) 120 data = Twilio::Values.of({ 121 'CustomerProfileBundleSid' => customer_profile_bundle_sid, 122 'A2PProfileBundleSid' => a2p_profile_bundle_sid, 123 'BrandType' => brand_type, 124 'Mock' => mock, 125 }) 126 127 payload = @version.create('POST', @uri, data: data) 128 129 BrandRegistrationInstance.new(@version, payload, ) 130 end
When passed a block, yields BrandRegistrationInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/messaging/v1/brand_registration.rb 66 def each 67 limits = @version.read_limits 68 69 page = self.page(page_size: limits[:page_size], ) 70 71 @version.stream(page, 72 limit: limits[:limit], 73 page_limit: limits[:page_limit]).each {|x| yield x} 74 end
Retrieve a single page of BrandRegistrationInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of BrandRegistrationInstance
# File lib/twilio-ruby/rest/messaging/v1/brand_registration.rb 100 def get_page(target_url) 101 response = @version.domain.request( 102 'GET', 103 target_url 104 ) 105 BrandRegistrationPage.new(@version, response, @solution) 106 end
Lists BrandRegistrationInstance
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/messaging/v1/brand_registration.rb 39 def list(limit: nil, page_size: nil) 40 self.stream(limit: limit, page_size: page_size).entries 41 end
Retrieve a single page of BrandRegistrationInstance
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 BrandRegistrationInstance
# File lib/twilio-ruby/rest/messaging/v1/brand_registration.rb 83 def page(page_token: :unset, page_number: :unset, page_size: :unset) 84 params = Twilio::Values.of({ 85 'PageToken' => page_token, 86 'Page' => page_number, 87 'PageSize' => page_size, 88 }) 89 90 response = @version.page('GET', @uri, params: params) 91 92 BrandRegistrationPage.new(@version, response, @solution) 93 end
Streams BrandRegistrationInstance
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/messaging/v1/brand_registration.rb 54 def stream(limit: nil, page_size: nil) 55 limits = @version.read_limits(limit, page_size) 56 57 page = self.page(page_size: limits[:page_size], ) 58 59 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 60 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/messaging/v1/brand_registration.rb 134 def to_s 135 '#<Twilio.Messaging.V1.BrandRegistrationList>' 136 end