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.



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 281

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:



315
316
317
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 315

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.



321
322
323
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 321

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:



306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 306

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:



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

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:



333
334
335
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 333

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ActivityInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

Returns:



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

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.



339
340
341
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 339

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



405
406
407
408
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 405

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

#links ⇒ Hash

Returns:

  • (Hash) 


363
364
365
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 363

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.



345
346
347
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 345

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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.



357
358
359
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 357

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.



351
352
353
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 351

def workspace_sid
    @properties['workspace_sid']
end