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.


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

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#availableBoolean

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


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

def available
  @properties['available']
end

#contextActivityContext

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

Returns:


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

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the ActivityInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetchActivityInstance

Fetch the ActivityInstance

Returns:


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

def fetch
  context.fetch
end

#friendly_nameString

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

Returns:

  • (String)

    The string that you assigned to describe the Activity resource


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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

Returns The links.

Returns:

  • (String)

    The links


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

def links
  @properties['links']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#to_sObject

Provide a user friendly representation


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

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:


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

def update(friendly_name: :unset)
  context.update(friendly_name: friendly_name, )
end

#urlString

Returns The absolute URL of the Activity resource.

Returns:

  • (String)

    The absolute URL of the Activity resource


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

def url
  @properties['url']
end

#workspace_sidString

Returns The SID of the Workspace that contains the Activity.

Returns:

  • (String)

    The SID of the Workspace that contains the Activity


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

def workspace_sid
  @properties['workspace_sid']
end