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.



539
540
541
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
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 539

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.



604
605
606
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 604

def a2p_profile_bundle_sid
    @properties['a2p_profile_bundle_sid']
end

#account_sid ⇒ String

Returns The SID of the Account that created the Brand Registration resource.

Returns:

  • (String) —

    The SID of the Account that created the Brand Registration resource.



592
593
594
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 592

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



664
665
666
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 664

def brand_feedback
    @properties['brand_feedback']
end

#brand_registration_otps ⇒ brand_registration_otps

Access the brand_registration_otps

Returns:



729
730
731
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 729

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.



658
659
660
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 658

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.



622
623
624
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 622

def brand_type
    @properties['brand_type']
end

#brand_vettings ⇒ brand_vettings

Access the brand_vettings

Returns:



736
737
738
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 736

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:



577
578
579
580
581
582
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 577

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.



598
599
600
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 598

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

Returns:

  • (Time) —

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



610
611
612
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 610

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

Returns:

  • (Time) —

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



616
617
618
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 616

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.



646
647
648
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 646

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.



640
641
642
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 640

def failure_reason
    @properties['failure_reason']
end

#fetch ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstance

Returns:



713
714
715
716
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 713

def fetch

    context.fetch
end

#government_entity ⇒ Boolean

Returns Identified as a government entity.

Returns:

  • (Boolean) —

    Identified as a government entity



682
683
684
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 682

def government_entity
    @properties['government_entity']
end

#identity_status ⇒ IdentityStatus

Returns:

  • (IdentityStatus) 


670
671
672
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 670

def identity_status
    @properties['identity_status']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



749
750
751
752
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 749

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

#links ⇒ Hash

Returns:

  • (Hash) 


706
707
708
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 706

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.



700
701
702
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 700

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



676
677
678
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 676

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.



586
587
588
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 586

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.



694
695
696
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 694

def skip_automatic_sec_vet
    @properties['skip_automatic_sec_vet']
end

#status ⇒ Status

Returns:

  • (Status) 


628
629
630
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 628

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.



688
689
690
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 688

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.



634
635
636
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 634

def tcr_id
    @properties['tcr_id']
end

#to_s ⇒ Object

Provide a user friendly representation



742
743
744
745
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 742

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

#update ⇒ BrandRegistrationInstance

Update the BrandRegistrationInstance

Returns:



721
722
723
724
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 721

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.



652
653
654
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 652

def url
    @properties['url']
end