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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Messaging::V1::BrandRegistrationInstance

Defined in:

lib/twilio-ruby/rest/messaging/v1/brand_registration.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary

• #a2p_profile_bundle_sid ⇒ String

  A2P Messaging Profile Bundle BundleSid.

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #brand_score ⇒ String

  Brand score.

• #context ⇒ BrandRegistrationContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #customer_profile_bundle_sid ⇒ String

  A2P Messaging Profile Bundle BundleSid.

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #failure_reason ⇒ String

  A reason why brand registration has failed.

• #fetch ⇒ BrandRegistrationInstance

  Fetch the BrandRegistrationInstance.

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

  Initialize the BrandRegistrationInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  A2P BrandRegistration Sid.

• #status ⇒ brand_registration.Status

  Brand Registration status.

• #tcr_id ⇒ String

  Campaign Registry (TCR) Brand ID.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the Brand Registration.

Constructor Details

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

Initialize the BrandRegistrationInstance

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

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']),
      'status' => payload['status'],
      'tcr_id' => payload['tcr_id'],
      'failure_reason' => payload['failure_reason'],
      'url' => payload['url'],
      'brand_score' => payload['brand_score'] == nil ? payload['brand_score'] : payload['brand_score'].to_i,
  }

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

Instance Method Details

#a2p_profile_bundle_sid ⇒ String

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

def a2p_profile_bundle_sid
  @properties['a2p_profile_bundle_sid']
end

#account_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#brand_score ⇒ String

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

def brand_score
  @properties['brand_score']
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

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

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

#customer_profile_bundle_sid ⇒ String

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

def customer_profile_bundle_sid
  @properties['customer_profile_bundle_sid']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#failure_reason ⇒ String

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

def failure_reason
  @properties['failure_reason']
end

#fetch ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#sid ⇒ String

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

def sid
  @properties['sid']
end

#status ⇒ brand_registration.Status

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

def status
  @properties['status']
end

#tcr_id ⇒ String

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

def tcr_id
  @properties['tcr_id']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
  @properties['url']
end