twilio-ruby 5.6.0 → 5.33.0

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,21 +28,40 @@ 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 [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] synchronous_validation The synchronous_validation
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] inbound_request_url The URL we should call using
+          #   `inbound_method` when a message is received by any phone number or short code in
+          #   the Service. When this property is `null`, receiving inbound messages is
+          #   disabled.
+          # @param [String] inbound_method The HTTP method we should use to call
+          #   `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
+          # @param [String] fallback_url The URL that we should call using `fallback_method`
+          #   if an error occurs while retrieving or executing the TwiML from the Inbound
+          #   Request URL.
+          # @param [String] fallback_method The HTTP method we should use to call
+          #   `fallback_url`. Can be: `GET` or `POST`.
+          # @param [String] status_callback The URL we should call to [pass status
+          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
+          # @param [Boolean] sticky_sender Whether to enable [Sticky
+          #   Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service
+          #   instance.
+          # @param [Boolean] mms_converter Whether to enable the [MMS
+          #   Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages
+          #   sent through the Service instance.
+          # @param [Boolean] smart_encoding Whether to enable [Smart
+          #   Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages
+          #   sent through the Service instance.
+          # @param [service.ScanMessageContent] scan_message_content Reserved.
+          # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long
+          #   Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for
+          #   messages sent through the Service instance.
+          # @param [Boolean] area_code_geomatch Whether to enable [Area Code
+          #   Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the
+          #   Service Instance.
+          # @param [String] validity_period How long, in seconds, messages sent from the
+          #   Service are valid. Can be an integer from `1` to `14,400`.
+          # @param [Boolean] synchronous_validation Reserved.
           # @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)
             data = Twilio::Values.of({
@@ -66,7 +87,7 @@ module Twilio
                 data: data
             )
 
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -98,7 +119,7 @@ module Twilio
           def stream(limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(page_size: limits[:page_size])
+            page = self.page(page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -110,7 +131,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],
@@ -179,7 +200,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [ServiceInstance] ServiceInstance
           def get_instance(payload)
-            ServiceInstance.new(@version, payload)
+            ServiceInstance.new(@version, payload, )
           end
 
           ##
@@ -195,13 +216,13 @@ module Twilio
           ##
           # Initialize the ServiceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Service resource to fetch.
           # @return [ServiceContext] ServiceContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Services/#{@solution[:sid]}"
 
             # Dependents
@@ -212,21 +233,40 @@ module Twilio
 
           ##
           # Update the ServiceInstance
-          # @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 [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] synchronous_validation The synchronous_validation
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] inbound_request_url The URL we should call using
+          #   `inbound_method` when a message is received by any phone number or short code in
+          #   the Service. When this property is `null`, receiving inbound messages is
+          #   disabled.
+          # @param [String] inbound_method The HTTP method we should use to call
+          #   `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
+          # @param [String] fallback_url The URL that we should call using `fallback_method`
+          #   if an error occurs while retrieving or executing the TwiML from the Inbound
+          #   Request URL.
+          # @param [String] fallback_method The HTTP method we should use to call
+          #   `fallback_url`. Can be: `GET` or `POST`.
+          # @param [String] status_callback The URL we should call to [pass status
+          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
+          # @param [Boolean] sticky_sender Whether to enable [Sticky
+          #   Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service
+          #   instance.
+          # @param [Boolean] mms_converter Whether to enable the [MMS
+          #   Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages
+          #   sent through the Service instance.
+          # @param [Boolean] smart_encoding Whether to enable [Smart
+          #   Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages
+          #   sent through the Service instance.
+          # @param [service.ScanMessageContent] scan_message_content Reserved.
+          # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long
+          #   Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for
+          #   messages sent through the Service instance.
+          # @param [Boolean] area_code_geomatch Whether to enable [Area Code
+          #   Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the
+          #   Service Instance.
+          # @param [String] validity_period How long, in seconds, messages sent from the
+          #   Service are valid. Can be an integer from `1` to `14,400`.
+          # @param [Boolean] synchronous_validation Reserved.
           # @return [ServiceInstance] Updated ServiceInstance
           def update(friendly_name: :unset, 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)
             data = Twilio::Values.of({
@@ -252,7 +292,7 @@ module Twilio
                 data: data,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -267,12 +307,12 @@ module Twilio
                 params,
             )
 
-            ServiceInstance.new(@version, payload, sid: @solution[:sid])
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -285,11 +325,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return PhoneNumberContext.new(@version, @solution[:sid], sid)
+              return PhoneNumberContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @phone_numbers
-              @phone_numbers = PhoneNumberList.new(@version, service_sid: @solution[:sid])
+              @phone_numbers = PhoneNumberList.new(@version, service_sid: @solution[:sid], )
             end
 
             @phone_numbers
@@ -303,11 +343,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return ShortCodeContext.new(@version, @solution[:sid], sid)
+              return ShortCodeContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @short_codes
-              @short_codes = ShortCodeList.new(@version, service_sid: @solution[:sid])
+              @short_codes = ShortCodeList.new(@version, service_sid: @solution[:sid], )
             end
 
             @short_codes
@@ -321,11 +361,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return AlphaSenderContext.new(@version, @solution[:sid], sid)
+              return AlphaSenderContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @alpha_senders
-              @alpha_senders = AlphaSenderList.new(@version, service_sid: @solution[:sid])
+              @alpha_senders = AlphaSenderList.new(@version, service_sid: @solution[:sid], )
             end
 
             @alpha_senders
@@ -337,6 +377,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Messaging.V1.ServiceContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Messaging.V1.ServiceContext #{context}>"
+          end
         end
 
         ##
@@ -346,7 +393,7 @@ module Twilio
           # Initialize the ServiceInstance
           # @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 Service resource to fetch.
           # @return [ServiceInstance] ServiceInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -377,7 +424,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -386,148 +433,167 @@ module Twilio
           # @return [ServiceContext] ServiceContext for this ServiceInstance
           def context
             unless @instance_context
-              @instance_context = ServiceContext.new(@version, @params['sid'])
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           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 friendly_name
+          # @return [String] The string that you assigned to describe the resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Time] The date_created
+          # @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_updated
+          # @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] The inbound_request_url
+          # @return [String] The URL we call using inbound_method when a message is received by any phone number or short code in the Service
           def inbound_request_url
             @properties['inbound_request_url']
           end
 
           ##
-          # @return [String] The inbound_method
+          # @return [String] The HTTP method we use to call inbound_request_url
           def inbound_method
             @properties['inbound_method']
           end
 
           ##
-          # @return [String] The fallback_url
+          # @return [String] The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL
           def fallback_url
             @properties['fallback_url']
           end
 
           ##
-          # @return [String] The fallback_method
+          # @return [String] The HTTP method we use to call fallback_url
           def fallback_method
             @properties['fallback_method']
           end
 
           ##
-          # @return [String] The status_callback
+          # @return [String] The URL we call to pass status updates about message delivery
           def status_callback
             @properties['status_callback']
           end
 
           ##
-          # @return [Boolean] The sticky_sender
+          # @return [Boolean] Whether to enable Sticky Sender on the Service instance
           def sticky_sender
             @properties['sticky_sender']
           end
 
           ##
-          # @return [Boolean] The mms_converter
+          # @return [Boolean] Whether to enable the MMS Converter for messages sent through the Service instance
           def mms_converter
             @properties['mms_converter']
           end
 
           ##
-          # @return [Boolean] The smart_encoding
+          # @return [Boolean] Whether to enable Encoding for messages sent through the Service instance
           def smart_encoding
             @properties['smart_encoding']
           end
 
           ##
-          # @return [service.ScanMessageContent] The scan_message_content
+          # @return [service.ScanMessageContent] Reserved
           def scan_message_content
             @properties['scan_message_content']
           end
 
           ##
-          # @return [Boolean] The fallback_to_long_code
+          # @return [Boolean] Whether to enable Fallback to Long Code for messages sent through the Service instance
           def fallback_to_long_code
             @properties['fallback_to_long_code']
           end
 
           ##
-          # @return [Boolean] The area_code_geomatch
+          # @return [Boolean] Whether to enable Area Code Geomatch on the Service Instance
           def area_code_geomatch
             @properties['area_code_geomatch']
           end
 
           ##
-          # @return [Boolean] The synchronous_validation
+          # @return [Boolean] Reserved
           def synchronous_validation
             @properties['synchronous_validation']
           end
 
           ##
-          # @return [String] The validity_period
+          # @return [String] How long, in seconds, messages sent from the Service are valid
           def validity_period
             @properties['validity_period']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the Service resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The absolute URLs of related resources
           def links
             @properties['links']
           end
 
           ##
           # Update the ServiceInstance
-          # @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 [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] synchronous_validation The synchronous_validation
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] inbound_request_url The URL we should call using
+          #   `inbound_method` when a message is received by any phone number or short code in
+          #   the Service. When this property is `null`, receiving inbound messages is
+          #   disabled.
+          # @param [String] inbound_method The HTTP method we should use to call
+          #   `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.
+          # @param [String] fallback_url The URL that we should call using `fallback_method`
+          #   if an error occurs while retrieving or executing the TwiML from the Inbound
+          #   Request URL.
+          # @param [String] fallback_method The HTTP method we should use to call
+          #   `fallback_url`. Can be: `GET` or `POST`.
+          # @param [String] status_callback The URL we should call to [pass status
+          #   updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.
+          # @param [Boolean] sticky_sender Whether to enable [Sticky
+          #   Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service
+          #   instance.
+          # @param [Boolean] mms_converter Whether to enable the [MMS
+          #   Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages
+          #   sent through the Service instance.
+          # @param [Boolean] smart_encoding Whether to enable [Smart
+          #   Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages
+          #   sent through the Service instance.
+          # @param [service.ScanMessageContent] scan_message_content Reserved.
+          # @param [Boolean] fallback_to_long_code Whether to enable [Fallback to Long
+          #   Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for
+          #   messages sent through the Service instance.
+          # @param [Boolean] area_code_geomatch Whether to enable [Area Code
+          #   Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the
+          #   Service Instance.
+          # @param [String] validity_period How long, in seconds, messages sent from the
+          #   Service are valid. Can be an integer from `1` to `14,400`.
+          # @param [Boolean] synchronous_validation Reserved.
           # @return [ServiceInstance] Updated ServiceInstance
           def update(friendly_name: :unset, 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)
             context.update(
@@ -557,7 +623,7 @@ module Twilio
 
           ##
           # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,7 +19,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Messaging::V1::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Messaging::V1::ServiceList]
         def services(sid=:unset)

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,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Service
+      #   resource.
       # @return [Twilio::REST::Messaging::V1::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Messaging::V1::ServiceList]
       def services(sid=:unset)