Class: Twilio::REST::Supersim::V1::IpCommandInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/supersim/v1/ip_command.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the IpCommandInstance

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 IpCommand resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 268

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'sim_sid' => payload['sim_sid'],
        'sim_iccid' => payload['sim_iccid'],
        'status' => payload['status'],
        'direction' => payload['direction'],
        'device_ip' => payload['device_ip'],
        'device_port' => payload['device_port'] == nil ? payload['device_port'] : payload['device_port'].to_i,
        'payload_type' => payload['payload_type'],
        'payload' => payload['payload'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the IP Command resource.

Returns:



312
313
314
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 312

def 
    @properties['account_sid']
end

#context ⇒ IpCommandContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 297

def context
    unless @instance_context
        @instance_context = IpCommandContext.new(@version , @params['sid'])
    end
    @instance_context
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:



366
367
368
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 366

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:



372
373
374
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 372

def date_updated
    @properties['date_updated']
end

#device_ip ⇒ String

Returns The IP address of the device that the IP Command was sent to or received from. For an IP Command sent to a Super SIM, ‘device_ip` starts out as `null`, and once the IP Command is “sent”, the `device_ip` will be filled out. An IP Command sent from a Super SIM have its `device_ip` always set.

Returns:

  • (String) —

    The IP address of the device that the IP Command was sent to or received from. For an IP Command sent to a Super SIM, ‘device_ip` starts out as `null`, and once the IP Command is “sent”, the `device_ip` will be filled out. An IP Command sent from a Super SIM have its `device_ip` always set.



342
343
344
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 342

def device_ip
    @properties['device_ip']
end

#device_port ⇒ String

Returns For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message.

Returns:

  • (String) —

    For an IP Command sent to a Super SIM, it would be the destination port of the IP message. For an IP Command sent from a Super SIM, it would be the source port of the IP message.



348
349
350
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 348

def device_port
    @properties['device_port']
end

#direction ⇒ Direction

Returns:

  • (Direction) 


336
337
338
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 336

def direction
    @properties['direction']
end

#fetch ⇒ IpCommandInstance

Fetch the IpCommandInstance

Returns:



385
386
387
388
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 385

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



399
400
401
402
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 399

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

#payload ⇒ String

Returns The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used. For an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message “as is”. The payload should not exceed 1300 bytes. For an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.

Returns:

  • (String) —

    The payload that is carried in the IP/UDP message. The payload can be encoded in either text or binary format. For text payload, UTF-8 encoding must be used. For an IP Command sent to a Super SIM, the payload is appended to the IP/UDP message “as is”. The payload should not exceed 1300 bytes. For an IP Command sent from a Super SIM, the payload from the received IP/UDP message is extracted and sent in binary encoding. For an IP Command sent from a Super SIM, the payload should not exceed 1300 bytes. If it is larger than 1300 bytes, there might be fragmentation on the upstream and the message may appear truncated.



360
361
362
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 360

def payload
    @properties['payload']
end

#payload_type ⇒ PayloadType

Returns:

  • (PayloadType) 


354
355
356
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 354

def payload_type
    @properties['payload_type']
end

#sid ⇒ String

Returns The unique string that we created to identify the IP Command resource.

Returns:

  • (String) —

    The unique string that we created to identify the IP Command resource.



306
307
308
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 306

def sid
    @properties['sid']
end

#sim_iccid ⇒ String

Returns The [ICCID](en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) of the [Super SIM](www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from.

Returns:



324
325
326
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 324

def sim_iccid
    @properties['sim_iccid']
end

#sim_sid ⇒ String

Returns The SID of the [Super SIM](www.twilio.com/docs/iot/supersim/api/sim-resource) that this IP Command was sent to or from.

Returns:



318
319
320
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 318

def sim_sid
    @properties['sim_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


330
331
332
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 330

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



392
393
394
395
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 392

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

#url ⇒ String

Returns The absolute URL of the IP Command resource.

Returns:

  • (String) —

    The absolute URL of the IP Command resource.



378
379
380
 
# File 'lib/twilio-ruby/rest/supersim/v1/ip_command.rb', line 378

def url
    @properties['url']
end