Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::ActivityInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ ActivityInstance

Initialize the ActivityInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Activity resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 302

def initialize(version, payload , workspace_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'available' => payload['available'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'friendly_name' => payload['friendly_name'],
        'sid' => payload['sid'],
        'workspace_sid' => payload['workspace_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'workspace_sid' => workspace_sid  || @properties['workspace_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Activity resource.

Returns:



336
337
338
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 336

def 
    @properties['account_sid']
end

#available ⇒ Boolean

Returns Whether the Worker is eligible to receive a Task when it occupies the Activity. A value of ‘true`, `1`, or `yes` indicates the Activity is available. All other values indicate that it is not. The value cannot be changed after the Activity is created.

Returns:

  • (Boolean) —

    Whether the Worker is eligible to receive a Task when it occupies the Activity. A value of ‘true`, `1`, or `yes` indicates the Activity is available. All other values indicate that it is not. The value cannot be changed after the Activity is created.



342
343
344
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 342

def available
    @properties['available']
end

#context ⇒ ActivityContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



327
328
329
330
331
332
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 327

def context
    unless @instance_context
        @instance_context = ActivityContext.new(@version , @params['workspace_sid'], @params['sid'])
    end
    @instance_context
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 348

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 354

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ActivityInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

Returns:



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

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the Activity resource.

Returns:

  • (String) —

    The string that you assigned to describe the Activity resource.



360
361
362
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 360

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



426
427
428
429
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 426

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Taskrouter.V1.ActivityInstance #{values}>"
end

#links ⇒ Hash

Returns:

  • (Hash) 


384
385
386
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 384

def links
    @properties['links']
end

#sid ⇒ String

Returns The unique string that we created to identify the Activity resource.

Returns:

  • (String) —

    The unique string that we created to identify the Activity resource.



366
367
368
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 366

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



419
420
421
422
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 419

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Taskrouter.V1.ActivityInstance #{values}>"
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:



408
409
410
411
412
413
414
415
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 408

def update(
    friendly_name: :unset
)

    context.update(
        friendly_name: friendly_name, 
    )
end

#url ⇒ String

Returns The absolute URL of the Activity resource.

Returns:

  • (String) —

    The absolute URL of the Activity resource.



378
379
380
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 378

def url
    @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Activity.

Returns:

  • (String) —

    The SID of the Workspace that contains the Activity.



372
373
374
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 372

def workspace_sid
    @properties['workspace_sid']
end