twilio-ruby 5.5.1 → 5.58.3

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)
@@ -26,20 +30,17 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of AlphaSenderInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] alpha_sender The alpha_sender
-            # @return [AlphaSenderInstance] Newly created AlphaSenderInstance
+            # Create the AlphaSenderInstance
+            # @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] 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',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -71,7 +72,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 +84,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],
@@ -103,11 +104,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               AlphaSenderPage.new(@version, response, @solution)
             end
 
@@ -152,7 +151,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,37 +167,38 @@ 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
 
             ##
-            # Fetch a AlphaSenderInstance
+            # Fetch the AlphaSenderInstance
             # @return [AlphaSenderInstance] Fetched AlphaSenderInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  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
+            # Delete the AlphaSenderInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -207,6 +207,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 +223,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 +245,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,69 +254,69 @@ 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 [Array[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
 
             ##
-            # Fetch a AlphaSenderInstance
+            # Fetch the AlphaSenderInstance
             # @return [AlphaSenderInstance] Fetched AlphaSenderInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the AlphaSenderInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the AlphaSenderInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             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,9 @@ 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 SID of the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
+            #   is associated with.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, service_sid: nil)
               super(version)
@@ -26,20 +30,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] phone_number_sid The phone_number_sid
-            # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
+            # Create the PhoneNumberInstance
+            # @param [String] phone_number_sid The SID of the Phone Number being added to the
+            #   Service.
+            # @return [PhoneNumberInstance] Created PhoneNumberInstance
             def create(phone_number_sid: nil)
-              data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid})
+              data = Twilio::Values.of({'PhoneNumberSid' => phone_number_sid, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -71,7 +71,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 +83,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],
@@ -103,11 +103,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               PhoneNumberPage.new(@version, response, @solution)
             end
 
@@ -152,7 +150,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def get_instance(payload)
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
 
             ##
@@ -168,37 +166,38 @@ module Twilio
             ##
             # Initialize the PhoneNumberContext
             # @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 PhoneNumber resource to fetch.
             # @return [PhoneNumberContext] PhoneNumberContext
             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]}/PhoneNumbers/#{@solution[:sid]}"
             end
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              PhoneNumberInstance.new(
+                  @version,
+                  payload,
+                  service_sid: @solution[:service_sid],
+                  sid: @solution[:sid],
               )
-
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
             end
 
             ##
@@ -207,6 +206,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Messaging.V1.PhoneNumberContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.PhoneNumberContext #{context}>"
+            end
           end
 
           ##
@@ -216,8 +222,10 @@ 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] 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 PhoneNumber resource to fetch.
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -237,7 +245,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
 
             ##
@@ -246,74 +254,74 @@ module Twilio
             # @return [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
             def context
               unless @instance_context
-                @instance_context = PhoneNumberContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = PhoneNumberContext.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 phone_number
+            # @return [String] The phone number in E.164 format
             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 [Array[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 PhoneNumber resource
             def url
               @properties['url']
             end
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
               context.fetch