twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,18 +27,14 @@ module Twilio
           # Lists AlertInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] log_level Only show alerts for this log-level.  One of 'error',
-          #   'warning', 'notice', or 'debug'.
-          # @param [Date] start_date Only show Alerts on or after this date.  Useful in
-          #   combination with `EndDate` to define a date-range of Alerts.  Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter. Queries for Alerts older than 30 days are not
-          #   supported.
-          # @param [Date] end_date Only show Alerts on or before this date.  Useful in
-          #   combination with `StartDate` to define a date-range of Alerts.  Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter. Queries for Alerts older than 30 days are not
-          #   supported.
+          # @param [String] log_level Only show alerts for this log-level.  Can be: `error`,
+          #   `warning`, `notice`, or `debug`.
+          # @param [Time] start_date Only include alerts that occurred on or after this date
+          #   and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or
+          #   `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
+          # @param [Time] end_date Only include alerts that occurred on or before this date
+          #   and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or
+          #   `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
           # @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
@@ -60,18 +56,14 @@ module Twilio
           # Streams AlertInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] log_level Only show alerts for this log-level.  One of 'error',
-          #   'warning', 'notice', or 'debug'.
-          # @param [Date] start_date Only show Alerts on or after this date.  Useful in
-          #   combination with `EndDate` to define a date-range of Alerts.  Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter. Queries for Alerts older than 30 days are not
-          #   supported.
-          # @param [Date] end_date Only show Alerts on or before this date.  Useful in
-          #   combination with `StartDate` to define a date-range of Alerts.  Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter. Queries for Alerts older than 30 days are not
-          #   supported.
+          # @param [String] log_level Only show alerts for this log-level.  Can be: `error`,
+          #   `warning`, `notice`, or `debug`.
+          # @param [Time] start_date Only include alerts that occurred on or after this date
+          #   and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or
+          #   `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
+          # @param [Time] end_date Only include alerts that occurred on or before this date
+          #   and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or
+          #   `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
           # @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
@@ -109,18 +101,14 @@ module Twilio
           ##
           # Retrieve a single page of AlertInstance records from the API.
           # Request is executed immediately.
-          # @param [String] log_level Only show alerts for this log-level.  One of 'error',
-          #   'warning', 'notice', or 'debug'.
-          # @param [Date] start_date Only show Alerts on or after this date.  Useful in
-          #   combination with `EndDate` to define a date-range of Alerts.  Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter. Queries for Alerts older than 30 days are not
-          #   supported.
-          # @param [Date] end_date Only show Alerts on or before this date.  Useful in
-          #   combination with `StartDate` to define a date-range of Alerts.  Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter. Queries for Alerts older than 30 days are not
-          #   supported.
+          # @param [String] log_level Only show alerts for this log-level.  Can be: `error`,
+          #   `warning`, `notice`, or `debug`.
+          # @param [Time] start_date Only include alerts that occurred on or after this date
+          #   and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or
+          #   `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
+          # @param [Time] end_date Only include alerts that occurred on or before this date
+          #   and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or
+          #   `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.
           # @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
@@ -128,17 +116,15 @@ module Twilio
           def page(log_level: :unset, start_date: :unset, end_date: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
             params = Twilio::Values.of({
                 'LogLevel' => log_level,
-                '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)
+
             AlertPage.new(@version, response, @solution)
           end
 
@@ -195,7 +181,7 @@ module Twilio
           ##
           # Initialize the AlertContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Alert resource to fetch.
           # @return [AlertContext] AlertContext
           def initialize(version, sid)
             super(version)
@@ -206,30 +192,24 @@ module Twilio
           end
 
           ##
-          # Fetch a AlertInstance
+          # Fetch the AlertInstance
           # @return [AlertInstance] Fetched AlertInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             AlertInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the AlertInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            @version.delete('delete', @uri)
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Monitor.V1.AlertContext #{context}>"
           end
 
           ##
-          # Provide a user friendly representation
-          def to_s
+          # Provide a detailed, user friendly representation
+          def inspect
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Monitor.V1.AlertContext #{context}>"
           end
@@ -240,7 +220,7 @@ module Twilio
           # Initialize the AlertInstance
           # @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 Alert resource to fetch.
           # @return [AlertInstance] AlertInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -258,12 +238,14 @@ module Twilio
                 'more_info' => payload['more_info'],
                 'request_method' => payload['request_method'],
                 'request_url' => payload['request_url'],
-                'resource_sid' => payload['resource_sid'],
-                'sid' => payload['sid'],
-                'url' => payload['url'],
                 'request_variables' => payload['request_variables'],
+                'resource_sid' => payload['resource_sid'],
                 'response_body' => payload['response_body'],
                 'response_headers' => payload['response_headers'],
+                'sid' => payload['sid'],
+                'url' => payload['url'],
+                'request_headers' => payload['request_headers'],
+                'service_sid' => payload['service_sid'],
             }
 
             # Context
@@ -283,119 +265,124 @@ module Twilio
           end
 
           ##
-          # @return [String] The unique id of the Account responsible for this alert.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The text of the alert.
+          # @return [String] The text of the alert
           def alert_text
             @properties['alert_text']
           end
 
           ##
-          # @return [String] The version of the Twilio API in use when this alert was generated.
+          # @return [String] The API version used when the alert was generated
           def api_version
             @properties['api_version']
           end
 
           ##
-          # @return [Time] The date that this resource was created, given in ISO 8601 format.
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date the alert was actually generated, given in ISO 8601 format.
+          # @return [Time] The date and time when the alert was generated specified in ISO 8601 format
           def date_generated
             @properties['date_generated']
           end
 
           ##
-          # @return [Time] The most recent date that this resource was updated, given in ISO 8601 format.
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] A unique error code for the error condition.
+          # @return [String] The error code for the condition that generated the alert
           def error_code
             @properties['error_code']
           end
 
           ##
-          # @return [String] A string representing the log level.
+          # @return [String] The log level
           def log_level
             @properties['log_level']
           end
 
           ##
-          # @return [String] A URL for more information about the error condition.
+          # @return [String] The URL of the page in our Error Dictionary with more information about the error condition
           def more_info
             @properties['more_info']
           end
 
           ##
-          # @return [String] If the Alert was generated by a request Twilio made to your server, this will be the request method used when Twilio made the request to your server.
+          # @return [String] The method used by the request that generated the alert
           def request_method
             @properties['request_method']
           end
 
           ##
-          # @return [String] If the Alert was generated by a request Twilio made to your server, this will be the URL on your server that generated the alert.
+          # @return [String] The URL of the request that generated the alert
           def request_url
             @properties['request_url']
           end
 
           ##
-          # @return [String] The request_variables
+          # @return [String] The variables passed in the request that generated the alert
           def request_variables
             @properties['request_variables']
           end
 
           ##
-          # @return [String] The unique ID of the resource for which the Alert was generated.
+          # @return [String] The SID of the resource for which the alert was generated
           def resource_sid
             @properties['resource_sid']
           end
 
           ##
-          # @return [String] The response_body
+          # @return [String] The response body of the request that generated the alert
           def response_body
             @properties['response_body']
           end
 
           ##
-          # @return [String] The response_headers
+          # @return [String] The response headers of the request that generated the alert
           def response_headers
             @properties['response_headers']
           end
 
           ##
-          # @return [String] A 34 character string that uniquely identifies this Alert.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The absolute URL for this resource.
+          # @return [String] The absolute URL of the Alert resource
           def url
             @properties['url']
           end
 
           ##
-          # Fetch a AlertInstance
-          # @return [AlertInstance] Fetched AlertInstance
-          def fetch
-            context.fetch
+          # @return [String] The request headers of the request that generated the alert
+          def request_headers
+            @properties['request_headers']
+          end
+
+          ##
+          # @return [String] The SID of the service or resource that generated the alert
+          def service_sid
+            @properties['service_sid']
           end
 
           ##
-          # Deletes the AlertInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
-          def delete
-            context.delete
+          # Fetch the AlertInstance
+          # @return [AlertInstance] Fetched AlertInstance
+          def fetch
+            context.fetch
           end
 
           ##

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -27,22 +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 Only include Events initiated by this Actor. Useful
+          # @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 EventType.
-          # @param [String] resource_sid Only include Events referring to this resource.
+          # @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
+          # @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 show events on or after this date. Useful in
-          #   combination with `EndDate` to define a date-range of events. Input is a [UTC ISO
-          #   8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
-          #   ignored by the filter.
-          # @param [Time] end_date Only show events on or before this date. Useful in
-          #   combination with `StartDate` to define a date-range of events. Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter.
+          # @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
@@ -67,22 +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 Only include Events initiated by this Actor. Useful
+          # @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 EventType.
-          # @param [String] resource_sid Only include Events referring to this resource.
+          # @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
+          # @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 show events on or after this date. Useful in
-          #   combination with `EndDate` to define a date-range of events. Input is a [UTC ISO
-          #   8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
-          #   ignored by the filter.
-          # @param [Time] end_date Only show events on or before this date. Useful in
-          #   combination with `StartDate` to define a date-range of events. Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter.
+          # @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
@@ -123,22 +121,21 @@ module Twilio
           ##
           # Retrieve a single page of EventInstance records from the API.
           # Request is executed immediately.
-          # @param [String] actor_sid Only include Events initiated by this Actor. Useful
+          # @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 EventType.
-          # @param [String] resource_sid Only include Events referring to this resource.
+          # @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
+          # @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 show events on or after this date. Useful in
-          #   combination with `EndDate` to define a date-range of events. Input is a [UTC ISO
-          #   8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
-          #   ignored by the filter.
-          # @param [Time] end_date Only show events on or before this date. Useful in
-          #   combination with `StartDate` to define a date-range of events. Input is a [UTC
-          #   ISO 8601 Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day
-          #   is ignored by the filter.
+          # @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
@@ -155,11 +152,9 @@ module Twilio
                 '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
 
@@ -216,7 +211,7 @@ module Twilio
           ##
           # Initialize the EventContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this event.
+          # @param [String] sid The SID of the Event resource to fetch.
           # @return [EventContext] EventContext
           def initialize(version, sid)
             super(version)
@@ -227,16 +222,10 @@ module Twilio
           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], )
           end
@@ -247,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
@@ -254,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 A 34 character string that uniquely identifies this event.
+          # @param [String] sid The SID of the Event resource to fetch.
           # @return [EventInstance] EventInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -294,49 +290,49 @@ module Twilio
           end
 
           ##
-          # @return [String] A 34 character string identifying the Account for which this Event was recorded.
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] If available, a 34 character string identifying the actor that caused this event. May be null.
+          # @return [String] The SID of the actor that caused the event, if available
           def actor_sid
             @properties['actor_sid']
           end
 
           ##
-          # @return [String] The type of actor that caused this event
+          # @return [String] The type of actor that caused the event
           def actor_type
             @properties['actor_type']
           end
 
           ##
-          # @return [String] A human-readable description of the event.  May be null.
+          # @return [String] A description of the event
           def description
             @properties['description']
           end
 
           ##
-          # @return [Hash] A freeform json object encoding additional data about the event
+          # @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 date-time the event was recorded
+          # @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's type, as a string.
+          # @return [String] The event's type
           def event_type
             @properties['event_type']
           end
 
           ##
-          # @return [String] A 34 character string identifying the resource that was affected.
+          # @return [String] The SID of the resource that was affected
           def resource_sid
             @properties['resource_sid']
           end
@@ -348,13 +344,13 @@ module Twilio
           end
 
           ##
-          # @return [String] A 34 character string that uniquely identifies this event.
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The originating system or interface that caused the event.  web for events caused by user action in the Twilio Console.  api for events caused through a request to the REST API.  twilio for events caused by an automated or internal Twilio system.
+          # @return [String] The originating system or interface that caused the event
           def source
             @properties['source']
           end
@@ -366,19 +362,19 @@ module Twilio
           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