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



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 183

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:



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

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



251
252
253
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 251

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

#fetch ⇒ WorkflowInstance

Fetch a WorkflowInstance

Returns:



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

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

#real_time_statistics ⇒ WorkflowRealTimeStatisticsList, WorkflowRealTimeStatisticsContext

Access the real_time_statistics

Returns:



267
268
269
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 267

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

#statistics ⇒ WorkflowStatisticsList, WorkflowStatisticsContext

Access the statistics

Returns:



259
260
261
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 259

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

#to_s ⇒ Object

Provide a user friendly representation



281
282
283
284
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 281

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

    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:



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow.rb', line 225

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