Class: Twilio::REST::Preview::TrustedComms::CurrentCallInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Preview::TrustedComms::CurrentCallInstance

Defined in:

lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.

Instance Method Summary

• #bg_color ⇒ String

  Background color of the current phone call.

• #caller ⇒ String

  Caller name of the current phone call.

• #context ⇒ CurrentCallContext

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

• #created_at ⇒ Time

  The date this current phone call was created.

• #fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset) ⇒ CurrentCallInstance

  Fetch the CurrentCallInstance.

• #font_color ⇒ String

  Font color of the current phone call.

• #from ⇒ String

  The originating phone number.

• #initialize(version, payload) ⇒ CurrentCallInstance constructor

  Initialize the CurrentCallInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #logo ⇒ String

  Logo URL of the caller.

• #manager ⇒ String

  The name of the CPS organization.

• #reason ⇒ String

  The business reason for this current phone call.

• #shield_img ⇒ String

  Shield image URL that serves as authenticity proof of the current phone call.

• #sid ⇒ String

  A string that uniquely identifies this current branded phone call.

• #status ⇒ String

  The status of the current phone call.

• #to ⇒ String

  The terminating phone number.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The URL of this resource.

• #use_case ⇒ String

  The use case for the current phone call.

Constructor Details

#initialize(version, payload) ⇒ CurrentCallInstance

Initialize the CurrentCallInstance

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 123

def initialize(version, payload)
  super(version)

  # Marshaled Properties
  @properties = {
      'bg_color' => payload['bg_color'],
      'caller' => payload['caller'],
      'created_at' => Twilio.deserialize_iso8601_datetime(payload['created_at']),
      'font_color' => payload['font_color'],
      'from' => payload['from'],
      'logo' => payload['logo'],
      'manager' => payload['manager'],
      'reason' => payload['reason'],
      'shield_img' => payload['shield_img'],
      'sid' => payload['sid'],
      'status' => payload['status'],
      'to' => payload['to'],
      'url' => payload['url'],
      'use_case' => payload['use_case'],
  }

  # Context
  @instance_context = nil
  @params = {}
end

Instance Method Details

#bg_color ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 162

def bg_color
  @properties['bg_color']
end

#caller ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 168

def caller
  @properties['caller']
end

#context ⇒ CurrentCallContext

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/preview/trusted_comms/current_call.rb', line 153

def context
  unless @instance_context
    @instance_context = CurrentCallContext.new(@version, )
  end
  @instance_context
end

#created_at ⇒ Time

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 174

def created_at
  @properties['created_at']
end

#fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset) ⇒ CurrentCallInstance

Fetch the CurrentCallInstance

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 253

def fetch(x_xcnam_sensitive_phone_number_from: :unset, x_xcnam_sensitive_phone_number_to: :unset)
  context.fetch(
      x_xcnam_sensitive_phone_number_from: x_xcnam_sensitive_phone_number_from,
      x_xcnam_sensitive_phone_number_to: x_xcnam_sensitive_phone_number_to,
  )
end

#font_color ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 180

def font_color
  @properties['font_color']
end

#from ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 186

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 269

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

#logo ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 192

def logo
  @properties['logo']
end

#manager ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 198

def manager
  @properties['manager']
end

#reason ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 204

def reason
  @properties['reason']
end

#shield_img ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 210

def shield_img
  @properties['shield_img']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 216

def sid
  @properties['sid']
end

#status ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 222

def status
  @properties['status']
end

#to ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 228

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 262

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

#url ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 234

def url
  @properties['url']
end

#use_case ⇒ String

# File 'lib/twilio-ruby/rest/preview/trusted_comms/current_call.rb', line 240

def use_case
  @properties['use_case']
end