twilio-ruby 5.6.0 → 5.33.1

data/lib/twilio-ruby/rest/trunking/v1/trunk/origination_url.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the OriginationUrlList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The SID of the Trunk that owns the Origination URL.
             # @return [OriginationUrlList] OriginationUrlList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -26,11 +28,18 @@ module Twilio
             ##
             # Retrieve a single page of OriginationUrlInstance records from the API.
             # Request is executed immediately.
-            # @param [String] weight The weight
-            # @param [String] priority The priority
-            # @param [Boolean] enabled The enabled
-            # @param [String] friendly_name The friendly_name
-            # @param [String] sip_url The sip_url
+            # @param [String] weight The value that determines the relative share of the load
+            #   the URI should receive compared to other URIs with the same priority. Can be an
+            #   integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
+            #   values receive more load than those with lower ones with the same priority.
+            # @param [String] priority The relative importance of the URI. Can be an integer
+            #   from 0 to 65535, inclusive, and the default is 10. The lowest number represents
+            #   the most important URI.
+            # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] sip_url The SIP address you want Twilio to route your
+            #   Origination calls to. This must be a `sip:` schema.
             # @return [OriginationUrlInstance] Newly created OriginationUrlInstance
             def create(weight: nil, priority: nil, enabled: nil, friendly_name: nil, sip_url: nil)
               data = Twilio::Values.of({
@@ -47,7 +56,7 @@ module Twilio
                   data: data
               )
 
-              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -79,7 +88,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
@@ -91,7 +100,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],
@@ -158,7 +167,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [OriginationUrlInstance] OriginationUrlInstance
             def get_instance(payload)
-              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -172,14 +181,16 @@ module Twilio
             ##
             # Initialize the OriginationUrlContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the
+            #   OriginationUrl.
+            # @param [String] sid The unique string that we created to identify the
+            #   OriginationUrl resource to fetch.
             # @return [OriginationUrlContext] OriginationUrlContext
             def initialize(version, trunk_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {trunk_sid: trunk_sid, sid: sid}
+              @solution = {trunk_sid: trunk_sid, sid: sid, }
               @uri = "/Trunks/#{@solution[:trunk_sid]}/OriginationUrls/#{@solution[:sid]}"
             end
 
@@ -195,23 +206,35 @@ module Twilio
                   params,
               )
 
-              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid])
+              OriginationUrlInstance.new(
+                  @version,
+                  payload,
+                  trunk_sid: @solution[:trunk_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Deletes the OriginationUrlInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
 
             ##
             # Update the OriginationUrlInstance
-            # @param [String] weight The weight
-            # @param [String] priority The priority
-            # @param [Boolean] enabled The enabled
-            # @param [String] friendly_name The friendly_name
-            # @param [String] sip_url The sip_url
+            # @param [String] weight The value that determines the relative share of the load
+            #   the URI should receive compared to other URIs with the same priority. Can be an
+            #   integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
+            #   values receive more load than those with lower ones with the same priority.
+            # @param [String] priority The relative importance of the URI. Can be an integer
+            #   from 0 to 65535, inclusive, and the default is 10. The lowest number represents
+            #   the most important URI.
+            # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] sip_url The SIP address you want Twilio to route your
+            #   Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
             # @return [OriginationUrlInstance] Updated OriginationUrlInstance
             def update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset)
               data = Twilio::Values.of({
@@ -228,7 +251,12 @@ module Twilio
                   data: data,
               )
 
-              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid])
+              OriginationUrlInstance.new(
+                  @version,
+                  payload,
+                  trunk_sid: @solution[:trunk_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
@@ -237,6 +265,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Trunking.V1.OriginationUrlContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.OriginationUrlContext #{context}>"
+            end
           end
 
           class OriginationUrlInstance < InstanceResource
@@ -244,8 +279,9 @@ module Twilio
             # Initialize the OriginationUrlInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk that owns the Origination URL.
+            # @param [String] sid The unique string that we created to identify the
+            #   OriginationUrl resource to fetch.
             # @return [OriginationUrlInstance] OriginationUrlInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -267,7 +303,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid']}
+              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -276,73 +312,73 @@ module Twilio
             # @return [OriginationUrlContext] OriginationUrlContext for this OriginationUrlInstance
             def context
               unless @instance_context
-                @instance_context = OriginationUrlContext.new(@version, @params['trunk_sid'], @params['sid'])
+                @instance_context = OriginationUrlContext.new(@version, @params['trunk_sid'], @params['sid'], )
               end
               @instance_context
             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 sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The trunk_sid
+            # @return [String] The SID of the Trunk that owns the Origination URL
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] The weight
+            # @return [String] The value that determines the relative load the URI should receive compared to others with the same priority
             def weight
               @properties['weight']
             end
 
             ##
-            # @return [Boolean] The enabled
+            # @return [Boolean] Whether the URL is enabled
             def enabled
               @properties['enabled']
             end
 
             ##
-            # @return [String] The sip_url
+            # @return [String] The SIP address you want Twilio to route your Origination calls to
             def sip_url
               @properties['sip_url']
             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 [String] The priority
+            # @return [String] The relative importance of the URI
             def priority
               @properties['priority']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 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 RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
@@ -356,18 +392,25 @@ module Twilio
 
             ##
             # Deletes the OriginationUrlInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
             # Update the OriginationUrlInstance
-            # @param [String] weight The weight
-            # @param [String] priority The priority
-            # @param [Boolean] enabled The enabled
-            # @param [String] friendly_name The friendly_name
-            # @param [String] sip_url The sip_url
+            # @param [String] weight The value that determines the relative share of the load
+            #   the URI should receive compared to other URIs with the same priority. Can be an
+            #   integer from 1 to 65535, inclusive, and the default is 10. URLs with higher
+            #   values receive more load than those with lower ones with the same priority.
+            # @param [String] priority The relative importance of the URI. Can be an integer
+            #   from 0 to 65535, inclusive, and the default is 10. The lowest number represents
+            #   the most important URI.
+            # @param [Boolean] enabled Whether the URL is enabled. The default is `true`.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It can be up to 64 characters long.
+            # @param [String] sip_url The SIP address you want Twilio to route your
+            #   Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.
             # @return [OriginationUrlInstance] Updated OriginationUrlInstance
             def update(weight: :unset, priority: :unset, enabled: :unset, friendly_name: :unset, sip_url: :unset)
               context.update(

data/lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,10 @@ module Twilio
             ##
             # Initialize the PhoneNumberList
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
+            # @param [String] trunk_sid The SID of the Trunk that handles calls to the phone
+            #   number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice
+            #   applications and use those set on the Trunk. Setting a `trunk_sid` will
+            #   automatically delete your `voice_application_sid` and vice versa.
             # @return [PhoneNumberList] PhoneNumberList
             def initialize(version, trunk_sid: nil)
               super(version)
@@ -26,10 +31,11 @@ module Twilio
             ##
             # Retrieve a single page of PhoneNumberInstance records from the API.
             # Request is executed immediately.
-            # @param [String] phone_number_sid The phone_number_sid
+            # @param [String] phone_number_sid The SID of the [Incoming Phone
+            #   Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) that you want to associate with the trunk.
             # @return [PhoneNumberInstance] Newly 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',
@@ -37,7 +43,7 @@ module Twilio
                   data: data
               )
 
-              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -69,7 +75,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
@@ -81,7 +87,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],
@@ -148,7 +154,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def get_instance(payload)
-              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -162,14 +168,16 @@ module Twilio
             ##
             # Initialize the PhoneNumberContext
             # @param [Version] version Version that contains the resource
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the
+            #   PhoneNumber resource.
+            # @param [String] sid The unique string that we created to identify the
+            #   PhoneNumber resource to fetch.
             # @return [PhoneNumberContext] PhoneNumberContext
             def initialize(version, trunk_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {trunk_sid: trunk_sid, sid: sid}
+              @solution = {trunk_sid: trunk_sid, sid: sid, }
               @uri = "/Trunks/#{@solution[:trunk_sid]}/PhoneNumbers/#{@solution[:sid]}"
             end
 
@@ -185,12 +193,12 @@ module Twilio
                   params,
               )
 
-              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid])
+              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -201,6 +209,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Trunking.V1.PhoneNumberContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.PhoneNumberContext #{context}>"
+            end
           end
 
           class PhoneNumberInstance < InstanceResource
@@ -208,8 +223,12 @@ module Twilio
             # Initialize the PhoneNumberInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] trunk_sid The trunk_sid
-            # @param [String] sid The sid
+            # @param [String] trunk_sid The SID of the Trunk that handles calls to the phone
+            #   number. If a `trunk_sid` is present, we ignore all of the voice URLs and voice
+            #   applications and use those set on the Trunk. Setting a `trunk_sid` will
+            #   automatically delete your `voice_application_sid` and vice versa.
+            # @param [String] sid The unique string that we created to identify the
+            #   PhoneNumber resource to fetch.
             # @return [PhoneNumberInstance] PhoneNumberInstance
             def initialize(version, payload, trunk_sid: nil, sid: nil)
               super(version)
@@ -246,7 +265,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid']}
+              @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -255,163 +274,163 @@ module Twilio
             # @return [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
             def context
               unless @instance_context
-                @instance_context = PhoneNumberContext.new(@version, @params['trunk_sid'], @params['sid'])
+                @instance_context = PhoneNumberContext.new(@version, @params['trunk_sid'], @params['sid'], )
               end
               @instance_context
             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 [phone_number.AddressRequirement] The address_requirements
+            # @return [phone_number.AddressRequirement] Whether the phone number requires an Address registered with Twilio
             def address_requirements
               @properties['address_requirements']
             end
 
             ##
-            # @return [String] The api_version
+            # @return [String] The API version used to start a new TwiML session
             def api_version
               @properties['api_version']
             end
 
             ##
-            # @return [Boolean] The beta
+            # @return [Boolean] Whether the phone number is new to the Twilio platform
             def beta
               @properties['beta']
             end
 
             ##
-            # @return [String] The capabilities
+            # @return [Hash] Indicate if a phone can receive calls or messages
             def capabilities
               @properties['capabilities']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 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 RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             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 [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             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 sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The sms_application_sid
+            # @return [String] The SID of the application that handles SMS messages sent to the phone number
             def sms_application_sid
               @properties['sms_application_sid']
             end
 
             ##
-            # @return [String] The sms_fallback_method
+            # @return [String] The HTTP method used with sms_fallback_url
             def sms_fallback_method
               @properties['sms_fallback_method']
             end
 
             ##
-            # @return [String] The sms_fallback_url
+            # @return [String] The URL that we call when an error occurs while retrieving or executing the TwiML
             def sms_fallback_url
               @properties['sms_fallback_url']
             end
 
             ##
-            # @return [String] The sms_method
+            # @return [String] The HTTP method to use with sms_url
             def sms_method
               @properties['sms_method']
             end
 
             ##
-            # @return [String] The sms_url
+            # @return [String] The URL we call when the phone number receives an incoming SMS message
             def sms_url
               @properties['sms_url']
             end
 
             ##
-            # @return [String] The status_callback
+            # @return [String] The URL to send status information to your application
             def status_callback
               @properties['status_callback']
             end
 
             ##
-            # @return [String] The status_callback_method
+            # @return [String] The HTTP method we use to call status_callback
             def status_callback_method
               @properties['status_callback_method']
             end
 
             ##
-            # @return [String] The trunk_sid
+            # @return [String] The SID of the Trunk that handles calls to the phone number
             def trunk_sid
               @properties['trunk_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The voice_application_sid
+            # @return [String] The SID of the application that handles calls to the phone number
             def voice_application_sid
               @properties['voice_application_sid']
             end
 
             ##
-            # @return [Boolean] The voice_caller_id_lookup
+            # @return [Boolean] Whether to lookup the caller's name
             def voice_caller_id_lookup
               @properties['voice_caller_id_lookup']
             end
 
             ##
-            # @return [String] The voice_fallback_method
+            # @return [String] The HTTP method that we use to call voice_fallback_url
             def voice_fallback_method
               @properties['voice_fallback_method']
             end
 
             ##
-            # @return [String] The voice_fallback_url
+            # @return [String] The URL we call when an error occurs in TwiML
             def voice_fallback_url
               @properties['voice_fallback_url']
             end
 
             ##
-            # @return [String] The voice_method
+            # @return [String] The HTTP method used with the voice_url
             def voice_method
               @properties['voice_method']
             end
 
             ##
-            # @return [String] The voice_url
+            # @return [String] The URL we call when the phone number receives a call
             def voice_url
               @properties['voice_url']
             end
@@ -425,7 +444,7 @@ module Twilio
 
             ##
             # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end