Class: Twilio::REST::Preview::DeployedDevices::FleetContext::DeviceInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Preview::DeployedDevices::FleetContext::DeviceInstance
- Defined in:
- lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
Specifies the unique string identifier of the Account responsible for this Device.
-
#context ⇒ DeviceContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_authenticated ⇒ Time
Specifies the date this Device was last authenticated, given in UTC ISO 8601 format.
-
#date_created ⇒ Time
Specifies the date this Device was created, given in UTC ISO 8601 format.
-
#date_updated ⇒ Time
Specifies the date this Device was last updated, given in UTC ISO 8601 format.
-
#delete ⇒ Boolean
Delete the DeviceInstance.
-
#deployment_sid ⇒ String
Specifies the unique string identifier of the Deployment group that this Device is associated with.
-
#enabled ⇒ Boolean
Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false.
-
#fetch ⇒ DeviceInstance
Fetch the DeviceInstance.
-
#fleet_sid ⇒ String
Specifies the unique string identifier of the Fleet that the given Device belongs to.
-
#friendly_name ⇒ String
Contains a human readable descriptive text for this Device, up to 256 characters long.
-
#identity ⇒ String
Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long.
-
#initialize(version, payload, fleet_sid: nil, sid: nil) ⇒ DeviceInstance
constructor
Initialize the DeviceInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#sid ⇒ String
Contains a 34 character string that uniquely identifies this Device resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#unique_name ⇒ String
Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long.
-
#update(friendly_name: :unset, identity: :unset, deployment_sid: :unset, enabled: :unset) ⇒ DeviceInstance
Update the DeviceInstance.
-
#url ⇒ String
Contains an absolute URL for this Device resource.
Constructor Details
#initialize(version, payload, fleet_sid: nil, sid: nil) ⇒ DeviceInstance
Initialize the DeviceInstance
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 297 def initialize(version, payload , fleet_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'url' => payload['url'], 'unique_name' => payload['unique_name'], 'friendly_name' => payload['friendly_name'], 'fleet_sid' => payload['fleet_sid'], 'enabled' => payload['enabled'], 'account_sid' => payload['account_sid'], 'identity' => payload['identity'], 'deployment_sid' => payload['deployment_sid'], 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 'date_authenticated' => Twilio.deserialize_iso8601_datetime(payload['date_authenticated']), } # Context @instance_context = nil @params = { 'fleet_sid' => fleet_sid || @properties['fleet_sid'] ,'sid' => sid || @properties['sid'] , } end |
Instance Method Details
#account_sid ⇒ String
370 371 372 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 370 def account_sid @properties['account_sid'] end |
#context ⇒ DeviceContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
325 326 327 328 329 330 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 325 def context unless @instance_context @instance_context = DeviceContext.new(@version , @params['fleet_sid'], @params['sid']) end @instance_context end |
#date_authenticated ⇒ Time
400 401 402 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 400 def date_authenticated @properties['date_authenticated'] end |
#date_created ⇒ Time
388 389 390 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 388 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
394 395 396 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 394 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the DeviceInstance
407 408 409 410 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 407 def delete context.delete end |
#deployment_sid ⇒ String
382 383 384 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 382 def deployment_sid @properties['deployment_sid'] end |
#enabled ⇒ Boolean
364 365 366 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 364 def enabled @properties['enabled'] end |
#fetch ⇒ DeviceInstance
Fetch the DeviceInstance
415 416 417 418 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 415 def fetch context.fetch end |
#fleet_sid ⇒ String
358 359 360 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 358 def fleet_sid @properties['fleet_sid'] end |
#friendly_name ⇒ String
352 353 354 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 352 def friendly_name @properties['friendly_name'] end |
#identity ⇒ String
376 377 378 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 376 def identity @properties['identity'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
451 452 453 454 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 451 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.DeployedDevices.DeviceInstance #{values}>" end |
#sid ⇒ String
334 335 336 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 334 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
444 445 446 447 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 444 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Preview.DeployedDevices.DeviceInstance #{values}>" end |
#unique_name ⇒ String
346 347 348 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 346 def unique_name @properties['unique_name'] end |
#update(friendly_name: :unset, identity: :unset, deployment_sid: :unset, enabled: :unset) ⇒ DeviceInstance
Update the DeviceInstance
427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 427 def update( friendly_name: :unset, identity: :unset, deployment_sid: :unset, enabled: :unset ) context.update( friendly_name: friendly_name, identity: identity, deployment_sid: deployment_sid, enabled: enabled, ) end |
#url ⇒ String
340 341 342 |
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 340 def url @properties['url'] end |