Class: Twilio::REST::Preview::DeployedDevices::FleetContext::DeploymentContext

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, fleet_sid, sid) ⇒ DeploymentContext

Initialize the DeploymentContext

Parameters:

  • version (Version)

    Version that contains the resource

  • fleet_sid (String)

    The fleet_sid

  • sid (String)

    Provides a 34 character string that uniquely identifies the requested Deployment resource.


175
176
177
178
179
180
181
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 175

def initialize(version, fleet_sid, sid)
  super(version)

  # Path Solution
  @solution = {fleet_sid: fleet_sid, sid: sid, }
  @uri = "/Fleets/#{@solution[:fleet_sid]}/Deployments/#{@solution[:sid]}"
end

Instance Method Details

#deleteBoolean

Delete the DeploymentInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


195
196
197
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 195

def delete
   @version.delete('DELETE', @uri)
end

#fetchDeploymentInstance

Fetch the DeploymentInstance

Returns:


186
187
188
189
190
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 186

def fetch
  payload = @version.fetch('GET', @uri)

  DeploymentInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], sid: @solution[:sid], )
end

#inspectObject

Provide a detailed, user friendly representation


224
225
226
227
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 224

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.DeployedDevices.DeploymentContext #{context}>"
end

#to_sObject

Provide a user friendly representation


217
218
219
220
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 217

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.DeployedDevices.DeploymentContext #{context}>"
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:


207
208
209
210
211
212
213
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 207

def update(friendly_name: :unset, sync_service_sid: :unset)
  data = Twilio::Values.of({'FriendlyName' => friendly_name, 'SyncServiceSid' => sync_service_sid, })

  payload = @version.update('POST', @uri, data: data)

  DeploymentInstance.new(@version, payload, fleet_sid: @solution[:fleet_sid], sid: @solution[:sid], )
end