twilio-ruby 5.8.1 → 5.9.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,8 @@ module Twilio
             ##
             # Initialize the AlphaSenderList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The 34 character unique sid of the Messaging
+            #   Service.
             # @return [AlphaSenderList] AlphaSenderList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,7 +31,9 @@ module Twilio
             ##
             # Retrieve a single page of AlphaSenderInstance records from the API.
             # Request is executed immediately.
-            # @param [String] alpha_sender The alpha_sender
+            # @param [String] alpha_sender An Alphanumeric Sender ID string, up to 11
+            #   characters. Valid characters are A-Z, a-z, 0-9, space and dash ( - ). An
+            #   Alphanumeric Sender ID string cannot be comprised of only numbers.
             # @return [AlphaSenderInstance] Newly created AlphaSenderInstance
             def create(alpha_sender: nil)
               data = Twilio::Values.of({'AlphaSender' => alpha_sender, })
@@ -221,7 +226,8 @@ module Twilio
             # Initialize the AlphaSenderInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The 34 character unique sid of the Messaging
+            #   Service.
             # @param [String] sid The sid
             # @return [AlphaSenderInstance] AlphaSenderInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -256,49 +262,49 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The 34 character unique sid of the Alpha Sender ID.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The 34 character unique sid of the Account.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The 34 character unique sid of the Messaging Service.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The alpha_sender
+            # @return [String] An Alphanumeric Sender ID string, up to 11 characters.
             def alpha_sender
               @properties['alpha_sender']
             end
 
             ##
-            # @return [Hash] The capabilities
+            # @return [Hash] An array of values that indicate whether the number can receive calls or messages.
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL for this resource.
             def url
               @properties['url']
             end

data/lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -15,7 +17,7 @@ module Twilio
             ##
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The 34 character unique sid of the Service.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,7 +30,8 @@ module Twilio
             ##
             # Retrieve a single page of PhoneNumberInstance records from the API.
             # Request is executed immediately.
-            # @param [String] phone_number_sid The phone_number_sid
+            # @param [String] phone_number_sid Phone Number SID for the Phone Number being
+            #   added to the Service.
             # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
             def create(phone_number_sid: nil)
               data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })
@@ -221,7 +224,7 @@ module Twilio
             # Initialize the PhoneNumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The service_sid
+            # @param [String] service_sid The 34 character unique sid of the Service.
             # @param [String] sid The sid
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
@@ -257,55 +260,55 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The 34 character unique sid of the Phone Number.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The 34 character unique sid of the Account.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The service_sid
+            # @return [String] The 34 character unique sid of the Service.
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date that this resource was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date that this resource was last updated.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The phone_number
+            # @return [String] The E.
             def phone_number
               @properties['phone_number']
             end
 
             ##
-            # @return [String] The country_code
+            # @return [String] The 2 character ISO Country Code of the number.
             def country_code
               @properties['country_code']
             end
 
             ##
-            # @return [String] The capabilities
+            # @return [String] Any array of values that indicate whether the number can receive calls or messages.
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL for this resource.
             def url
               @properties['url']
             end

data/lib/twilio-ruby/rest/messaging/v1/service/short_code.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/messaging/v1/service.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -26,20 +28,44 @@ module Twilio
           ##
           # Retrieve a single page of ServiceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
-          # @param [String] inbound_request_url The inbound_request_url
-          # @param [String] inbound_method The inbound_method
-          # @param [String] fallback_url The fallback_url
-          # @param [String] fallback_method The fallback_method
-          # @param [String] status_callback The status_callback
-          # @param [Boolean] sticky_sender The sticky_sender
-          # @param [Boolean] mms_converter The mms_converter
-          # @param [Boolean] smart_encoding The smart_encoding
+          # @param [String] friendly_name A human readable descriptive text for this
+          #   resource, up to 64 characters.
+          # @param [String] inbound_request_url A [webhook
+          #   request](https://www.twilio.com/docs/api/twiml/sms/twilio_request) is made to
+          #   the Inbound Request URL when a message is received by any phone number or
+          #   shortcode associated to your Messaging Service. Set to `null` to disable inbound
+          #   messaging.
+          # @param [String] inbound_method The HTTP method used when making requests to the
+          #   Inbound Request URL. Either `GET` or `POST`. Default value is `POST`.
+          # @param [String] fallback_url A request is made to the Fallback URL if an error
+          #   occurs with retrieving or executing the TwiML from you Inbound Request URL.
+          # @param [String] fallback_method The HTTP method used when requesting the
+          #   Fallback URL. Either `GET` or `POST`. Default value is `POST`.
+          # @param [String] status_callback A webhook request is made to the Status Callback
+          #   to pass [status
+          #   updates](https://www.twilio.com/docs/api/rest/message#sms-status-values) about
+          #   your messages. These status updates let you know if your accepted message were
+          #   successfully sent and delivered or if a [delivery related
+          #   error](https://www.twilio.com/docs/api/rest/message#error-values) may have
+          #   occurred.
+          # @param [Boolean] sticky_sender Configuration to enable or disable Sticky Sender
+          #   on your Service Instance. Possible values are `true` and `false`. Default value
+          #   is `true`.
+          # @param [Boolean] mms_converter Configuration to enable or disable MMS Converter
+          #   on your Service Instance. Possible values are `true` and `false`. Default value
+          #   is `true`.
+          # @param [Boolean] smart_encoding Configuration to enable or disable [Smart
+          #   Encoding](https://www.twilio.com/docs/api/messaging/services-and-copilot#smart-encoding). Possible values are `true` and `false`. Default value is `true`.
           # @param [service.ScanMessageContent] scan_message_content The
           #   scan_message_content
-          # @param [Boolean] fallback_to_long_code The fallback_to_long_code
-          # @param [Boolean] area_code_geomatch The area_code_geomatch
-          # @param [String] validity_period The validity_period
+          # @param [Boolean] fallback_to_long_code Configuration to enable or disable
+          #   [Fallback to Long
+          #   Code](https://www.twilio.com/docs/api/messaging/services-and-copilot#fallback-to-long-code). Possible values are `true` and `false`. Default value is `false`.
+          # @param [Boolean] area_code_geomatch Configuration to enable or disable [Area
+          #   Code
+          #   Geomatch](https://www.twilio.com/docs/api/messaging/services-and-copilot#area-code-geomatch). Possible values are `true` and `false`. Default value is `false`.
+          # @param [String] validity_period Configuration to set the [validity
+          #   period](https://www.twilio.com/docs/api/messaging/services-and-copilot#validity-period) of all messages sent from your Service, in seconds. Acceptable integers range from `1` to `14,400`.  Default value is `14,400`.
           # @param [Boolean] synchronous_validation The synchronous_validation
           # @return [ServiceInstance] Newly created ServiceInstance
           def create(friendly_name: nil, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset)
@@ -392,79 +418,79 @@ module Twilio
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] Unique 34 character ID of the Service.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] Unique 34 character ID of the Account that created this Service.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] A human readable descriptive text for this resource, up to 64 characters.
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date that this resource was created.
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date that this resource was last updated.
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The inbound_request_url
+          # @return [String] The URL Twilio will make a webhook request to when a message is received by any phone number or short code in your Service.
           def inbound_request_url
             @properties['inbound_request_url']
           end
 
           ##
-          # @return [String] The inbound_method
+          # @return [String] The HTTP method Twilio will use when making requests to the Inbound Request URL.
           def inbound_method
             @properties['inbound_method']
           end
 
           ##
-          # @return [String] The fallback_url
+          # @return [String] The URL that Twilio will request if an error occurs when retrieving or executing the TwiML from your Inbound Request URL.
           def fallback_url
             @properties['fallback_url']
           end
 
           ##
-          # @return [String] The fallback_method
+          # @return [String] The HTTP method Twilio will use when making requests to the Fallback URL.
           def fallback_method
             @properties['fallback_method']
           end
 
           ##
-          # @return [String] The status_callback
+          # @return [String] The URL Twilio will make a webhook request to when passing you status updates about the delivery of your messages.
           def status_callback
             @properties['status_callback']
           end
 
           ##
-          # @return [Boolean] The sticky_sender
+          # @return [Boolean] Configuration to enable or disable Sticky Sender on your Service instance.
           def sticky_sender
             @properties['sticky_sender']
           end
 
           ##
-          # @return [Boolean] The mms_converter
+          # @return [Boolean] Configuration to enable or disable MMS Converter for messages sent through your Service instance.
           def mms_converter
             @properties['mms_converter']
           end
 
           ##
-          # @return [Boolean] The smart_encoding
+          # @return [Boolean] Configuration to enable or disable Smart Encoding for messages sent through your Service instance.
           def smart_encoding
             @properties['smart_encoding']
           end
@@ -476,13 +502,13 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] The fallback_to_long_code
+          # @return [Boolean] Configuration to enable or disable Fallback to Long Code for messages sent through your Service instance.
           def fallback_to_long_code
             @properties['fallback_to_long_code']
           end
 
           ##
-          # @return [Boolean] The area_code_geomatch
+          # @return [Boolean] Configuration to enable or disable Area Code Geomatch on your Service Instance.
           def area_code_geomatch
             @properties['area_code_geomatch']
           end
@@ -494,7 +520,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The validity_period
+          # @return [String] The number of seconds all messages sent from your Service are valid for.
           def validity_period
             @properties['validity_period']
           end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid Unique 34 character ID of the Service.
       # @return [Twilio::REST::Messaging::V1::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Messaging::V1::ServiceList]
       def services(sid=:unset)

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -25,9 +27,18 @@ 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 The log_level
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
+          # @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 [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
@@ -49,9 +60,18 @@ 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 The log_level
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
+          # @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 [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
@@ -89,9 +109,18 @@ module Twilio
           ##
           # Retrieve a single page of AlertInstance records from the API.
           # Request is executed immediately.
-          # @param [String] log_level The log_level
-          # @param [Date] start_date The start_date
-          # @param [Date] end_date The end_date
+          # @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] 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
@@ -254,67 +283,67 @@ module Twilio
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] The unique id of the Account responsible for this alert.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The alert_text
+          # @return [String] The text of the alert.
           def alert_text
             @properties['alert_text']
           end
 
           ##
-          # @return [String] The api_version
+          # @return [String] The version of the Twilio API in use when this alert was generated.
           def api_version
             @properties['api_version']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date that this resource was created, given in ISO 8601 format.
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_generated
+          # @return [Time] The date the alert was actually generated, given in ISO 8601 format.
           def date_generated
             @properties['date_generated']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The most recent date that this resource was updated, given in ISO 8601 format.
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The error_code
+          # @return [String] A unique error code for the error condition.
           def error_code
             @properties['error_code']
           end
 
           ##
-          # @return [String] The log_level
+          # @return [String] A string representing the log level.
           def log_level
             @properties['log_level']
           end
 
           ##
-          # @return [String] The more_info
+          # @return [String] A URL for more information about the error condition.
           def more_info
             @properties['more_info']
           end
 
           ##
-          # @return [String] The request_method
+          # @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.
           def request_method
             @properties['request_method']
           end
 
           ##
-          # @return [String] The request_url
+          # @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.
           def request_url
             @properties['request_url']
           end
@@ -326,7 +355,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The resource_sid
+          # @return [String] The unique ID of the resource for which the Alert was generated.
           def resource_sid
             @properties['resource_sid']
           end
@@ -344,13 +373,13 @@ module Twilio
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] A 34 character string that uniquely identifies this Alert.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL for this resource.
           def url
             @properties['url']
           end