twilio-ruby 5.5.1 → 5.58.3

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)
@@ -24,14 +26,20 @@ module Twilio
             end
 
             ##
-            # 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
-            # @return [OriginationUrlInstance] Newly created OriginationUrlInstance
+            # Create the OriginationUrlInstance
+            # @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] Created OriginationUrlInstance
             def create(weight: nil, priority: nil, enabled: nil, friendly_name: nil, sip_url: nil)
               data = Twilio::Values.of({
                   'Weight' => weight,
@@ -41,13 +49,9 @@ module Twilio
                   'SipUrl' => sip_url,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid])
+              OriginationUrlInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -79,7 +83,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 +95,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],
@@ -111,11 +115,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               OriginationUrlPage.new(@version, response, @solution)
             end
 
@@ -158,7 +160,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,46 +174,54 @@ 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
 
             ##
-            # Fetch a OriginationUrlInstance
+            # Fetch the OriginationUrlInstance
             # @return [OriginationUrlInstance] Fetched OriginationUrlInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  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
+            # Delete the OriginationUrlInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @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({
@@ -222,13 +232,14 @@ module Twilio
                   'SipUrl' => sip_url,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, 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 +248,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 +262,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 +286,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,98 +295,105 @@ 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
 
             ##
-            # Fetch a OriginationUrlInstance
+            # Fetch the OriginationUrlInstance
             # @return [OriginationUrlInstance] Fetched OriginationUrlInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the OriginationUrlInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the OriginationUrlInstance
+            # @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(