Class: Twilio::REST::Messaging::V1::BrandRegistrationContext::BrandVettingInstance

Inherits:
InstanceResource
  • 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, payload, brand_sid: nil, brand_vetting_sid: nil) ⇒ BrandVettingInstance

Initialize the BrandVettingInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique string to identify Brand Registration.

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

    The Twilio SID of the third-party vetting record.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 228

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'brand_sid' => payload['brand_sid'],
      'brand_vetting_sid' => payload['brand_vetting_sid'],
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'vetting_id' => payload['vetting_id'],
      'vetting_class' => payload['vetting_class'],
      'vetting_status' => payload['vetting_status'],
      'vetting_provider' => payload['vetting_provider'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {
      'brand_sid' => brand_sid,
      'brand_vetting_sid' => brand_vetting_sid || @properties['brand_vetting_sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the vetting.

Returns:

  • (String) —

    The SID of the Account that created the vetting



270
271
272
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 270

def 
  @properties['account_sid']
end

#brand_sid ⇒ String

Returns A2P BrandRegistration Sid.

Returns:

  • (String) —

    A2P BrandRegistration Sid



276
277
278
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 276

def brand_sid
  @properties['brand_sid']
end

#brand_vetting_sid ⇒ String

Returns SID for third-party vetting record.

Returns:

  • (String) —

    SID for third-party vetting record



282
283
284
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 282

def brand_vetting_sid
  @properties['brand_vetting_sid']
end

#context ⇒ BrandVettingContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 257

def context
  unless @instance_context
    @instance_context = BrandVettingContext.new(
        @version,
        @params['brand_sid'],
        @params['brand_vetting_sid'],
    )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



294
295
296
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 294

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



288
289
290
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 288

def date_updated
  @properties['date_updated']
end

#fetch ⇒ BrandVettingInstance

Fetch the BrandVettingInstance

Returns:



331
332
333
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 331

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



344
345
346
347
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 344

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
end

#to_s ⇒ Object

Provide a user friendly representation



337
338
339
340
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 337

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Messaging.V1.BrandVettingInstance #{values}>"
end

#url ⇒ String

Returns The absolute URL of the Brand Vetting.

Returns:

  • (String) —

    The absolute URL of the Brand Vetting



324
325
326
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 324

def url
  @properties['url']
end

#vetting_class ⇒ String

Returns The type of vetting.

Returns:

  • (String) —

    The type of vetting



306
307
308
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 306

def vetting_class
  @properties['vetting_class']
end

#vetting_id ⇒ String

Returns The unique ID of the vetting.

Returns:

  • (String) —

    The unique ID of the vetting



300
301
302
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 300

def vetting_id
  @properties['vetting_id']
end

#vetting_provider ⇒ brand_vetting.VettingProvider

Returns Third-party provider that has conducted the vetting.

Returns:

  • (brand_vetting.VettingProvider) —

    Third-party provider that has conducted the vetting



318
319
320
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 318

def vetting_provider
  @properties['vetting_provider']
end

#vetting_status ⇒ String

Returns Status of vetting attempt.

Returns:

  • (String) —

    Status of vetting attempt



312
313
314
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 312

def vetting_status
  @properties['vetting_status']
end