twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/ip_messaging/v2.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -18,7 +20,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Credential resource to fetch.
         # @return [Twilio::REST::Chat::V2::CredentialContext] if sid was passed.
         # @return [Twilio::REST::Chat::V2::CredentialList]
         def credentials(sid=:unset)
@@ -32,7 +34,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Service resource to fetch.
         # @return [Twilio::REST::Chat::V2::ServiceContext] if sid was passed.
         # @return [Twilio::REST::Chat::V2::ServiceList]
         def services(sid=:unset)

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -12,8 +14,8 @@ module Twilio
       def initialize(twilio)
         super
 
-        @base_url = 'https://ip-messaging.twilio.com'
-        @host = 'ip-messaging.twilio.com'
+        @base_url = 'https://chat.twilio.com'
+        @host = 'chat.twilio.com'
         @port = 443
 
         # Versions
@@ -34,7 +36,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Credential
+      #   resource.
       # @return [Twilio::REST::Chat::V2::CredentialInstance] if sid was passed.
       # @return [Twilio::REST::Chat::V2::CredentialList]
       def credentials(sid=:unset)
@@ -42,7 +45,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::Chat::V2::ServiceInstance] if sid was passed.
       # @return [Twilio::REST::Chat::V2::ServiceList]
       def services(sid=:unset)

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -46,7 +48,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [PhoneNumberInstance] PhoneNumberInstance
           def get_instance(payload)
-            PhoneNumberInstance.new(@version, payload)
+            PhoneNumberInstance.new(@version, payload, )
           end
 
           ##
@@ -60,22 +62,37 @@ module Twilio
           ##
           # Initialize the PhoneNumberContext
           # @param [Version] version Version that contains the resource
-          # @param [String] phone_number The phone_number
+          # @param [String] phone_number The phone number to lookup in
+          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+          #   of a + followed by the country code and subscriber number.
           # @return [PhoneNumberContext] PhoneNumberContext
           def initialize(version, phone_number)
             super(version)
 
             # Path Solution
-            @solution = {phone_number: phone_number}
-            @uri = "/PhoneNumbers/#{@solution[:phone_number]}"
+            @solution = {phone_number: phone_number, }
+            @uri = "/PhoneNumbers/#{CGI.escape(@solution[:phone_number]).gsub("+", "%20")}"
           end
 
           ##
           # Fetch a PhoneNumberInstance
-          # @param [String] country_code The country_code
-          # @param [String] type The type
-          # @param [String] add_ons The add_ons
-          # @param [Hash] add_ons_data The add_ons_data
+          # @param [String] country_code The [ISO country
+          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to
+          #   fetch. This is used to specify the country when the phone number is provided in
+          #   a national format.
+          # @param [String] type The type of information to return. Can be: `carrier` or
+          #   `caller-name`. The default is null.  Carrier information costs $0.005 per phone
+          #   number looked up.  Caller Name information is currently available only in the US
+          #   and costs $0.01 per phone number looked up.  To retrieve both types on
+          #   information, specify this parameter twice; once with `carrier` and once with
+          #   `caller-name` as the value.
+          # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke.
+          #   Can be the `unique_name` of an Add-on that is installed on your account. You can
+          #   specify multiple instances of this parameter to invoke multiple Add-ons. For
+          #   more information about  Add-ons, see the [Add-ons
+          #   documentation](https://www.twilio.com/docs/add-ons).
+          # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke.
+          #   The content and format of this value depends on the add-on.
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
           def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
             params = Twilio::Values.of({
@@ -91,7 +108,7 @@ module Twilio
                 params,
             )
 
-            PhoneNumberInstance.new(@version, payload, phone_number: @solution[:phone_number])
+            PhoneNumberInstance.new(@version, payload, phone_number: @solution[:phone_number], )
           end
 
           ##
@@ -100,6 +117,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Lookups.V1.PhoneNumberContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Lookups.V1.PhoneNumberContext #{context}>"
+          end
         end
 
         class PhoneNumberInstance < InstanceResource
@@ -107,7 +131,9 @@ module Twilio
           # Initialize the PhoneNumberInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] phone_number The phone_number
+          # @param [String] phone_number The phone number to lookup in
+          #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+          #   of a + followed by the country code and subscriber number.
           # @return [PhoneNumberInstance] PhoneNumberInstance
           def initialize(version, payload, phone_number: nil)
             super(version)
@@ -125,7 +151,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'phone_number' => phone_number || @properties['phone_number']}
+            @params = {'phone_number' => phone_number || @properties['phone_number'], }
           end
 
           ##
@@ -134,62 +160,75 @@ module Twilio
           # @return [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
           def context
             unless @instance_context
-              @instance_context = PhoneNumberContext.new(@version, @params['phone_number'])
+              @instance_context = PhoneNumberContext.new(@version, @params['phone_number'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The caller_name
+          # @return [Hash] The name of the phone number's owner
           def caller_name
             @properties['caller_name']
           end
 
           ##
-          # @return [String] The country_code
+          # @return [String] The ISO country code for the phone number
           def country_code
             @properties['country_code']
           end
 
           ##
-          # @return [String] The phone_number
+          # @return [String] The phone number in E.164 format
           def phone_number
             @properties['phone_number']
           end
 
           ##
-          # @return [String] The national_format
+          # @return [String] The phone number, in national format
           def national_format
             @properties['national_format']
           end
 
           ##
-          # @return [String] The carrier
+          # @return [Hash] The telecom company that provides the phone number
           def carrier
             @properties['carrier']
           end
 
           ##
-          # @return [Hash] The add_ons
+          # @return [Hash] A JSON string with the results of the Add-ons you specified
           def add_ons
             @properties['add_ons']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
           # Fetch a PhoneNumberInstance
-          # @param [String] country_code The country_code
-          # @param [String] type The type
-          # @param [String] add_ons The add_ons
-          # @param [Hash] add_ons_data The add_ons_data
+          # @param [String] country_code The [ISO country
+          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to
+          #   fetch. This is used to specify the country when the phone number is provided in
+          #   a national format.
+          # @param [String] type The type of information to return. Can be: `carrier` or
+          #   `caller-name`. The default is null.  Carrier information costs $0.005 per phone
+          #   number looked up.  Caller Name information is currently available only in the US
+          #   and costs $0.01 per phone number looked up.  To retrieve both types on
+          #   information, specify this parameter twice; once with `carrier` and once with
+          #   `caller-name` as the value.
+          # @param [String] add_ons The `unique_name` of an Add-on you would like to invoke.
+          #   Can be the `unique_name` of an Add-on that is installed on your account. You can
+          #   specify multiple instances of this parameter to invoke multiple Add-ons. For
+          #   more information about  Add-ons, see the [Add-ons
+          #   documentation](https://www.twilio.com/docs/add-ons).
+          # @param [Hash] add_ons_data Data specific to the add-on you would like to invoke.
+          #   The content and format of this value depends on the add-on.
           # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
           def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
-            context.fetch(country_code: country_code, type: type, add_ons: add_ons, add_ons_data: add_ons_data)
+            context.fetch(country_code: country_code, type: type, add_ons: add_ons, add_ons_data: add_ons_data, )
           end
 
           ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,7 +19,9 @@ module Twilio
         end
 
         ##
-        # @param [String] phone_number The phone_number
+        # @param [String] phone_number The phone number to lookup in
+        #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+        #   of a + followed by the country code and subscriber number.
         # @return [Twilio::REST::Lookups::V1::PhoneNumberContext] if phone_number was passed.
         # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
         def phone_numbers(phone_number=:unset)

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,9 @@ module Twilio
       end
 
       ##
-      # @param [String] phone_number The phone_number
+      # @param [String] phone_number The phone number in
+      #   [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists
+      #   of a + followed by the country code and subscriber number.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberInstance] if phone_number was passed.
       # @return [Twilio::REST::Lookups::V1::PhoneNumberList]
       def phone_numbers(phone_number=:unset)

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,9 @@ 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 SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   is associated with.
             # @return [AlphaSenderList] AlphaSenderList
             def initialize(version, service_sid: nil)
               super(version)
@@ -28,10 +32,12 @@ 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 The Alphanumeric Sender ID string. Can be up to 11
+            #   characters long. Valid characters are A-Z, a-z, 0-9, space, and hyphen `-`. This
+            #   value cannot contain only numbers.
             # @return [AlphaSenderInstance] Newly created AlphaSenderInstance
             def create(alpha_sender: nil)
-              data = Twilio::Values.of({'AlphaSender' => alpha_sender})
+              data = Twilio::Values.of({'AlphaSender' => alpha_sender, })
 
               payload = @version.create(
                   'POST',
@@ -39,7 +45,7 @@ module Twilio
                   data: data
               )
 
-              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -71,7 +77,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
@@ -83,7 +89,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],
@@ -152,7 +158,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [AlphaSenderInstance] AlphaSenderInstance
             def get_instance(payload)
-              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -168,14 +174,16 @@ module Twilio
             ##
             # Initialize the AlphaSenderContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the
+            #   resource from.
+            # @param [String] sid The SID of the AlphaSender resource to fetch.
             # @return [AlphaSenderContext] AlphaSenderContext
             def initialize(version, service_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
+              @solution = {service_sid: service_sid, sid: sid, }
               @uri = "/Services/#{@solution[:service_sid]}/AlphaSenders/#{@solution[:sid]}"
             end
 
@@ -191,12 +199,17 @@ module Twilio
                   params,
               )
 
-              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              AlphaSenderInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Deletes the AlphaSenderInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -207,6 +220,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Messaging.V1.AlphaSenderContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.AlphaSenderContext #{context}>"
+            end
           end
 
           ##
@@ -216,8 +236,10 @@ 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] sid The sid
+            # @param [String] service_sid The SID of the
+            #   [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource
+            #   is associated with.
+            # @param [String] sid The SID of the AlphaSender resource to fetch.
             # @return [AlphaSenderInstance] AlphaSenderInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -236,7 +258,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -245,55 +267,55 @@ module Twilio
             # @return [AlphaSenderContext] AlphaSenderContext for this AlphaSenderInstance
             def context
               unless @instance_context
-                @instance_context = AlphaSenderContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = AlphaSenderContext.new(@version, @params['service_sid'], @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 service_sid
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             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 alpha_sender
+            # @return [String] The Alphanumeric Sender ID string
             def alpha_sender
               @properties['alpha_sender']
             end
 
             ##
-            # @return [Hash] The capabilities
+            # @return [String] An array of values that describe whether the number can receive calls or messages
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the AlphaSender resource
             def url
               @properties['url']
             end
@@ -307,7 +329,7 @@ module Twilio
 
             ##
             # Deletes the AlphaSenderInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end