Class: Twilio::REST::Preview::DeployedDevices::FleetContext::DeploymentInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, fleet_sid: nil, sid: nil) ⇒ DeploymentInstance

Initialize the DeploymentInstance

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

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

    The SID of the Call resource to fetch.



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 274

def initialize(version, payload , fleet_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'url' => payload['url'],
        'friendly_name' => payload['friendly_name'],
        'fleet_sid' => payload['fleet_sid'],
        'account_sid' => payload['account_sid'],
        'sync_service_sid' => payload['sync_service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Specifies the unique string identifier of the Account responsible for this Deployment.

Returns:

  • (String) —

    Specifies the unique string identifier of the Account responsible for this Deployment.



331
332
333
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 331

def 
    @properties['account_sid']
end

#context ⇒ DeploymentContext

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

Returns:



298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 298

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

#date_created ⇒ Time

Returns Specifies the date this Deployment was created, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this Deployment was created, given in UTC ISO 8601 format.



343
344
345
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 343

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns Specifies the date this Deployment was last updated, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this Deployment was last updated, given in UTC ISO 8601 format.



349
350
351
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 349

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DeploymentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



356
357
358
359
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 356

def delete

    context.delete
end

#fetch ⇒ DeploymentInstance

Fetch the DeploymentInstance

Returns:



364
365
366
367
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 364

def fetch

    context.fetch
end

#fleet_sid ⇒ String

Returns Specifies the unique string identifier of the Fleet that the given Deployment belongs to.

Returns:

  • (String) —

    Specifies the unique string identifier of the Fleet that the given Deployment belongs to.



325
326
327
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 325

def fleet_sid
    @properties['fleet_sid']
end

#friendly_name ⇒ String

Returns Contains a human readable descriptive text for this Deployment, up to 64 characters long.

Returns:

  • (String) —

    Contains a human readable descriptive text for this Deployment, up to 64 characters long



319
320
321
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 319

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



394
395
396
397
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 394

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

#sid ⇒ String

Returns Contains a 34 character string that uniquely identifies this Deployment resource.

Returns:

  • (String) —

    Contains a 34 character string that uniquely identifies this Deployment resource.



307
308
309
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 307

def sid
    @properties['sid']
end

#sync_service_sid ⇒ String

Returns Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment.

Returns:

  • (String) —

    Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment.



337
338
339
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 337

def sync_service_sid
    @properties['sync_service_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



387
388
389
390
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 387

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

#update(friendly_name: :unset, sync_service_sid: :unset) ⇒ DeploymentInstance

Update the DeploymentInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    Provides a human readable descriptive text for this Deployment, up to 64 characters long

  • sync_service_sid (String) (defaults to: :unset) —

    Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.

Returns:



374
375
376
377
378
379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 374

def update(
    friendly_name: :unset, 
    sync_service_sid: :unset
)

    context.update(
        friendly_name: friendly_name, 
        sync_service_sid: sync_service_sid, 
    )
end

#url ⇒ String

Returns Contains an absolute URL for this Deployment resource.

Returns:

  • (String) —

    Contains an absolute URL for this Deployment resource.



313
314
315
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 313

def url
    @properties['url']
end