Class: Twilio::REST::Messaging::V1::BrandRegistrationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ BrandRegistrationInstance

Initialize the BrandRegistrationInstance

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 BrandRegistration resource.

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

    The SID of the Call resource to fetch.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 288

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'customer_profile_bundle_sid' => payload['customer_profile_bundle_sid'],
        'a2p_profile_bundle_sid' => payload['a2p_profile_bundle_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'brand_type' => payload['brand_type'],
        'status' => payload['status'],
        'tcr_id' => payload['tcr_id'],
        'failure_reason' => payload['failure_reason'],
        'errors' => payload['errors'],
        'url' => payload['url'],
        'brand_score' => payload['brand_score'] == nil ? payload['brand_score'] : payload['brand_score'].to_i,
        'brand_feedback' => payload['brand_feedback'],
        'identity_status' => payload['identity_status'],
        'russell_3000' => payload['russell_3000'],
        'government_entity' => payload['government_entity'],
        'tax_exempt_status' => payload['tax_exempt_status'],
        'skip_automatic_sec_vet' => payload['skip_automatic_sec_vet'],
        'mock' => payload['mock'],
        'links' => payload['links'],
    }

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

Instance Method Details

#a2p_profile_bundle_sid ⇒ String

Returns A2P Messaging Profile Bundle BundleSid.

Returns:

  • (String) —

    A2P Messaging Profile Bundle BundleSid.



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

def a2p_profile_bundle_sid
    @properties['a2p_profile_bundle_sid']
end

#account_sid ⇒ String

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

Returns:



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

def 
    @properties['account_sid']
end

#brand_feedback ⇒ Array<BrandFeedback>

Returns DEPRECATED. Feedback on how to improve brand score.

Returns:

  • (Array<BrandFeedback>) —

    DEPRECATED. Feedback on how to improve brand score



412
413
414
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 412

def brand_feedback
    @properties['brand_feedback']
end

#brand_registration_otps ⇒ brand_registration_otps

Access the brand_registration_otps

Returns:



477
478
479
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 477

def brand_registration_otps
    context.brand_registration_otps
end

#brand_score ⇒ String

Returns The secondary vetting score if it was done. Otherwise, it will be the brand score if it’s returned from TCR. It may be null if no score is available.

Returns:

  • (String) —

    The secondary vetting score if it was done. Otherwise, it will be the brand score if it’s returned from TCR. It may be null if no score is available.



406
407
408
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 406

def brand_score
    @properties['brand_score']
end

#brand_type ⇒ String

Returns Type of brand. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for the low volume, SOLE_PROPRIETOR campaign use case. There can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR brand. STANDARD is for all other campaign use cases. Multiple campaign use cases can be created per STANDARD brand.

Returns:

  • (String) —

    Type of brand. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for the low volume, SOLE_PROPRIETOR campaign use case. There can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR brand. STANDARD is for all other campaign use cases. Multiple campaign use cases can be created per STANDARD brand.



370
371
372
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 370

def brand_type
    @properties['brand_type']
end

#brand_vettings ⇒ brand_vettings

Access the brand_vettings

Returns:



484
485
486
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 484

def brand_vettings
    context.brand_vettings
end

#context ⇒ BrandRegistrationContext

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

Returns:



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

def context
    unless @instance_context
        @instance_context = BrandRegistrationContext.new(@version , @params['sid'])
    end
    @instance_context
end

#customer_profile_bundle_sid ⇒ String

Returns A2P Messaging Profile Bundle BundleSid.

Returns:

  • (String) —

    A2P Messaging Profile Bundle BundleSid.



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

def customer_profile_bundle_sid
    @properties['customer_profile_bundle_sid']
end

#date_created ⇒ Time

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

Returns:



358
359
360
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 358

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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:



364
365
366
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 364

def date_updated
    @properties['date_updated']
end

#errors ⇒ Array<Hash>

Returns A list of errors that occurred during the brand registration process.

Returns:

  • (Array<Hash>) —

    A list of errors that occurred during the brand registration process.



394
395
396
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 394

def errors
    @properties['errors']
end

#failure_reason ⇒ String

Returns DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED.

Returns:

  • (String) —

    DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED.



388
389
390
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 388

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstance

Returns:



461
462
463
464
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 461

def fetch

    context.fetch
end

#government_entity ⇒ Boolean

Returns Identified as a government entity.

Returns:

  • (Boolean) —

    Identified as a government entity



430
431
432
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 430

def government_entity
    @properties['government_entity']
end

#identity_status ⇒ IdentityStatus

Returns:

  • (IdentityStatus) 


418
419
420
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 418

def identity_status
    @properties['identity_status']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



497
498
499
500
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 497

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

#links ⇒ Hash

Returns:

  • (Hash) 


454
455
456
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 454

def links
    @properties['links']
end

#mock ⇒ Boolean

Returns 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.

Returns:

  • (Boolean) —

    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.



448
449
450
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 448

def mock
    @properties['mock']
end

#russell_3000 ⇒ Boolean

Returns Publicly traded company identified in the Russell 3000 Index.

Returns:

  • (Boolean) —

    Publicly traded company identified in the Russell 3000 Index



424
425
426
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 424

def russell_3000
    @properties['russell_3000']
end

#sid ⇒ String

Returns The unique string to identify Brand Registration.

Returns:

  • (String) —

    The unique string to identify Brand Registration.



334
335
336
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 334

def sid
    @properties['sid']
end

#skip_automatic_sec_vet ⇒ Boolean

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

Returns:

  • (Boolean) —

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



442
443
444
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 442

def skip_automatic_sec_vet
    @properties['skip_automatic_sec_vet']
end

#status ⇒ Status

Returns:

  • (Status) 


376
377
378
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 376

def status
    @properties['status']
end

#tax_exempt_status ⇒ String

Returns Nonprofit organization tax-exempt status per section 501 of the U.S. tax code.

Returns:

  • (String) —

    Nonprofit organization tax-exempt status per section 501 of the U.S. tax code.



436
437
438
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 436

def tax_exempt_status
    @properties['tax_exempt_status']
end

#tcr_id ⇒ String

Returns Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration.

Returns:

  • (String) —

    Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration.



382
383
384
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 382

def tcr_id
    @properties['tcr_id']
end

#to_s ⇒ Object

Provide a user friendly representation



490
491
492
493
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 490

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

#update ⇒ BrandRegistrationInstance

Update the BrandRegistrationInstance

Returns:



469
470
471
472
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 469

def update

    context.update
end

#url ⇒ String

Returns The absolute URL of the Brand Registration resource.

Returns:

  • (String) —

    The absolute URL of the Brand Registration resource.



400
401
402
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 400

def url
    @properties['url']
end