Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext::WorkerStatisticsContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, worker_sid) ⇒ WorkerStatisticsContext

Initialize the WorkerStatisticsContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The SID of the Workspace with the WorkerChannel to fetch.

  • worker_sid (String) —

    The SID of the Worker with the WorkerChannel to fetch.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb', line 54

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

    # Path Solution
    @solution = { workspace_sid: workspace_sid, worker_sid: worker_sid,  }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_sid]}/Statistics"

    
end

Instance Method Details

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

Fetch the WorkerStatisticsInstance

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](en.wikipedia.org/wiki/ISO_8601) format.

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

    Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time.

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

    Only calculate statistics on this TaskChannel. Can be the TaskChannel’s SID or its unique_name, such as voice, sms, or default.

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb', line 71

def fetch(
    minutes: :unset, 
    start_date: :unset, 
    end_date: :unset, 
    task_channel: :unset
)

    params = Twilio::Values.of({
        'Minutes' => minutes,
        'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
        'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
        'TaskChannel' => task_channel,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, params: params, headers: headers)
    WorkerStatisticsInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        worker_sid: @solution[:worker_sid],
    )
end

#fetch_with_metadata(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset) ⇒ WorkerStatisticsInstance

Fetch the WorkerStatisticsInstanceMetadata

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](en.wikipedia.org/wiki/ISO_8601) format.

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

    Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time.

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

    Only calculate statistics on this TaskChannel. Can be the TaskChannel’s SID or its unique_name, such as voice, sms, or default.

Returns:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb', line 106

def fetch_with_metadata(
  minutes: :unset, 
  start_date: :unset, 
  end_date: :unset, 
  task_channel: :unset
)

    params = Twilio::Values.of({
        'Minutes' => minutes,
        'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
        'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
        'TaskChannel' => task_channel,
    })
    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
    worker_statistics_instance = WorkerStatisticsInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
        worker_sid: @solution[:worker_sid],
    )
    WorkerStatisticsInstanceMetadata.new(
        @version,
        worker_statistics_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



150
151
152
153
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb', line 150

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

#to_s ⇒ Object

Provide a user friendly representation



143
144
145
146
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb', line 143

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