twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -24,14 +26,41 @@ module Twilio
           ##
           # Retrieve a single page of TrunkInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
-          # @param [String] domain_name The domain_name
-          # @param [String] disaster_recovery_url The disaster_recovery_url
-          # @param [String] disaster_recovery_method The disaster_recovery_method
-          # @param [String] recording The recording
-          # @param [Boolean] secure The secure
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] domain_name The unique address you reserve on Twilio to which
+          #   you route your SIP traffic. Domain names can contain letters, digits, and `-`
+          #   and must end with `pstn.twilio.com`. See [Termination
+          #   Settings](https://www.twilio.com/docs/sip-trunking#termination) for more
+          #   information.
+          # @param [String] disaster_recovery_url The URL we should call using the
+          #   `disaster_recovery_method` if an error occurs while sending SIP traffic towards
+          #   the configured Origination URL. We retrieve TwiML from the URL and execute the
+          #   instructions like any other normal TwiML call. See [Disaster
+          #   Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more
+          #   information.
+          # @param [String] disaster_recovery_method The HTTP method we should use to call
+          #   the `disaster_recovery_url`. Can be: `GET` or `POST`.
+          # @param [trunk.RecordingSetting] recording The recording settings for the trunk.
+          #   Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to
+          #   `record-from-ringing` or `record-from-answer`, all calls going through the trunk
+          #   will be recorded. The only way to change recording parameters is on a
+          #   sub-resource of a Trunk after it has been created.
+          #   e.g.`/Trunks/[Trunk_SID]/Recording -XPOST -d'Mode=record-from-answer'`. See
+          #   [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more
+          #   information.
+          # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If
+          #   enabled, all calls going through the trunk will be secure using SRTP for media
+          #   and TLS for signaling. If disabled, then RTP will be used for media. See [Secure
+          #   Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more
+          #   information.
+          # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should
+          #   be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from
+          #   the United States and Canada automatically perform a CNAM Lookup and display
+          #   Caller ID data on your phone. See [CNAM
+          #   Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
           # @return [TrunkInstance] Newly created TrunkInstance
-          def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
+          def create(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DomainName' => domain_name,
@@ -39,6 +68,7 @@ module Twilio
                 'DisasterRecoveryMethod' => disaster_recovery_method,
                 'Recording' => recording,
                 'Secure' => secure,
+                'CnamLookupEnabled' => cnam_lookup_enabled,
             })
 
             payload = @version.create(
@@ -47,7 +77,7 @@ module Twilio
                 data: data
             )
 
-            TrunkInstance.new(@version, payload)
+            TrunkInstance.new(@version, payload, )
           end
 
           ##
@@ -79,7 +109,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 +121,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 +188,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [TrunkInstance] TrunkInstance
           def get_instance(payload)
-            TrunkInstance.new(@version, payload)
+            TrunkInstance.new(@version, payload, )
           end
 
           ##
@@ -172,13 +202,14 @@ module Twilio
           ##
           # Initialize the TrunkContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The unique string that we created to identify the Trunk
+          #   resource to fetch.
           # @return [TrunkContext] TrunkContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Trunks/#{@solution[:sid]}"
 
             # Dependents
@@ -200,26 +231,51 @@ module Twilio
                 params,
             )
 
-            TrunkInstance.new(@version, payload, sid: @solution[:sid])
+            TrunkInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the TrunkInstance
-          # @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 TrunkInstance
-          # @param [String] friendly_name The friendly_name
-          # @param [String] domain_name The domain_name
-          # @param [String] disaster_recovery_url The disaster_recovery_url
-          # @param [String] disaster_recovery_method The disaster_recovery_method
-          # @param [String] recording The recording
-          # @param [Boolean] secure The secure
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] domain_name The unique address you reserve on Twilio to which
+          #   you route your SIP traffic. Domain names can contain letters, digits, and `-`
+          #   and must end with `pstn.twilio.com`. See [Termination
+          #   Settings](https://www.twilio.com/docs/sip-trunking#termination) for more
+          #   information.
+          # @param [String] disaster_recovery_url The URL we should call using the
+          #   `disaster_recovery_method` if an error occurs while sending SIP traffic towards
+          #   the configured Origination URL. We retrieve TwiML from the URL and execute the
+          #   instructions like any other normal TwiML call. See [Disaster
+          #   Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more
+          #   information.
+          # @param [String] disaster_recovery_method The HTTP method we should use to call
+          #   the `disaster_recovery_url`. Can be: `GET` or `POST`.
+          # @param [trunk.RecordingSetting] recording The recording settings for the trunk.
+          #   Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to
+          #   `record-from-ringing` or `record-from-answer`, all calls going through the trunk
+          #   will be recorded. See
+          #   [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more
+          #   information.
+          # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If
+          #   enabled, all calls going through the trunk will be secure using SRTP for media
+          #   and TLS for signaling. If disabled, then RTP will be used for media. See [Secure
+          #   Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more
+          #   information.
+          # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should
+          #   be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from
+          #   the United States and Canada automatically perform a CNAM Lookup and display
+          #   Caller ID data on your phone. See [CNAM
+          #   Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
           # @return [TrunkInstance] Updated TrunkInstance
-          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
+          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
             data = Twilio::Values.of({
                 'FriendlyName' => friendly_name,
                 'DomainName' => domain_name,
@@ -227,6 +283,7 @@ module Twilio
                 'DisasterRecoveryMethod' => disaster_recovery_method,
                 'Recording' => recording,
                 'Secure' => secure,
+                'CnamLookupEnabled' => cnam_lookup_enabled,
             })
 
             payload = @version.update(
@@ -235,7 +292,7 @@ module Twilio
                 data: data,
             )
 
-            TrunkInstance.new(@version, payload, sid: @solution[:sid])
+            TrunkInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -246,11 +303,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return OriginationUrlContext.new(@version, @solution[:sid], sid)
+              return OriginationUrlContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @origination_urls
-              @origination_urls = OriginationUrlList.new(@version, trunk_sid: @solution[:sid])
+              @origination_urls = OriginationUrlList.new(@version, trunk_sid: @solution[:sid], )
             end
 
             @origination_urls
@@ -264,11 +321,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return CredentialListContext.new(@version, @solution[:sid], sid)
+              return CredentialListContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @credentials_lists
-              @credentials_lists = CredentialListList.new(@version, trunk_sid: @solution[:sid])
+              @credentials_lists = CredentialListList.new(@version, trunk_sid: @solution[:sid], )
             end
 
             @credentials_lists
@@ -282,11 +339,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return IpAccessControlListContext.new(@version, @solution[:sid], sid)
+              return IpAccessControlListContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @ip_access_control_lists
-              @ip_access_control_lists = IpAccessControlListList.new(@version, trunk_sid: @solution[:sid])
+              @ip_access_control_lists = IpAccessControlListList.new(@version, trunk_sid: @solution[:sid], )
             end
 
             @ip_access_control_lists
@@ -300,11 +357,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return PhoneNumberContext.new(@version, @solution[:sid], sid)
+              return PhoneNumberContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @phone_numbers
-              @phone_numbers = PhoneNumberList.new(@version, trunk_sid: @solution[:sid])
+              @phone_numbers = PhoneNumberList.new(@version, trunk_sid: @solution[:sid], )
             end
 
             @phone_numbers
@@ -316,6 +373,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Trunking.V1.TrunkContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Trunking.V1.TrunkContext #{context}>"
+          end
         end
 
         class TrunkInstance < InstanceResource
@@ -323,7 +387,8 @@ module Twilio
           # Initialize the TrunkInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The unique string that we created to identify the Trunk
+          #   resource to fetch.
           # @return [TrunkInstance] TrunkInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -337,6 +402,7 @@ module Twilio
                 'friendly_name' => payload['friendly_name'],
                 'secure' => payload['secure'],
                 'recording' => payload['recording'],
+                'cnam_lookup_enabled' => payload['cnam_lookup_enabled'],
                 'auth_type' => payload['auth_type'],
                 'auth_type_set' => payload['auth_type_set'],
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -348,7 +414,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -357,91 +423,97 @@ module Twilio
           # @return [TrunkContext] TrunkContext for this TrunkInstance
           def context
             unless @instance_context
-              @instance_context = TrunkContext.new(@version, @params['sid'])
+              @instance_context = TrunkContext.new(@version, @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 domain_name
+          # @return [String] The unique address you reserve on Twilio to which you route your SIP traffic
           def domain_name
             @properties['domain_name']
           end
 
           ##
-          # @return [String] The disaster_recovery_method
+          # @return [String] The HTTP method we use to call the disaster_recovery_url
           def disaster_recovery_method
             @properties['disaster_recovery_method']
           end
 
           ##
-          # @return [String] The disaster_recovery_url
+          # @return [String] The HTTP URL that we call if an error occurs while sending SIP traffic towards your configured Origination URL
           def disaster_recovery_url
             @properties['disaster_recovery_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 [Boolean] The secure
+          # @return [Boolean] Whether Secure Trunking is enabled for the trunk
           def secure
             @properties['secure']
           end
 
           ##
-          # @return [Hash] The recording
+          # @return [Hash] The recording settings for the trunk
           def recording
             @properties['recording']
           end
 
           ##
-          # @return [String] The auth_type
+          # @return [Boolean] Whether Caller ID Name (CNAM) lookup is enabled for the trunk
+          def cnam_lookup_enabled
+            @properties['cnam_lookup_enabled']
+          end
+
+          ##
+          # @return [String] The types of authentication mapped to the domain
           def auth_type
             @properties['auth_type']
           end
 
           ##
-          # @return [String] The auth_type_set
+          # @return [String] Reserved
           def auth_type_set
             @properties['auth_type_set']
           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 sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           end
@@ -455,21 +527,46 @@ module Twilio
 
           ##
           # Deletes the TrunkInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
 
           ##
           # Update the TrunkInstance
-          # @param [String] friendly_name The friendly_name
-          # @param [String] domain_name The domain_name
-          # @param [String] disaster_recovery_url The disaster_recovery_url
-          # @param [String] disaster_recovery_method The disaster_recovery_method
-          # @param [String] recording The recording
-          # @param [Boolean] secure The secure
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It can be up to 64 characters long.
+          # @param [String] domain_name The unique address you reserve on Twilio to which
+          #   you route your SIP traffic. Domain names can contain letters, digits, and `-`
+          #   and must end with `pstn.twilio.com`. See [Termination
+          #   Settings](https://www.twilio.com/docs/sip-trunking#termination) for more
+          #   information.
+          # @param [String] disaster_recovery_url The URL we should call using the
+          #   `disaster_recovery_method` if an error occurs while sending SIP traffic towards
+          #   the configured Origination URL. We retrieve TwiML from the URL and execute the
+          #   instructions like any other normal TwiML call. See [Disaster
+          #   Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more
+          #   information.
+          # @param [String] disaster_recovery_method The HTTP method we should use to call
+          #   the `disaster_recovery_url`. Can be: `GET` or `POST`.
+          # @param [trunk.RecordingSetting] recording The recording settings for the trunk.
+          #   Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to
+          #   `record-from-ringing` or `record-from-answer`, all calls going through the trunk
+          #   will be recorded. See
+          #   [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more
+          #   information.
+          # @param [Boolean] secure Whether Secure Trunking is enabled for the trunk. If
+          #   enabled, all calls going through the trunk will be secure using SRTP for media
+          #   and TLS for signaling. If disabled, then RTP will be used for media. See [Secure
+          #   Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more
+          #   information.
+          # @param [Boolean] cnam_lookup_enabled Whether Caller ID Name (CNAM) lookup should
+          #   be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from
+          #   the United States and Canada automatically perform a CNAM Lookup and display
+          #   Caller ID data on your phone. See [CNAM
+          #   Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
           # @return [TrunkInstance] Updated TrunkInstance
-          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset)
+          def update(friendly_name: :unset, domain_name: :unset, disaster_recovery_url: :unset, disaster_recovery_method: :unset, recording: :unset, secure: :unset, cnam_lookup_enabled: :unset)
             context.update(
                 friendly_name: friendly_name,
                 domain_name: domain_name,
@@ -477,6 +574,7 @@ module Twilio
                 disaster_recovery_method: disaster_recovery_method,
                 recording: recording,
                 secure: secure,
+                cnam_lookup_enabled: cnam_lookup_enabled,
             )
           end
 

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,7 +19,8 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The unique string that we created to identify the Trunk
+        #   resource to fetch.
         # @return [Twilio::REST::Trunking::V1::TrunkContext] if sid was passed.
         # @return [Twilio::REST::Trunking::V1::TrunkList]
         def trunks(sid=:unset)

data/lib/twilio-ruby/rest/trunking.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Trunk
+      #   resource.
       # @return [Twilio::REST::Trunking::V1::TrunkInstance] if sid was passed.
       # @return [Twilio::REST::Trunking::V1::TrunkList]
       def trunks(sid=:unset)