Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb

Defined Under Namespace

Classes: WorkflowCumulativeStatisticsContext, WorkflowCumulativeStatisticsInstance, WorkflowCumulativeStatisticsList, WorkflowCumulativeStatisticsPage, WorkflowRealTimeStatisticsContext, WorkflowRealTimeStatisticsInstance, WorkflowRealTimeStatisticsList, WorkflowRealTimeStatisticsPage, WorkflowStatisticsContext, WorkflowStatisticsInstance, WorkflowStatisticsList, WorkflowStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ WorkflowContext

Initialize the WorkflowContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • sid (String) —

    The sid



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 199

def initialize(version, workspace_sid, sid)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid, sid: sid, }
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:sid]}"

  # Dependents
  @statistics = nil
  @real_time_statistics = nil
  @cumulative_statistics = nil
end

Instance Method Details

#cumulative_statistics ⇒ WorkflowCumulativeStatisticsList, WorkflowCumulativeStatisticsContext

Access the cumulative_statistics

Returns:



300
301
302
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 300

def cumulative_statistics
  WorkflowCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
end

#delete ⇒ Boolean

Deletes the WorkflowInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



276
277
278
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 276

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ WorkflowInstance

Fetch a WorkflowInstance

Returns:



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 215

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  WorkflowInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      sid: @solution[:sid],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.WorkflowContext #{context}>"
end

#real_time_statistics ⇒ WorkflowRealTimeStatisticsList, WorkflowRealTimeStatisticsContext

Access the real_time_statistics

Returns:



292
293
294
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 292

def real_time_statistics
  WorkflowRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
end

#statistics ⇒ WorkflowStatisticsList, WorkflowStatisticsContext

Access the statistics

Returns:



284
285
286
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 284

def statistics
  WorkflowStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Taskrouter.V1.WorkflowContext #{context}>"
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) —

    A string representing a human readable name for this Workflow. Examples include ‘Customer Support’ or ‘Sales Team’.

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

    A valid URL for the application that will process task assignment events. See [Handling Task Assignment Callback](www.twilio.com/docs/api/taskrouter/handling-assignment-callbacks) for more details.

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

    If the request to the AssignmentCallbackUrl fails, the assignment callback will be made to this URL.

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

    JSON document configuring the rules for this Workflow. See [Configuring Workflows](www.twilio.com/docs/api/taskrouter/workflow-configuration) for more information.

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

    An integer value controlling how long in seconds TaskRouter will wait for a confirmation response from your application after assigning a Task to a worker. Defaults to 120 seconds. Maximum value is 86400 (24 hours)

Returns:



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 250

def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'AssignmentCallbackUrl' => assignment_callback_url,
      'FallbackAssignmentCallbackUrl' => fallback_assignment_callback_url,
      'Configuration' => configuration,
      'TaskReservationTimeout' => task_reservation_timeout,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  WorkflowInstance.new(
      @version,
      payload,
      workspace_sid: @solution[:workspace_sid],
      sid: @solution[:sid],
  )
end