Class: Twilio::REST::Messaging::V1::BrandRegistrationContext::BrandVettingList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.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, brand_sid: nil) ⇒ BrandVettingList

Initialize the BrandVettingList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The unique string to identify Brand Registration.


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

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

  # Path Solution
  @solution = {brand_sid: brand_sid}
  @uri = "/a2p/BrandRegistrations/#{@solution[:brand_sid]}/Vettings"
end

Instance Method Details

#create(vetting_provider: nil, vetting_id: :unset) ⇒ BrandVettingInstance

Create the BrandVettingInstance

Parameters:

  • vetting_provider (brand_vetting.VettingProvider) (defaults to: nil) —

    The third-party provider of the vettings to create .

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

    The unique ID of the vetting

Returns:


36
37
38
39
40
41
42
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 36

def create(vetting_provider: nil, vetting_id: :unset)
  data = Twilio::Values.of({'VettingProvider' => vetting_provider, 'VettingId' => vetting_id, })

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

  BrandVettingInstance.new(@version, payload, brand_sid: @solution[:brand_sid], )
end

#each ⇒ Object

When passed a block, yields BrandVettingInstance 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/messaging/v1/brand_registration/brand_vetting.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 BrandVettingInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of BrandVettingInstance


123
124
125
126
127
128
129
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 123

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

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

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

Parameters:

  • vetting_provider (brand_vetting.VettingProvider) (defaults to: :unset) —

    The third-party provider of the vettings to read

  • 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


57
58
59
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 57

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

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

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

Parameters:

  • vetting_provider (brand_vetting.VettingProvider) (defaults to: :unset) —

    The third-party provider of the vettings to read

  • 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 BrandVettingInstance


105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 105

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

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

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

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

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

Parameters:

  • vetting_provider (brand_vetting.VettingProvider) (defaults to: :unset) —

    The third-party provider of the vettings to read

  • 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


74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 74

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

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


133
134
135
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 133

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