twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/monitor/v1/event.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -25,12 +27,21 @@ module Twilio
           # 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 [String] actor_sid The actor_sid
-          # @param [String] event_type The event_type
-          # @param [String] resource_sid The resource_sid
-          # @param [String] source_ip_address The source_ip_address
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
+          # @param [String] actor_sid Only include events initiated by this Actor. Useful
+          #   for auditing actions taken by specific users or API credentials.
+          # @param [String] event_type Only include events of this {Event
+          #   Type}[https://www.twilio.com/docs/usage/monitor-events#event-types].
+          # @param [String] resource_sid Only include events that refer to this resource.
+          #   Useful for discovering the history of a specific resource.
+          # @param [String] source_ip_address Only include events that originated from this
+          #   IP address. Useful for tracking suspicious activity originating from the API or
+          #   the Twilio Console.
+          # @param [Time] start_date Only include events that occurred on or after this
+          #   date. Specify the date in GMT and {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+          # @param [Time] end_date Only include events that occurred on or before this date.
+          #   Specify the date in GMT and {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+          #   format.
           # @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
@@ -55,12 +66,21 @@ module Twilio
           # Streams EventInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] actor_sid The actor_sid
-          # @param [String] event_type The event_type
-          # @param [String] resource_sid The resource_sid
-          # @param [String] source_ip_address The source_ip_address
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
+          # @param [String] actor_sid Only include events initiated by this Actor. Useful
+          #   for auditing actions taken by specific users or API credentials.
+          # @param [String] event_type Only include events of this {Event
+          #   Type}[https://www.twilio.com/docs/usage/monitor-events#event-types].
+          # @param [String] resource_sid Only include events that refer to this resource.
+          #   Useful for discovering the history of a specific resource.
+          # @param [String] source_ip_address Only include events that originated from this
+          #   IP address. Useful for tracking suspicious activity originating from the API or
+          #   the Twilio Console.
+          # @param [Time] start_date Only include events that occurred on or after this
+          #   date. Specify the date in GMT and {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+          # @param [Time] end_date Only include events that occurred on or before this date.
+          #   Specify the date in GMT and {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+          #   format.
           # @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
@@ -91,7 +111,7 @@ module Twilio
           def each
             limits = @version.read_limits
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page,
                             limit: limits[:limit],
@@ -101,12 +121,21 @@ module Twilio
           ##
           # Retrieve a single page of EventInstance records from the API.
           # Request is executed immediately.
-          # @param [String] actor_sid The actor_sid
-          # @param [String] event_type The event_type
-          # @param [String] resource_sid The resource_sid
-          # @param [String] source_ip_address The source_ip_address
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
+          # @param [String] actor_sid Only include events initiated by this Actor. Useful
+          #   for auditing actions taken by specific users or API credentials.
+          # @param [String] event_type Only include events of this {Event
+          #   Type}[https://www.twilio.com/docs/usage/monitor-events#event-types].
+          # @param [String] resource_sid Only include events that refer to this resource.
+          #   Useful for discovering the history of a specific resource.
+          # @param [String] source_ip_address Only include events that originated from this
+          #   IP address. Useful for tracking suspicious activity originating from the API or
+          #   the Twilio Console.
+          # @param [Time] start_date Only include events that occurred on or after this
+          #   date. Specify the date in GMT and {ISO
+          #   8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+          # @param [Time] end_date Only include events that occurred on or before this date.
+          #   Specify the date in GMT and {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+          #   format.
           # @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
@@ -117,17 +146,15 @@ module Twilio
                 'EventType' => event_type,
                 'ResourceSid' => resource_sid,
                 'SourceIpAddress' => source_ip_address,
-                'StartDate' => Twilio.serialize_iso8601_date(start_date),
-                'EndDate' => Twilio.serialize_iso8601_date(end_date),
+                'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
                 'PageToken' => page_token,
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             EventPage.new(@version, response, @solution)
           end
 
@@ -170,7 +197,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [EventInstance] EventInstance
           def get_instance(payload)
-            EventInstance.new(@version, payload)
+            EventInstance.new(@version, payload, )
           end
 
           ##
@@ -184,29 +211,23 @@ module Twilio
           ##
           # Initialize the EventContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Event resource to fetch.
           # @return [EventContext] EventContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Events/#{@solution[:sid]}"
           end
 
           ##
-          # Fetch a EventInstance
+          # Fetch the EventInstance
           # @return [EventInstance] Fetched EventInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
-            EventInstance.new(@version, payload, sid: @solution[:sid])
+            EventInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -215,6 +236,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Monitor.V1.EventContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Monitor.V1.EventContext #{context}>"
+          end
         end
 
         class EventInstance < InstanceResource
@@ -222,7 +250,7 @@ module Twilio
           # Initialize the EventInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Event resource to fetch.
           # @return [EventInstance] EventInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -247,7 +275,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -256,97 +284,97 @@ module Twilio
           # @return [EventContext] EventContext for this EventInstance
           def context
             unless @instance_context
-              @instance_context = EventContext.new(@version, @params['sid'])
+              @instance_context = EventContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The actor_sid
+          # @return [String] The SID of the actor that caused the event, if available
           def actor_sid
             @properties['actor_sid']
           end
 
           ##
-          # @return [String] The actor_type
+          # @return [String] The type of actor that caused the event
           def actor_type
             @properties['actor_type']
           end
 
           ##
-          # @return [String] The description
+          # @return [String] A description of the event
           def description
             @properties['description']
           end
 
           ##
-          # @return [Hash] The event_data
+          # @return [Hash] A JSON string that represents an object with additional data about the event
           def event_data
             @properties['event_data']
           end
 
           ##
-          # @return [Time] The event_date
+          # @return [Time] The ISO 8601 date and time in GMT when the event was recorded
           def event_date
             @properties['event_date']
           end
 
           ##
-          # @return [String] The event_type
+          # @return [String] The event's type
           def event_type
             @properties['event_type']
           end
 
           ##
-          # @return [String] The resource_sid
+          # @return [String] The SID of the resource that was affected
           def resource_sid
             @properties['resource_sid']
           end
 
           ##
-          # @return [String] The resource_type
+          # @return [String] The type of resource that was affected
           def resource_type
             @properties['resource_type']
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The source
+          # @return [String] The originating system or interface that caused the event
           def source
             @properties['source']
           end
 
           ##
-          # @return [String] The source_ip_address
+          # @return [String] The IP address of the source
           def source_ip_address
             @properties['source_ip_address']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource that was affected
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The absolute URLs of related resources
           def links
             @properties['links']
           end
 
           ##
-          # Fetch a EventInstance
+          # Fetch the EventInstance
           # @return [EventInstance] Fetched EventInstance
           def fetch
             context.fetch

data/lib/twilio-ruby/rest/monitor/v1.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,30 +20,32 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Alert resource to fetch.
         # @return [Twilio::REST::Monitor::V1::AlertContext] if sid was passed.
         # @return [Twilio::REST::Monitor::V1::AlertList]
         def alerts(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @alerts ||= AlertList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @alerts ||= AlertList.new self
           else
-            AlertContext.new(self, sid)
+              AlertContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Event resource to fetch.
         # @return [Twilio::REST::Monitor::V1::EventContext] if sid was passed.
         # @return [Twilio::REST::Monitor::V1::EventList]
         def events(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @events ||= EventList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @events ||= EventList.new self
           else
-            EventContext.new(self, sid)
+              EventContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/monitor.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Alert
+      #   resource.
       # @return [Twilio::REST::Monitor::V1::AlertInstance] if sid was passed.
       # @return [Twilio::REST::Monitor::V1::AlertList]
       def alerts(sid=:unset)
@@ -35,7 +38,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Event
+      #   resource.
       # @return [Twilio::REST::Monitor::V1::EventInstance] if sid was passed.
       # @return [Twilio::REST::Monitor::V1::EventList]
       def events(sid=:unset)