event.rb in twilio-ruby-5.9.0

- old
+ new

@@ -1,21 +1,23 @@
 ##
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
     class Taskrouter < Domain
       class V1 < Version
         class WorkspaceContext < InstanceContext
           class EventList < ListResource
             ##
             # Initialize the EventList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The sid
+            # @param [String] workspace_sid The unique ID of the Workspace
             # @return [EventList] EventList
             def initialize(version, workspace_sid: nil)
               super(version)
 
               # Path Solution
@@ -25,18 +27,25 @@
 
             ##
             # Lists EventInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [Time] end_date The end_date
-            # @param [String] event_type The event_type
-            # @param [String] minutes The minutes
-            # @param [String] reservation_sid The reservation_sid
-            # @param [Time] start_date The start_date
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_sid The task_sid
-            # @param [String] worker_sid The worker_sid
+            # @param [Time] end_date Filter events by an end date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] event_type Filter events by those of a certain event type
+            # @param [String] minutes Filter events by up to ‘x’ minutes in the past. This is
+            #   helpful for events for the last 15 minutes, 240 minutes (4 hours), and 480
+            #   minutes (8 hours) to see trends. Defaults to 15 minutes.
+            # @param [String] reservation_sid Filter events by those pertaining to a
+            #   particular reservation
+            # @param [Time] start_date Filter events by a start date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] task_queue_sid Filter events by those pertaining to a particular
+            #   queue
+            # @param [String] task_sid Filter events by those pertaining to a particular task
+            # @param [String] worker_sid Filter events by those pertaining to a particular
+            #   worker
             # @param [String] workflow_sid The workflow_sid
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
             #    not set will use the default value of 50 records.  If no page_size is defined
@@ -61,18 +70,25 @@
 
             ##
             # Streams EventInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [Time] end_date The end_date
-            # @param [String] event_type The event_type
-            # @param [String] minutes The minutes
-            # @param [String] reservation_sid The reservation_sid
-            # @param [Time] start_date The start_date
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_sid The task_sid
-            # @param [String] worker_sid The worker_sid
+            # @param [Time] end_date Filter events by an end date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] event_type Filter events by those of a certain event type
+            # @param [String] minutes Filter events by up to ‘x’ minutes in the past. This is
+            #   helpful for events for the last 15 minutes, 240 minutes (4 hours), and 480
+            #   minutes (8 hours) to see trends. Defaults to 15 minutes.
+            # @param [String] reservation_sid Filter events by those pertaining to a
+            #   particular reservation
+            # @param [Time] start_date Filter events by a start date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] task_queue_sid Filter events by those pertaining to a particular
+            #   queue
+            # @param [String] task_sid Filter events by those pertaining to a particular task
+            # @param [String] worker_sid Filter events by those pertaining to a particular
+            #   worker
             # @param [String] workflow_sid The workflow_sid
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
             # @param [Integer] page_size Number of records to fetch per request, when
             #    not set will use the default value of 50 records. If no page_size is defined
@@ -113,18 +129,25 @@
             end
 
             ##
             # Retrieve a single page of EventInstance records from the API.
             # Request is executed immediately.
-            # @param [Time] end_date The end_date
-            # @param [String] event_type The event_type
-            # @param [String] minutes The minutes
-            # @param [String] reservation_sid The reservation_sid
-            # @param [Time] start_date The start_date
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_sid The task_sid
-            # @param [String] worker_sid The worker_sid
+            # @param [Time] end_date Filter events by an end date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] event_type Filter events by those of a certain event type
+            # @param [String] minutes Filter events by up to ‘x’ minutes in the past. This is
+            #   helpful for events for the last 15 minutes, 240 minutes (4 hours), and 480
+            #   minutes (8 hours) to see trends. Defaults to 15 minutes.
+            # @param [String] reservation_sid Filter events by those pertaining to a
+            #   particular reservation
+            # @param [Time] start_date Filter events by a start date. This is helpful for
+            #   defining a range of events to capture. Input is a GMT ISO 8601 Timestamp.
+            # @param [String] task_queue_sid Filter events by those pertaining to a particular
+            #   queue
+            # @param [String] task_sid Filter events by those pertaining to a particular task
+            # @param [String] worker_sid Filter events by those pertaining to a particular
+            #   worker
             # @param [String] workflow_sid The workflow_sid
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
             # @return [Page] Page of EventInstance
@@ -241,11 +264,11 @@
           class EventInstance < InstanceResource
             ##
             # Initialize the EventInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] workspace_sid The sid
+            # @param [String] workspace_sid The unique ID of the Workspace
             # @param [String] sid The sid
             # @return [EventInstance] EventInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
 
@@ -283,11 +306,11 @@
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The account owning this event
             def account_sid
               @properties['account_sid']
             end
 
             ##
@@ -307,40 +330,40 @@
             def actor_url
               @properties['actor_url']
             end
 
             ##
-            # @return [String] The description
+            # @return [String] A description of the event
             def description
               @properties['description']
             end
 
             ##
-            # @return [String] The event_data
+            # @return [String] Data about this specific event.
             def event_data
               @properties['event_data']
             end
 
             ##
-            # @return [Time] The event_date
+            # @return [Time] The time this event was sent
             def event_date
               @properties['event_date']
             end
 
             ##
-            # @return [String] The event_type
+            # @return [String] An identifier for this event
             def event_type
               @properties['event_type']
             end
 
             ##
-            # @return [String] The resource_sid
+            # @return [String] The sid of the object this event is most relevant to
             def resource_sid
               @properties['resource_sid']
             end
 
             ##
-            # @return [String] The resource_type
+            # @return [String] The type of object this event is most relevant to
             def resource_type
               @properties['resource_type']
             end
 
             ##
\ No newline at end of file