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 that contains the resource

  • payload that contains response from Twilio

  • The SID of the Account that created this BrandRegistration resource.

  • (defaults to: nil)

    The SID of the Call resource to fetch.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 542

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:

  • A2P Messaging Profile Bundle BundleSid.



607
608
609
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 607

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:



595
596
597
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 595

def 
    @properties['account_sid']
end

#brand_feedback ⇒ Array<BrandFeedback>

Returns DEPRECATED. Feedback on how to improve brand score.

Returns:

  • DEPRECATED. Feedback on how to improve brand score



667
668
669
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 667

def brand_feedback
    @properties['brand_feedback']
end

#brand_registration2_fa ⇒ brand_registration2_fa

Access the brand_registration2_fa

Returns:

  • brand_registration2_fa



746
747
748
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 746

def brand_registration2_fa
    context.brand_registration2_fa
end

#brand_registration_otps ⇒ brand_registration_otps

Access the brand_registration_otps

Returns:

  • brand_registration_otps



732
733
734
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 732

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:

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



661
662
663
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 661

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:

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



625
626
627
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 625

def brand_type
    @properties['brand_type']
end

#brand_vettings ⇒ brand_vettings

Access the brand_vettings

Returns:

  • brand_vettings



739
740
741
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 739

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:

  • CallContext for this CallInstance



580
581
582
583
584
585
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 580

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:

  • A2P Messaging Profile Bundle BundleSid.



601
602
603
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 601

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:



613
614
615
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 613

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:



619
620
621
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 619

def date_updated
    @properties['date_updated']
end

#errors ⇒ Array<Hash>

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

Returns:

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



649
650
651
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 649

def errors
    @properties['errors']
end

#failure_reason ⇒ String

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

Returns:

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



643
644
645
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 643

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstance

Returns:

  • Fetched BrandRegistrationInstance



716
717
718
719
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 716

def fetch

    context.fetch
end

#government_entity ⇒ Boolean

Returns Identified as a government entity.

Returns:

  • Identified as a government entity



685
686
687
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 685

def government_entity
    @properties['government_entity']
end

#identity_status ⇒ IdentityStatus

Returns:



673
674
675
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 673

def identity_status
    @properties['identity_status']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



759
760
761
762
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 759

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

#links ⇒ Hash

Returns:



709
710
711
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 709

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:

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



703
704
705
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 703

def mock
    @properties['mock']
end

#russell_3000 ⇒ Boolean

Returns Publicly traded company identified in the Russell 3000 Index.

Returns:

  • Publicly traded company identified in the Russell 3000 Index



679
680
681
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 679

def russell_3000
    @properties['russell_3000']
end

#sid ⇒ String

Returns The unique string to identify Brand Registration.

Returns:

  • The unique string to identify Brand Registration.



589
590
591
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 589

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:

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



697
698
699
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 697

def skip_automatic_sec_vet
    @properties['skip_automatic_sec_vet']
end

#status ⇒ Status

Returns:



631
632
633
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 631

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:

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



691
692
693
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 691

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:

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



637
638
639
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 637

def tcr_id
    @properties['tcr_id']
end

#to_s ⇒ Object

Provide a user friendly representation



752
753
754
755
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 752

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

#update ⇒ BrandRegistrationInstance

Update the BrandRegistrationInstance

Returns:

  • Updated BrandRegistrationInstance



724
725
726
727
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 724

def update

    context.update
end

#url ⇒ String

Returns The absolute URL of the Brand Registration resource.

Returns:

  • The absolute URL of the Brand Registration resource.



655
656
657
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 655

def url
    @properties['url']
end