Class: Twilio::REST::Supersim::V1::FleetInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Supersim::V1::FleetInstance
- Defined in:
- lib/twilio-ruby/rest/supersim/v1/fleet.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Fleet resource.
-
#context ⇒ FleetContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#data_enabled ⇒ Boolean
Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity.
-
#data_limit ⇒ String
The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month).
- #data_metering ⇒ DataMetering
-
#date_created ⇒ Time
The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#date_updated ⇒ Time
The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#fetch ⇒ FleetInstance
Fetch the FleetInstance.
-
#initialize(version, payload, sid: nil) ⇒ FleetInstance
constructor
Initialize the FleetInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#ip_commands_method ⇒ String
A string representing the HTTP method to use when making a request to ‘ip_commands_url`.
-
#ip_commands_url ⇒ String
The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address.
-
#network_access_profile_sid ⇒ String
The SID of the Network Access Profile that controls which cellular networks the Fleet’s SIMs can connect to.
-
#sid ⇒ String
The unique string that we created to identify the Fleet resource.
-
#sms_commands_enabled ⇒ Boolean
Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands.
-
#sms_commands_method ⇒ String
A string representing the HTTP method to use when making a request to ‘sms_commands_url`.
-
#sms_commands_url ⇒ String
The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
An application-defined string that uniquely identifies the resource.
-
#update(unique_name: :unset, network_access_profile: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset, data_limit: :unset) ⇒ FleetInstance
Update the FleetInstance.
-
#url ⇒ String
The absolute URL of the Fleet resource.
Constructor Details
#initialize(version, payload, sid: nil) ⇒ FleetInstance
Initialize the FleetInstance
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 317 def initialize(version, payload , sid: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'sid' => payload['sid'], 'unique_name' => payload['unique_name'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'url' => payload['url'], 'data_enabled' => payload['data_enabled'], 'data_limit' => payload['data_limit'] == nil ? payload['data_limit'] : payload['data_limit'].to_i, 'data_metering' => payload['data_metering'], 'sms_commands_enabled' => payload['sms_commands_enabled'], 'sms_commands_url' => payload['sms_commands_url'], 'sms_commands_method' => payload['sms_commands_method'], 'network_access_profile_sid' => payload['network_access_profile_sid'], 'ip_commands_url' => payload['ip_commands_url'], 'ip_commands_method' => payload['ip_commands_method'], } # Context @instance_context = nil @params = { 'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
357 358 359 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 357 def account_sid @properties['account_sid'] end |
#context ⇒ FleetContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
348 349 350 351 352 353 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 348 def context unless @instance_context @instance_context = FleetContext.new(@version , @params['sid']) end @instance_context end |
#data_enabled ⇒ Boolean
393 394 395 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 393 def data_enabled @properties['data_enabled'] end |
#data_limit ⇒ String
399 400 401 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 399 def data_limit @properties['data_limit'] end |
#data_metering ⇒ DataMetering
405 406 407 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 405 def data_metering @properties['data_metering'] end |
#date_created ⇒ Time
375 376 377 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 375 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
381 382 383 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 381 def date_updated @properties['date_updated'] end |
#fetch ⇒ FleetInstance
Fetch the FleetInstance
448 449 450 451 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 448 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
493 494 495 496 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 493 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Supersim.V1.FleetInstance #{values}>" end |
#ip_commands_method ⇒ String
441 442 443 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 441 def ip_commands_method @properties['ip_commands_method'] end |
#ip_commands_url ⇒ String
435 436 437 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 435 def ip_commands_url @properties['ip_commands_url'] end |
#network_access_profile_sid ⇒ String
429 430 431 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 429 def network_access_profile_sid @properties['network_access_profile_sid'] end |
#sid ⇒ String
363 364 365 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 363 def sid @properties['sid'] end |
#sms_commands_enabled ⇒ Boolean
411 412 413 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 411 def sms_commands_enabled @properties['sms_commands_enabled'] end |
#sms_commands_method ⇒ String
423 424 425 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 423 def sms_commands_method @properties['sms_commands_method'] end |
#sms_commands_url ⇒ String
417 418 419 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 417 def sms_commands_url @properties['sms_commands_url'] end |
#to_s ⇒ Object
Provide a user friendly representation
486 487 488 489 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 486 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Supersim.V1.FleetInstance #{values}>" end |
#unique_name ⇒ String
369 370 371 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 369 def unique_name @properties['unique_name'] end |
#update(unique_name: :unset, network_access_profile: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset, data_limit: :unset) ⇒ FleetInstance
Update the FleetInstance
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 463 def update( unique_name: :unset, network_access_profile: :unset, ip_commands_url: :unset, ip_commands_method: :unset, sms_commands_url: :unset, sms_commands_method: :unset, data_limit: :unset ) context.update( unique_name: unique_name, network_access_profile: network_access_profile, ip_commands_url: ip_commands_url, ip_commands_method: ip_commands_method, sms_commands_url: sms_commands_url, sms_commands_method: sms_commands_method, data_limit: data_limit, ) end |
#url ⇒ String
387 388 389 |
# File 'lib/twilio-ruby/rest/supersim/v1/fleet.rb', line 387 def url @properties['url'] end |