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

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

    The SID of the Workspace that contains the Activity.

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

    The SID of the Activity resource to fetch.



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 271

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'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



304
305
306
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 304

def 
  @properties['account_sid']
end

#available ⇒ Boolean

Returns Whether the Worker should be eligible to receive a Task when it occupies the Activity.

Returns:

  • (Boolean) —

    Whether the Worker should be eligible to receive a Task when it occupies the Activity



310
311
312
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 310

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:



295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/activity.rb', line 295

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ActivityInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ ActivityInstance

Fetch the ActivityInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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



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

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



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

def workspace_sid
  @properties['workspace_sid']
end