Class: Twilio::REST::Wireless::V1::SimInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Wireless::V1::SimInstance

Defined in:

lib/twilio-ruby/rest/wireless/v1/sim.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account to which the Sim resource belongs.

• #commands_callback_method ⇒ String

  The HTTP method we use to call commands_callback_url.

• #commands_callback_url ⇒ String

  The URL we call when the SIM originates a machine-to-machine Command.

• #context ⇒ SimContext

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

• #data_sessions ⇒ data_sessions

  Access the data_sessions.

• #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 Sim resource was last updated.

• #delete ⇒ Boolean

  Delete the SimInstance.

• #e_id ⇒ String

  Deprecated.

• #fetch ⇒ SimInstance

  Fetch the SimInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the Sim resource.

• #iccid ⇒ String

  The ICCID associated with the SIM.

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

  Initialize the SimInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #ip_address ⇒ String

  Deprecated.

• #links ⇒ String

  The URLs of related subresources.

• #rate_plan_sid ⇒ String

  The SID of the RatePlan resource to which the Sim resource is assigned.

• #reset_status ⇒ sim.ResetStatus

  The connectivity reset status of the SIM.

• #sid ⇒ String

  The unique string that identifies the Sim resource.

• #sms_fallback_method ⇒ String

  The HTTP method we use to call sms_fallback_url.

• #sms_fallback_url ⇒ String

  The URL we call when an error occurs while retrieving or executing the TwiML requested from the sms_url.

• #sms_method ⇒ String

  The HTTP method we use to call sms_url.

• #sms_url ⇒ String

  The URL we call when the SIM-connected device sends an SMS message that is not a Command.

• #status ⇒ sim.Status

  The status of the Sim resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #unique_name ⇒ String

  An application-defined string that uniquely identifies the resource.

• #update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset, account_sid: :unset) ⇒ SimInstance

  Update the SimInstance.

• #url ⇒ String

  The absolute URL of the resource.

• #usage_records ⇒ usage_records

  Access the usage_records.

• #voice_fallback_method ⇒ String

  The HTTP method we use to call voice_fallback_url.

• #voice_fallback_url ⇒ String

  The URL we call when an error occurs while retrieving or executing the TwiML requested from voice_url.

• #voice_method ⇒ String

  The HTTP method we use to call voice_url.

• #voice_url ⇒ String

  The URL we call when the SIM-connected device makes a voice call.

Constructor Details

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

Initialize the SimInstance

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 352

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'unique_name' => payload['unique_name'],
      'account_sid' => payload['account_sid'],
      'rate_plan_sid' => payload['rate_plan_sid'],
      'friendly_name' => payload['friendly_name'],
      'iccid' => payload['iccid'],
      'e_id' => payload['e_id'],
      'status' => payload['status'],
      'reset_status' => payload['reset_status'],
      'commands_callback_url' => payload['commands_callback_url'],
      'commands_callback_method' => payload['commands_callback_method'],
      'sms_fallback_method' => payload['sms_fallback_method'],
      'sms_fallback_url' => payload['sms_fallback_url'],
      'sms_method' => payload['sms_method'],
      'sms_url' => payload['sms_url'],
      'voice_fallback_method' => payload['voice_fallback_method'],
      'voice_fallback_url' => payload['voice_fallback_url'],
      'voice_method' => payload['voice_method'],
      'voice_url' => payload['voice_url'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
      'links' => payload['links'],
      'ip_address' => payload['ip_address'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 413

def account_sid
  @properties['account_sid']
end

#commands_callback_method ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 461

def commands_callback_method
  @properties['commands_callback_method']
end

#commands_callback_url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 455

def commands_callback_url
  @properties['commands_callback_url']
end

#context ⇒ SimContext

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/wireless/v1/sim.rb', line 392

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

#data_sessions ⇒ data_sessions

Access the data_sessions

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 646

def data_sessions
  context.data_sessions
end

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 515

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 521

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SimInstance

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 632

def delete
  context.delete
end

#e_id ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 437

def e_id
  @properties['e_id']
end

#fetch ⇒ SimInstance

Fetch the SimInstance

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 546

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 425

def friendly_name
  @properties['friendly_name']
end

#iccid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 431

def iccid
  @properties['iccid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 659

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

#ip_address ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 539

def ip_address
  @properties['ip_address']
end

#links ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 533

def links
  @properties['links']
end

#rate_plan_sid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 419

def rate_plan_sid
  @properties['rate_plan_sid']
end

#reset_status ⇒ sim.ResetStatus

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 449

def reset_status
  @properties['reset_status']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 401

def sid
  @properties['sid']
end

#sms_fallback_method ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 467

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 473

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 479

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 485

def sms_url
  @properties['sms_url']
end

#status ⇒ sim.Status

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 443

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 652

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

#unique_name ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 407

def unique_name
  @properties['unique_name']
end

#update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset, account_sid: :unset) ⇒ SimInstance

Update the SimInstance

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 606

def update(unique_name: :unset, callback_method: :unset, callback_url: :unset, friendly_name: :unset, rate_plan: :unset, status: :unset, commands_callback_method: :unset, commands_callback_url: :unset, sms_fallback_method: :unset, sms_fallback_url: :unset, sms_method: :unset, sms_url: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_url: :unset, reset_status: :unset, account_sid: :unset)
  context.update(
      unique_name: unique_name,
      callback_method: callback_method,
      callback_url: callback_url,
      friendly_name: friendly_name,
      rate_plan: rate_plan,
      status: status,
      commands_callback_method: commands_callback_method,
      commands_callback_url: commands_callback_url,
      sms_fallback_method: sms_fallback_method,
      sms_fallback_url: sms_fallback_url,
      sms_method: sms_method,
      sms_url: sms_url,
      voice_fallback_method: voice_fallback_method,
      voice_fallback_url: voice_fallback_url,
      voice_method: voice_method,
      voice_url: voice_url,
      reset_status: reset_status,
      account_sid: account_sid,
  )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 527

def url
  @properties['url']
end

#usage_records ⇒ usage_records

Access the usage_records

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 639

def usage_records
  context.usage_records
end

#voice_fallback_method ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 491

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 497

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 503

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/sim.rb', line 509

def voice_url
  @properties['voice_url']
end