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)
  • sid (String) —

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



160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 160

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

#delete ⇒ Boolean

Delete the DeploymentInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



172
173
174
175
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 172

def delete

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

#fetch ⇒ DeploymentInstance

Fetch the DeploymentInstance

Returns:



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 180

def fetch

    payload = @version.fetch('GET', @uri)
    DeploymentInstance.new(
        @version,
        payload,
        fleet_sid: @solution[:fleet_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb', line 196

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