Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::ActivityContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ ActivityContext

Initialize the ActivityContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The SID of the Workspace with the Activity resources to fetch.

  • sid (String) —

    The SID of the Activity resource to fetch.



204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 204

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

  # Path Solution
  @solution = {workspace_sid: workspace_sid, sid: sid, }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Activities/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the ActivityInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



260
261
262
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 260

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

#fetch ⇒ ActivityInstance

Fetch a ActivityInstance

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 215

def fetch
  params = Twilio::Values.of({})

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

  ActivityInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



273
274
275
276
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 273

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

#to_s ⇒ Object

Provide a user friendly representation



266
267
268
269
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 266

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.ActivityContext #{context}>"
end

#update(friendly_name: :unset) ⇒ ActivityInstance

Update the ActivityInstance

Parameters:

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

    A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: ‘on-call`, `break`, and `email`.

Returns:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 240

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

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

  ActivityInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      sid: @solution[:sid],
  )
end