twilio-ruby 5.5.1 → 5.58.3

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)
@@ -24,20 +29,17 @@ 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 {Incoming Phone
+            #   Number}[https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource]
+            #   that you want to associate with the trunk.
+            # @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, trunk_sid: @solution[:trunk_sid])
+              PhoneNumberInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
             end
 
             ##
@@ -69,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
@@ -81,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],
@@ -101,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
 
@@ -148,7 +148,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,37 +162,33 @@ 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
 
             ##
-            # 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, 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
+            # Delete the PhoneNumberInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -201,6 +197,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 +211,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 +253,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,177 +262,177 @@ 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
 
             ##
-            # Fetch a PhoneNumberInstance
+            # Fetch the PhoneNumberInstance
             # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
             def fetch
               context.fetch
             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

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

@@ -0,0 +1,198 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Trunking < Domain
+      class V1 < Version
+        class TrunkContext < InstanceContext
+          class RecordingList < ListResource
+            ##
+            # Initialize the RecordingList
+            # @param [Version] version Version that contains the resource
+            # @param [String] trunk_sid The unique string that we created to identify the
+            #   Trunk resource.
+            # @return [RecordingList] RecordingList
+            def initialize(version, trunk_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {trunk_sid: trunk_sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Trunking.V1.RecordingList>'
+            end
+          end
+
+          class RecordingPage < Page
+            ##
+            # Initialize the RecordingPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [RecordingPage] RecordingPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of RecordingInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [RecordingInstance] RecordingInstance
+            def get_instance(payload)
+              RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Trunking.V1.RecordingPage>'
+            end
+          end
+
+          class RecordingContext < InstanceContext
+            ##
+            # Initialize the RecordingContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] trunk_sid The SID of the Trunk from which to fetch the recording
+            #   settings.
+            # @return [RecordingContext] RecordingContext
+            def initialize(version, trunk_sid)
+              super(version)
+
+              # Path Solution
+              @solution = {trunk_sid: trunk_sid, }
+              @uri = "/Trunks/#{@solution[:trunk_sid]}/Recording"
+            end
+
+            ##
+            # Fetch the RecordingInstance
+            # @return [RecordingInstance] Fetched RecordingInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
+            end
+
+            ##
+            # Update the RecordingInstance
+            # @param [recording.RecordingMode] mode The recording mode for the trunk. Can be
+            #   do-not-record (default), record-from-ringing, record-from-answer,
+            #   record-from-ringing-dual, or record-from-answer-dual.
+            # @param [recording.RecordingTrim] trim The recording trim setting for the trunk.
+            #   Can be do-not-trim (default) or trim-silence.
+            # @return [RecordingInstance] Updated RecordingInstance
+            def update(mode: :unset, trim: :unset)
+              data = Twilio::Values.of({'Mode' => mode, 'Trim' => trim, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              RecordingInstance.new(@version, payload, trunk_sid: @solution[:trunk_sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.RecordingContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Trunking.V1.RecordingContext #{context}>"
+            end
+          end
+
+          class RecordingInstance < InstanceResource
+            ##
+            # Initialize the RecordingInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] trunk_sid The unique string that we created to identify the
+            #   Trunk resource.
+            # @return [RecordingInstance] RecordingInstance
+            def initialize(version, payload, trunk_sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {'mode' => payload['mode'], 'trim' => payload['trim'], }
+
+              # Context
+              @instance_context = nil
+              @params = {'trunk_sid' => trunk_sid, }
+            end
+
+            ##
+            # Generate an instance context for the instance, the context is capable of
+            # performing various actions.  All instance actions are proxied to the context
+            # @return [RecordingContext] RecordingContext for this RecordingInstance
+            def context
+              unless @instance_context
+                @instance_context = RecordingContext.new(@version, @params['trunk_sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [recording.RecordingMode] The recording mode for the trunk.
+            def mode
+              @properties['mode']
+            end
+
+            ##
+            # @return [recording.RecordingTrim] The recording trim setting for the trunk.
+            def trim
+              @properties['trim']
+            end
+
+            ##
+            # Fetch the RecordingInstance
+            # @return [RecordingInstance] Fetched RecordingInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the RecordingInstance
+            # @param [recording.RecordingMode] mode The recording mode for the trunk. Can be
+            #   do-not-record (default), record-from-ringing, record-from-answer,
+            #   record-from-ringing-dual, or record-from-answer-dual.
+            # @param [recording.RecordingTrim] trim The recording trim setting for the trunk.
+            #   Can be do-not-trim (default) or trim-silence.
+            # @return [RecordingInstance] Updated RecordingInstance
+            def update(mode: :unset, trim: :unset)
+              context.update(mode: mode, trim: trim, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Trunking.V1.RecordingInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Trunking.V1.RecordingInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end