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

Instance Method Summary collapse

Constructor Details

#initialize(version, brand_sid: nil) ⇒ BrandVettingList

Initialize the BrandVettingList

Parameters:

  • version (Version) —

    Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 28

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 (VettingProvider) (defaults to: nil)
  • vetting_id (String) (defaults to: :unset) —

    The unique ID of the vetting

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 41

def create(
    vetting_provider: nil, 
    vetting_id: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    BrandVettingInstance.new(
        @version,
        payload,
        brand_sid: @solution[:brand_sid],
    )
end

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

Create the BrandVettingInstanceMetadata

Parameters:

  • vetting_provider (VettingProvider) (defaults to: nil)
  • vetting_id (String) (defaults to: :unset) —

    The unique ID of the vetting

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 70

def create_with_metadata(
  vetting_provider: nil, 
  vetting_id: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    brand_vetting_instance = BrandVettingInstance.new(
        @version,
        response.body,
        brand_sid: @solution[:brand_sid],
    )
    BrandVettingInstanceMetadata.new(
        @version,
        brand_vetting_instance,
        response.headers,
        response.status_code
    )
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.



171
172
173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 171

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



210
211
212
213
214
215
216
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 210

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 (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



113
114
115
116
117
118
119
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 113

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

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

Returns Array of up to limit results.

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



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 153

def list_with_metadata(vetting_provider: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'VettingProvider' => vetting_provider,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

    BrandVettingPageMetadata.new(@version, response, @solution, limits[:limit])
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 (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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 189

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,
    })
    headers = Twilio::Values.of({})
    
    

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

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

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

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

Parameters:

  • vetting_provider (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



133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 133

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



221
222
223
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 221

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