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.


198
199
200
201
202
203
204
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 198

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

Delete the ActivityInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


244
245
246
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 244

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

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

Returns:


209
210
211
212
213
214
215
216
217
218
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 209

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation


257
258
259
260
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 257

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

#to_s ⇒ Object

Provide a user friendly representation


250
251
252
253
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 250

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:


228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 228

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