Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ WorkflowInstance

Initialize the WorkflowInstance

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 295

def initialize(version, payload, workspace_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'assignment_callback_url' => payload['assignment_callback_url'],
      'configuration' => payload['configuration'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'document_content_type' => payload['document_content_type'],
      'fallback_assignment_callback_url' => payload['fallback_assignment_callback_url'],
      'friendly_name' => payload['friendly_name'],
      'sid' => payload['sid'],
      'task_reservation_timeout' => payload['task_reservation_timeout'].to_i,
      '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_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#assignment_callback_url ⇒ String

Returns The assignment_callback_url.

Returns:

  • (String) —

    The assignment_callback_url



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

def assignment_callback_url
  @properties['assignment_callback_url']
end

#configuration ⇒ String

Returns The configuration.

Returns:

  • (String) —

    The configuration



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

def configuration
  @properties['configuration']
end

#context ⇒ WorkflowContext

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

Returns:



324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 324

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:



459
460
461
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 459

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WorkflowInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



438
439
440
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 438

def delete
  context.delete
end

#document_content_type ⇒ String

Returns The document_content_type.

Returns:

  • (String) —

    The document_content_type



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

def document_content_type
  @properties['document_content_type']
end

#fallback_assignment_callback_url ⇒ String

Returns The fallback_assignment_callback_url.

Returns:

  • (String) —

    The fallback_assignment_callback_url



369
370
371
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 369

def fallback_assignment_callback_url
  @properties['fallback_assignment_callback_url']
end

#fetch ⇒ WorkflowInstance

Fetch a WorkflowInstance

Returns:



412
413
414
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 412

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



472
473
474
475
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 472

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



452
453
454
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 452

def real_time_statistics
  context.real_time_statistics
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



445
446
447
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 445

def statistics
  context.statistics
end

#task_reservation_timeout ⇒ String

Returns The task_reservation_timeout.

Returns:

  • (String) —

    The task_reservation_timeout



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

def task_reservation_timeout
  @properties['task_reservation_timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



465
466
467
468
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 465

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

#update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset) ⇒ WorkflowInstance

Update the WorkflowInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

    The friendly_name

  • assignment_callback_url (String) (defaults to: :unset) —

    The assignment_callback_url

  • fallback_assignment_callback_url (String) (defaults to: :unset) —

    The fallback_assignment_callback_url

  • configuration (String) (defaults to: :unset) —

    The configuration

  • task_reservation_timeout (String) (defaults to: :unset) —

    The task_reservation_timeout

Returns:



425
426
427
428
429
430
431
432
433
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 425

def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset)
  context.update(
      friendly_name: friendly_name,
      assignment_callback_url: assignment_callback_url,
      fallback_assignment_callback_url: fallback_assignment_callback_url,
      configuration: configuration,
      task_reservation_timeout: task_reservation_timeout,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end