twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,8 +17,9 @@ module Twilio
             ##
             # Initialize the AlphaSenderList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The 34 character unique sid of the Messaging
-            #   Service.
+            # @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)
@@ -29,20 +30,15 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of AlphaSenderInstance records from the API.
-            # Request is executed immediately.
-            # @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
+            # 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, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               AlphaSenderInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -108,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
 
@@ -173,8 +167,10 @@ 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)
@@ -185,16 +181,10 @@ module Twilio
             end
 
             ##
-            # Fetch a AlphaSenderInstance
+            # Fetch the AlphaSenderInstance
             # @return [AlphaSenderInstance] Fetched AlphaSenderInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               AlphaSenderInstance.new(
                   @version,
@@ -205,10 +195,10 @@ module Twilio
             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
 
             ##
@@ -217,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
 
           ##
@@ -226,9 +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 34 character unique sid of the Messaging
-            #   Service.
-            # @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)
@@ -262,63 +260,63 @@ module Twilio
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Alpha Sender ID.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Account.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Messaging Service.
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date that this resource was 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 that this resource was last 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] An Alphanumeric Sender ID string, up to 11 characters.
+            # @return [String] The Alphanumeric Sender ID string
             def alpha_sender
               @properties['alpha_sender']
             end
 
             ##
-            # @return [Hash] An array of values that indicate whether the number can receive calls or messages.
+            # @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 absolute URL for this resource.
+            # @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,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,7 +17,9 @@ module Twilio
             ##
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The 34 character unique sid of the Service.
+            # @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)
@@ -28,19 +30,14 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] phone_number_sid Phone Number SID for the Phone Number being
-            #   added to the Service.
-            # @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, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -106,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
 
@@ -171,8 +166,10 @@ 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)
@@ -183,23 +180,17 @@ module Twilio
             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,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               PhoneNumberInstance.new(
                   @version,
@@ -215,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
 
           ##
@@ -224,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 34 character unique sid of the Service.
-            # @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)
@@ -260,68 +260,68 @@ module Twilio
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Phone Number.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Account.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The 34 character unique sid of the Service.
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The date that this resource was 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 that this resource was last 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 E.
+            # @return [String] The phone number in E.164 format
             def phone_number
               @properties['phone_number']
             end
 
             ##
-            # @return [String] The 2 character ISO Country Code of the number.
+            # @return [String] The 2-character ISO Country Code of the number
             def country_code
               @properties['country_code']
             end
 
             ##
-            # @return [String] Any array of values that indicate whether the number can receive calls or messages.
+            # @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 absolute URL for this resource.
+            # @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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,8 +18,8 @@ module Twilio
             # Initialize the ShortCodeList
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this resource is
-            #   associated with.
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
+            #   is associated with.
             # @return [ShortCodeList] ShortCodeList
             def initialize(version, service_sid: nil)
               super(version)
@@ -30,19 +30,14 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] short_code_sid SID of the ShortCode resource being added to the
-            #   Service.
-            # @return [ShortCodeInstance] Newly created ShortCodeInstance
+            # Create the ShortCodeInstance
+            # @param [String] short_code_sid The SID of the ShortCode resource being added to
+            #   the Service.
+            # @return [ShortCodeInstance] Created ShortCodeInstance
             def create(short_code_sid: nil)
               data = Twilio::Values.of({'ShortCodeSid' => short_code_sid, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], )
             end
@@ -108,11 +103,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ShortCodePage.new(@version, response, @solution)
             end
 
@@ -174,10 +167,9 @@ module Twilio
             # Initialize the ShortCodeContext
             # @param [Version] version Version that contains the resource
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) to fetch the
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
             #   resource from.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the
-            #   ShortCode resource to fetch
+            # @param [String] sid The SID of the ShortCode resource to fetch.
             # @return [ShortCodeContext] ShortCodeContext
             def initialize(version, service_sid, sid)
               super(version)
@@ -188,23 +180,17 @@ module Twilio
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ShortCodeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid], )
             end
@@ -215,6 +201,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Messaging.V1.ShortCodeContext #{context}>"
+            end
           end
 
           ##
@@ -225,10 +218,9 @@ module Twilio
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
             # @param [String] service_sid The SID of the
-            #   [Service](https://www.twilio.com/docs/api/chat/rest/services) this resource is
-            #   associated with.
-            # @param [String] sid The Twilio-provided string that uniquely identifies the
-            #   ShortCode resource to fetch
+            #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the resource
+            #   is associated with.
+            # @param [String] sid The SID of the ShortCode resource to fetch.
             # @return [ShortCodeInstance] ShortCodeInstance
             def initialize(version, payload, service_sid: nil, sid: nil)
               super(version)
@@ -263,68 +255,68 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique string that identifies this resource
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The SID of the Account that created this resource
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The SID of the Service that this resource is associated with
+            # @return [String] The SID of the Service that the resource is associated with
             def service_sid
               @properties['service_sid']
             end
 
             ##
-            # @return [Time] The RFC 2822 date and time in GMT that this resource was 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 RFC 2822 date and time in GMT that this resource was last 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 E.164 format of the short code.
+            # @return [String] The E.164 format of the short code
             def short_code
               @properties['short_code']
             end
 
             ##
-            # @return [String] The 2-character ISO Country Code of the number.
+            # @return [String] The 2-character ISO Country Code of the number
             def country_code
               @properties['country_code']
             end
 
             ##
-            # @return [Hash] Any array of values that indicate whether the number can receive calls or messages.
+            # @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 absolute URL of this ShortCode resource
+            # @return [String] The absolute URL of the ShortCode resource
             def url
               @properties['url']
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ShortCodeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
-            # Fetch a ShortCodeInstance
+            # Fetch the ShortCodeInstance
             # @return [ShortCodeInstance] Fetched ShortCodeInstance
             def fetch
               context.fetch