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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowStatisticsInstance

Initialize the WorkflowStatisticsInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • workspace_sid (String) (defaults to: nil)

    The SID of the Workspace that contains the Workflow.

  • workflow_sid (String) (defaults to: nil)

    Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 154

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'cumulative' => payload['cumulative'],
      'realtime' => payload['realtime'],
      'workflow_sid' => payload['workflow_sid'],
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid, }
end

Instance Method Details

#account_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


189
190
191
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 189

def 
  @properties['account_sid']
end

#contextWorkflowStatisticsContext

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

Returns:


176
177
178
179
180
181
182
183
184
185
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 176

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

#cumulativeHash

Returns An object that contains the cumulative statistics for the Workflow.

Returns:

  • (Hash)

    An object that contains the cumulative statistics for the Workflow


195
196
197
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 195

def cumulative
  @properties['cumulative']
end

#fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkflowStatisticsInstance

Fetch the WorkflowStatisticsInstance

Parameters:

  • minutes (String) (defaults to: :unset)

    Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.

  • start_date (Time) (defaults to: :unset)

    Only calculate statistics from this date and time and later, specified in ISO 8601 format.

  • end_date (Time) (defaults to: :unset)

    Only calculate statistics from this date and time and earlier, specified in GMT as an ISO 8601 date-time.

  • task_channel (String) (defaults to: :unset)

    Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.

  • split_by_wait_time (String) (defaults to: :unset)

    A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.

Returns:


244
245
246
247
248
249
250
251
252
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 244

def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
  context.fetch(
      minutes: minutes,
      start_date: start_date,
      end_date: end_date,
      task_channel: task_channel,
      split_by_wait_time: split_by_wait_time,
  )
end

#inspectObject

Provide a detailed, user friendly representation


263
264
265
266
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 263

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

#realtimeHash

Returns An object that contains the real-time statistics for the Workflow.

Returns:

  • (Hash)

    An object that contains the real-time statistics for the Workflow


201
202
203
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 201

def realtime
  @properties['realtime']
end

#to_sObject

Provide a user friendly representation


256
257
258
259
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 256

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

#urlString

Returns The absolute URL of the Workflow statistics resource.

Returns:

  • (String)

    The absolute URL of the Workflow statistics resource


219
220
221
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 219

def url
  @properties['url']
end

#workflow_sidString

Returns the list of Tasks that are being controlled by the Workflow with the specified SID value

Returns:

  • (String)

    Returns the list of Tasks that are being controlled by the Workflow with the specified SID value


207
208
209
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 207

def workflow_sid
  @properties['workflow_sid']
end

#workspace_sidString

Returns The SID of the Workspace that contains the Workflow.

Returns:

  • (String)

    The SID of the Workspace that contains the Workflow


213
214
215
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 213

def workspace_sid
  @properties['workspace_sid']
end