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 workspace_sid

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

    The workflow_sid



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

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_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



186
187
188
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 186

def 
  @properties['account_sid']
end

#context ⇒ WorkflowStatisticsContext

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

Returns:



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

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

#cumulative ⇒ Hash

Returns The cumulative.

Returns:

  • (Hash) —

    The cumulative



192
193
194
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 192

def cumulative
  @properties['cumulative']
end

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

Fetch a WorkflowStatisticsInstance

Parameters:

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

    Filter cumulative statistics by up to ‘x’ minutes in the past. This is helpful for statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.

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

    Filter cumulative statistics by a start date. This is helpful for defining a range of statistics to capture. Input is a GMT ISO 8601 Timestamp

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

    Filter cumulative statistics by an end date. This is helpful for defining a range of statistics to capture. Input is a GMT ISO 8601 Timestamp

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

    Filter real-time and cumulative statistics by TaskChannel. Takes in a Unique Name (“voice”, “sms”, “default”, etc.) or a TaskChannelSid.

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

    A comma separated values for viewing splits of tasks canceled and accepted above the given threshold in seconds. Ex: “5,30” would show splits of tasks that were canceled or accepted before or after 5 seconds and respectively, 30 seconds. This is great for showing short abandoned tasks or tasks that failed to meet your SLA.

Returns:



240
241
242
243
244
245
246
247
248
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 240

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#realtime ⇒ Hash

Returns The realtime.

Returns:

  • (Hash) —

    The realtime



198
199
200
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 198

def realtime
  @properties['realtime']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



216
217
218
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 216

def url
  @properties['url']
end

#workflow_sid ⇒ String

Returns The workflow_sid.

Returns:

  • (String) —

    The workflow_sid



204
205
206
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 204

def workflow_sid
  @properties['workflow_sid']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



210
211
212
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb', line 210

def workspace_sid
  @properties['workspace_sid']
end