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 update.

  • sid (String) —

    The SID of the Activity resource to update.



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

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



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

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the ActivityInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 268

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      activity_instance = ActivityInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      ActivityInstanceMetadata.new(@version, activity_instance, response.headers, response.status_code)
end

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 287

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    ActivityInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ ActivityInstance

Fetch the ActivityInstanceMetadata

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 307

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    activity_instance = ActivityInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
    ActivityInstanceMetadata.new(
        @version,
        activity_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



400
401
402
403
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 400

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

#to_s ⇒ Object

Provide a user friendly representation



393
394
395
396
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 393

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:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 334

def update(
    friendly_name: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ActivityInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(friendly_name: :unset) ⇒ ActivityInstance

Update the ActivityInstanceMetadata

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:



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 361

def update_with_metadata(
  friendly_name: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    activity_instance = ActivityInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
    ActivityInstanceMetadata.new(
        @version,
        activity_instance,
        response.headers,
        response.status_code
    )
end