notification.rb in twilio-ruby-5.0.0

- old
+ new

@@ -31,11 +31,11 @@
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [String] log Only show notifications for this log level
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
+            # @param [Time] message_date_after Filter by date
             # @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
             #  but a limit is defined, stream() will attempt to read                      the
@@ -57,11 +57,11 @@
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [String] log Only show notifications for this log level
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
+            # @param [Time] message_date_after Filter by date
             # @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
             #                       but a limit is defined, stream() will attempt to                      read the
@@ -83,20 +83,10 @@
 
             ##
             # When passed a block, yields NotificationInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] log Only show notifications for this log level
-            # @param [Time] message_date_before Filter by date
-            # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
-            # @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
-            #                       but a limit is defined, stream() will attempt to read the
-            #                       limit with the most efficient page size, i.e. min(limit, 1000)
             def each
               limits = @version.read_limits
 
               page = self.page(
                   page_size: limits[:page_size],
@@ -111,11 +101,11 @@
             # Retrieve a single page of NotificationInstance records from the API.
             # Request is executed immediately.
             # @param [String] log Only show notifications for this log level
             # @param [Time] message_date_before Filter by date
             # @param [Time] message_date Filter by date
-            # @param [Time] message_date_after: Filter by date
+            # @param [Time] message_date_after Filter by date
             # @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 NotificationInstance
             def page(log: :unset, message_date_before: :unset, message_date: :unset, message_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
@@ -160,12 +150,10 @@
             ##
             # Initialize the NotificationPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @param [String] account_sid The unique id of the Account responsible for this
-            #   notification.
             # @return [NotificationPage] NotificationPage
             def initialize(version, response, solution)
               super(version, response)
 
               # Path Solution
@@ -286,11 +274,10 @@
             end
 
             ##
             # Generate an instance context for the instance, the context is capable of
             # performing various actions.  All instance actions are proxied to the context
-            # @param [Version] version Version that contains the resource
             # @return [NotificationContext] NotificationContext for this NotificationInstance
             def context
               unless @instance_context
                 @instance_context = NotificationContext.new(
                     @version,
@@ -299,73 +286,107 @@
                 )
               end
               @instance_context
             end
 
+            ##
+            # @return [String] The unique sid that identifies this account
             def account_sid
               @properties['account_sid']
             end
 
+            ##
+            # @return [String] The version of the Twilio API in use
             def api_version
               @properties['api_version']
             end
 
+            ##
+            # @return [String] The string that uniquely identifies the call
             def call_sid
               @properties['call_sid']
             end
 
+            ##
+            # @return [Time] The date this resource was created
             def date_created
               @properties['date_created']
             end
 
+            ##
+            # @return [Time] The date this resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
+            ##
+            # @return [String] A unique error code corresponding to the notification
             def error_code
               @properties['error_code']
             end
 
+            ##
+            # @return [String] An integer log level
             def log
               @properties['log']
             end
 
+            ##
+            # @return [Time] The date the notification was generated
             def message_date
               @properties['message_date']
             end
 
+            ##
+            # @return [String] The text of the notification.
             def message_text
               @properties['message_text']
             end
 
+            ##
+            # @return [String] A URL for more information about the error code
             def more_info
               @properties['more_info']
             end
 
+            ##
+            # @return [String] HTTP method used with the request url
             def request_method
               @properties['request_method']
             end
 
+            ##
+            # @return [String] URL of the resource that generated the notification
             def request_url
               @properties['request_url']
             end
 
+            ##
+            # @return [String] Twilio-generated HTTP variables sent to the server
             def request_variables
               @properties['request_variables']
             end
 
+            ##
+            # @return [String] The HTTP body returned by your server.
             def response_body
               @properties['response_body']
             end
 
+            ##
+            # @return [String] The HTTP headers returned by your server.
             def response_headers
               @properties['response_headers']
             end
 
+            ##
+            # @return [String] A string that uniquely identifies this notification
             def sid
               @properties['sid']
             end
 
+            ##
+            # @return [String] The URI for this resource
             def uri
               @properties['uri']
             end
 
             ##
\ No newline at end of file