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

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

  • account_sid (String)

    The SID of the Account that created this BrandVetting resource.

  • sid (String)

    The SID of the Call resource to fetch.



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 243

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  || @properties['brand_sid']  ,'brand_vetting_sid' => brand_vetting_sid  || @properties['brand_vetting_sid']  , }
end

Instance Method Details

#account_sidString

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the vetting record.

Returns:



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

def 
    @properties['account_sid']
end

#brand_sidString

Returns The unique string to identify Brand Registration.

Returns:

  • (String)

    The unique string to identify Brand Registration.



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

def brand_sid
    @properties['brand_sid']
end

#brand_vetting_sidString

Returns The Twilio SID of the third-party vetting record.

Returns:

  • (String)

    The Twilio SID of the third-party vetting record.



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

def brand_vetting_sid
    @properties['brand_vetting_sid']
end

#contextBrandVettingContext

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

Returns:



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

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

#date_createdTime

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updatedTime

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#fetchBrandVettingInstance

Fetch the BrandVettingInstance

Returns:



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

def fetch

    context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



353
354
355
356
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb', line 353

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

#to_sObject

Provide a user friendly representation



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

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

#urlString

Returns The absolute URL of the Brand Vetting resource.

Returns:

  • (String)

    The absolute URL of the Brand Vetting resource.



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

def url
    @properties['url']
end

#vetting_classString

Returns The type of vetting that has been conducted. One of “STANDARD” (Aegis) or “POLITICAL” (Campaign Verify).

Returns:

  • (String)

    The type of vetting that has been conducted. One of “STANDARD” (Aegis) or “POLITICAL” (Campaign Verify).



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

def vetting_class
    @properties['vetting_class']
end

#vetting_idString

Returns The unique identifier of the vetting from the third-party provider.

Returns:

  • (String)

    The unique identifier of the vetting from the third-party provider.



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

def vetting_id
    @properties['vetting_id']
end

#vetting_providerVettingProvider

Returns:

  • (VettingProvider)


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

def vetting_provider
    @properties['vetting_provider']
end

#vetting_statusString

Returns The status of the import vetting attempt. One of “PENDING,” “SUCCESS,” or “FAILED”.

Returns:

  • (String)

    The status of the import vetting attempt. One of “PENDING,” “SUCCESS,” or “FAILED”.



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

def vetting_status
    @properties['vetting_status']
end