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 workspace_sid

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

    The sid



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

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 account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#available ⇒ Boolean

Returns The available.

Returns:

  • (Boolean) —

    The available



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

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:



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

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_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ActivityInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ ActivityInstance

Fetch a ActivityInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) —

    The friendly_name

Returns:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end