Class: Twilio::REST::Messaging::V1::BrandRegistrationList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/brand_registration.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ BrandRegistrationList

Initialize the BrandRegistrationList

Parameters:

  • version (Version) —

    Version that contains the resource


20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/a2p/BrandRegistrations"
end

Instance Method Details

#create(customer_profile_bundle_sid: nil, a2p_profile_bundle_sid: nil, brand_type: :unset, mock: :unset, skip_automatic_sec_vet: :unset) ⇒ BrandRegistrationInstance

Create the BrandRegistrationInstance

Parameters:

  • customer_profile_bundle_sid (String) (defaults to: nil) —

    Customer Profile Bundle Sid.

  • a2p_profile_bundle_sid (String) (defaults to: nil) —

    A2P Messaging Profile Bundle Sid.

  • brand_type (String) (defaults to: :unset) —

    Type of brand being created. One of: “STANDARD”, “STARTER”. STARTER is for low volume, starter use cases. STANDARD is for all other use cases.

  • mock (Boolean) (defaults to: :unset) —

    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.

  • skip_automatic_sec_vet (Boolean) (defaults to: :unset) —

    A flag to disable automatic secondary vetting for brands which it would otherwise be done.

Returns:


121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 121

def create(customer_profile_bundle_sid: nil, a2p_profile_bundle_sid: nil, brand_type: :unset, mock: :unset, skip_automatic_sec_vet: :unset)
  data = Twilio::Values.of({
      'CustomerProfileBundleSid' => customer_profile_bundle_sid,
      'A2PProfileBundleSid' => a2p_profile_bundle_sid,
      'BrandType' => brand_type,
      'Mock' => mock,
      'SkipAutomaticSecVet' => skip_automatic_sec_vet,
  })

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

  BrandRegistrationInstance.new(@version, payload, )
end

#each ⇒ Object

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


66
67
68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 66

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of BrandRegistrationInstance


100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 100

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

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

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

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Array) —

    Array of up to limit results


39
40
41
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 39

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

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of BrandRegistrationInstance


83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 83

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)

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

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

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

Parameters:

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    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)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results


54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 54

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


137
138
139
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 137

def to_s
  '#<Twilio.Messaging.V1.BrandRegistrationList>'
end