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 unique ID of the Workspace that this Activity belongs to.

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

    The sid



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

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 unique ID of the Account that owns this Activity.

Returns:

  • (String) —

    The unique ID of the Account that owns this Activity.



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

def 
  @properties['account_sid']
end

#available ⇒ Boolean

Returns Filter by activities that are available or unavailable.

Returns:

  • (Boolean) —

    Filter by activities that are available or unavailable.



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

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:



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

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 this Activity was created.

Returns:

  • (Time) —

    The date this Activity was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Activity was updated.

Returns:

  • (Time) —

    The date this Activity was updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ActivityInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ActivityInstance

Fetch a ActivityInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns Filter by an Activity’s friendly name.

Returns:

  • (String) —

    Filter by an Activity’s friendly name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sid ⇒ String

Returns The unique ID for this Activity.

Returns:

  • (String) —

    The unique ID for this Activity.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 human-readable name for the Activity, such as ‘on-call’, ‘break’, ‘email’, etc. These names will be used to calculate and expose statistics about workers, and give you visibility into the state of each of your workers.

Returns:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The unique ID of the Workspace that this Activity belongs to.

Returns:

  • (String) —

    The unique ID of the Workspace that this Activity belongs to.



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

def workspace_sid
  @properties['workspace_sid']
end