twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/api/v2010/account/sip/domain.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -54,7 +56,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
@@ -66,7 +68,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],
@@ -86,11 +88,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 DomainPage.new(@version, response, @solution)
               end
 
@@ -108,31 +108,42 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of DomainInstance records from the API.
-              # Request is executed immediately.
+              # Create the DomainInstance
               # @param [String] domain_name The unique address you reserve on Twilio to which
-              #   you route your SIP traffic
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
-              # @param [String] auth_type The types of authentication you have mapped to your
-              #   domain
-              # @param [String] voice_url The URL Twilio will request when this domain receives
-              #   a call
-              # @param [String] voice_method The HTTP method to use with the voice_url
-              # @param [String] voice_fallback_url The URL that Twilio will use if an error
-              #   occurs retrieving or executing the TwiML requested by VoiceUrl
-              # @param [String] voice_fallback_method The HTTP method Twilio will use when
-              #   requesting the VoiceFallbackUrl
-              # @param [String] voice_status_callback_url The URL that Twilio will request to
-              #   pass status parameters
-              # @param [String] voice_status_callback_method The voice_status_callback_method
-              # @param [Boolean] sip_registration The sip_registration
-              # @return [DomainInstance] Newly created DomainInstance
-              def create(domain_name: nil, friendly_name: :unset, auth_type: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset)
+              #   you route your SIP traffic. Domain names can contain letters, digits, and "-"
+              #   and must end with `sip.twilio.com`.
+              # @param [String] friendly_name A descriptive string that you created to describe
+              #   the resource. It can be up to 64 characters long.
+              # @param [String] voice_url The URL we should when the domain receives a call.
+              # @param [String] voice_method The HTTP method we should use to call `voice_url`.
+              #   Can be: `GET` or `POST`.
+              # @param [String] voice_fallback_url The URL that we should call when an error
+              #   occurs while retrieving or executing the TwiML from `voice_url`.
+              # @param [String] voice_fallback_method The HTTP method we should use to call
+              #   `voice_fallback_url`. Can be: `GET` or `POST`.
+              # @param [String] voice_status_callback_url The URL that we should call to pass
+              #   status parameters (such as call ended) to your application.
+              # @param [String] voice_status_callback_method The HTTP method we should use to
+              #   call `voice_status_callback_url`. Can be: `GET` or `POST`.
+              # @param [Boolean] sip_registration Whether to allow SIP Endpoints to register
+              #   with the domain to receive calls. Can be `true` or `false`. `true` allows SIP
+              #   Endpoints to register with the domain to receive calls, `false` does not.
+              # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled
+              #   for the domain. If enabled, allows emergency calls on the domain from phone
+              #   numbers with validated addresses.
+              # @param [Boolean] secure Whether secure SIP is enabled for the domain. If
+              #   enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls
+              #   to this sip domain.
+              # @param [String] byoc_trunk_sid The SID of the BYOC Trunk(Bring Your Own Carrier)
+              #   resource that the Sip Domain will be associated with.
+              # @param [String] emergency_caller_sid Whether an emergency caller sid is
+              #   configured for the domain. If present, this phone number will be used as the
+              #   callback for the emergency call.
+              # @return [DomainInstance] Created DomainInstance
+              def create(domain_name: nil, friendly_name: :unset, voice_url: :unset, voice_method: :unset, voice_fallback_url: :unset, voice_fallback_method: :unset, voice_status_callback_url: :unset, voice_status_callback_method: :unset, sip_registration: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset)
                 data = Twilio::Values.of({
                     'DomainName' => domain_name,
                     'FriendlyName' => friendly_name,
-                    'AuthType' => auth_type,
                     'VoiceUrl' => voice_url,
                     'VoiceMethod' => voice_method,
                     'VoiceFallbackUrl' => voice_fallback_url,
@@ -140,15 +151,15 @@ module Twilio
                     'VoiceStatusCallbackUrl' => voice_status_callback_url,
                     'VoiceStatusCallbackMethod' => voice_status_callback_method,
                     'SipRegistration' => sip_registration,
+                    'EmergencyCallingEnabled' => emergency_calling_enabled,
+                    'Secure' => secure,
+                    'ByocTrunkSid' => byoc_trunk_sid,
+                    'EmergencyCallerSid' => emergency_caller_sid,
                 })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
-                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -177,7 +188,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [DomainInstance] DomainInstance
               def get_instance(payload)
-                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid])
+                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid], )
               end
 
               ##
@@ -191,52 +202,69 @@ module Twilio
               ##
               # Initialize the DomainContext
               # @param [Version] version Version that contains the resource
-              # @param [String] account_sid The account_sid
-              # @param [String] sid The domain sid that uniquely identifies the resource
+              # @param [String] account_sid The SID of the
+              #   {Account}[https://www.twilio.com/docs/iam/api/account] that created the
+              #   SipDomain resource to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   SipDomain resource to fetch.
               # @return [DomainContext] DomainContext
               def initialize(version, account_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {account_sid: account_sid, sid: sid}
+                @solution = {account_sid: account_sid, sid: sid, }
                 @uri = "/Accounts/#{@solution[:account_sid]}/SIP/Domains/#{@solution[:sid]}.json"
 
                 # Dependents
                 @ip_access_control_list_mappings = nil
                 @credential_list_mappings = nil
+                @auth = nil
               end
 
               ##
-              # Fetch a DomainInstance
+              # Fetch the DomainInstance
               # @return [DomainInstance] Fetched DomainInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
-                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
               end
 
               ##
               # Update the DomainInstance
-              # @param [String] auth_type The auth_type
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
-              # @param [String] voice_fallback_method The voice_fallback_method
-              # @param [String] voice_fallback_url The voice_fallback_url
-              # @param [String] voice_method The HTTP method to use with the voice_url
-              # @param [String] voice_status_callback_method The voice_status_callback_method
-              # @param [String] voice_status_callback_url The voice_status_callback_url
-              # @param [String] voice_url The voice_url
-              # @param [Boolean] sip_registration The sip_registration
+              # @param [String] friendly_name A descriptive string that you created to describe
+              #   the resource. It can be up to 64 characters long.
+              # @param [String] voice_fallback_method The HTTP method we should use to call
+              #   `voice_fallback_url`. Can be: `GET` or `POST`.
+              # @param [String] voice_fallback_url The URL that we should call when an error
+              #   occurs while retrieving or executing the TwiML requested by `voice_url`.
+              # @param [String] voice_method The HTTP method we should use to call `voice_url`
+              # @param [String] voice_status_callback_method The HTTP method we should use to
+              #   call `voice_status_callback_url`. Can be: `GET` or `POST`.
+              # @param [String] voice_status_callback_url The URL that we should call to pass
+              #   status parameters (such as call ended) to your application.
+              # @param [String] voice_url The URL we should call when the domain receives a
+              #   call.
+              # @param [Boolean] sip_registration Whether to allow SIP Endpoints to register
+              #   with the domain to receive calls. Can be `true` or `false`. `true` allows SIP
+              #   Endpoints to register with the domain to receive calls, `false` does not.
+              # @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 `sip.twilio.com`.
+              # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled
+              #   for the domain. If enabled, allows emergency calls on the domain from phone
+              #   numbers with validated addresses.
+              # @param [Boolean] secure Whether secure SIP is enabled for the domain. If
+              #   enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls
+              #   to this sip domain.
+              # @param [String] byoc_trunk_sid The SID of the BYOC Trunk(Bring Your Own Carrier)
+              #   resource that the Sip Domain will be associated with.
+              # @param [String] emergency_caller_sid Whether an emergency caller sid is
+              #   configured for the domain. If present, this phone number will be used as the
+              #   callback for the emergency call.
               # @return [DomainInstance] Updated DomainInstance
-              def update(auth_type: :unset, friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset)
+              def update(friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset, domain_name: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset)
                 data = Twilio::Values.of({
-                    'AuthType' => auth_type,
                     'FriendlyName' => friendly_name,
                     'VoiceFallbackMethod' => voice_fallback_method,
                     'VoiceFallbackUrl' => voice_fallback_url,
@@ -245,22 +273,23 @@ module Twilio
                     'VoiceStatusCallbackUrl' => voice_status_callback_url,
                     'VoiceUrl' => voice_url,
                     'SipRegistration' => sip_registration,
+                    'DomainName' => domain_name,
+                    'EmergencyCallingEnabled' => emergency_calling_enabled,
+                    'Secure' => secure,
+                    'ByocTrunkSid' => byoc_trunk_sid,
+                    'EmergencyCallerSid' => emergency_caller_sid,
                 })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
-                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid])
+                DomainInstance.new(@version, payload, account_sid: @solution[:account_sid], sid: @solution[:sid], )
               end
 
               ##
-              # Deletes the DomainInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the DomainInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -271,7 +300,12 @@ module Twilio
                 raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
                 if sid != :unset
-                  return IpAccessControlListMappingContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                  return IpAccessControlListMappingContext.new(
+                      @version,
+                      @solution[:account_sid],
+                      @solution[:sid],
+                      sid,
+                  )
                 end
 
                 unless @ip_access_control_list_mappings
@@ -293,7 +327,7 @@ module Twilio
                 raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
                 if sid != :unset
-                  return CredentialListMappingContext.new(@version, @solution[:account_sid], @solution[:sid], sid)
+                  return CredentialListMappingContext.new(@version, @solution[:account_sid], @solution[:sid], sid, )
                 end
 
                 unless @credential_list_mappings
@@ -307,12 +341,35 @@ module Twilio
                 @credential_list_mappings
               end
 
+              ##
+              # Access the auth
+              # @return [AuthTypesList]
+              # @return [AuthTypesContext]
+              def auth
+                unless @auth
+                  @auth = AuthTypesList.new(
+                      @version,
+                      account_sid: @solution[:account_sid],
+                      domain_sid: @solution[:sid],
+                  )
+                end
+
+                @auth
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Api.V2010.DomainContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Api.V2010.DomainContext #{context}>"
+              end
             end
 
             class DomainInstance < InstanceResource
@@ -322,7 +379,8 @@ module Twilio
               # @param [Hash] payload payload that contains response from Twilio
               # @param [String] account_sid A 34 character string that uniquely identifies this
               #   resource.
-              # @param [String] sid The domain sid that uniquely identifies the resource
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   SipDomain resource to fetch.
               # @return [DomainInstance] DomainInstance
               def initialize(version, payload, account_sid: nil, sid: nil)
                 super(version)
@@ -346,11 +404,15 @@ module Twilio
                     'voice_url' => payload['voice_url'],
                     'subresource_uris' => payload['subresource_uris'],
                     'sip_registration' => payload['sip_registration'],
+                    'emergency_calling_enabled' => payload['emergency_calling_enabled'],
+                    'secure' => payload['secure'],
+                    'byoc_trunk_sid' => payload['byoc_trunk_sid'],
+                    'emergency_caller_sid' => payload['emergency_caller_sid'],
                 }
 
                 # Context
                 @instance_context = nil
-                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid']}
+                @params = {'account_sid' => account_sid, 'sid' => sid || @properties['sid'], }
               end
 
               ##
@@ -359,19 +421,19 @@ module Twilio
               # @return [DomainContext] DomainContext for this DomainInstance
               def context
                 unless @instance_context
-                  @instance_context = DomainContext.new(@version, @params['account_sid'], @params['sid'])
+                  @instance_context = DomainContext.new(@version, @params['account_sid'], @params['sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [String] The unique id of the account that sent the message
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The Twilio API version used to process the message
+              # @return [String] The API version used to process the call
               def api_version
                 @properties['api_version']
               end
@@ -383,13 +445,13 @@ module Twilio
               end
 
               ##
-              # @return [Time] The date this resource was created
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date this resource was last updated
+              # @return [Time] The RFC 2822 date and time in GMT that the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
@@ -401,73 +463,97 @@ module Twilio
               end
 
               ##
-              # @return [String] A user-specified, human-readable name for the trigger.
+              # @return [String] The string that you assigned to describe the resource
               def friendly_name
                 @properties['friendly_name']
               end
 
               ##
-              # @return [String] A string that uniquely identifies the SIP Domain
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The URI for this resource
+              # @return [String] The URI of the resource, relative to `https://api.twilio.com`
               def uri
                 @properties['uri']
               end
 
               ##
-              # @return [String] HTTP method used with voice_fallback_url
+              # @return [String] The HTTP method used with voice_fallback_url
               def voice_fallback_method
                 @properties['voice_fallback_method']
               end
 
               ##
-              # @return [String] URL Twilio will request if an error occurs in executing TwiML
+              # @return [String] The URL we call when an error occurs while executing TwiML
               def voice_fallback_url
                 @properties['voice_fallback_url']
               end
 
               ##
-              # @return [String] HTTP method to use with voice_url
+              # @return [String] The HTTP method to use with voice_url
               def voice_method
                 @properties['voice_method']
               end
 
               ##
-              # @return [String] The voice_status_callback_method
+              # @return [String] The HTTP method we use to call voice_status_callback_url
               def voice_status_callback_method
                 @properties['voice_status_callback_method']
               end
 
               ##
-              # @return [String] URL that Twilio will request with status updates
+              # @return [String] The URL that we call with status updates
               def voice_status_callback_url
                 @properties['voice_status_callback_url']
               end
 
               ##
-              # @return [String] URL Twilio will request when receiving a call
+              # @return [String] The URL we call when receiving a call
               def voice_url
                 @properties['voice_url']
               end
 
               ##
-              # @return [String] The subresource_uris
+              # @return [String] A list mapping resources associated with the SIP Domain resource
               def subresource_uris
                 @properties['subresource_uris']
               end
 
               ##
-              # @return [Boolean] If SIP registration is allowed
+              # @return [Boolean] Whether SIP registration is allowed
               def sip_registration
                 @properties['sip_registration']
               end
 
               ##
-              # Fetch a DomainInstance
+              # @return [Boolean] Whether emergency calling is enabled for the domain.
+              def emergency_calling_enabled
+                @properties['emergency_calling_enabled']
+              end
+
+              ##
+              # @return [Boolean] Whether secure SIP is enabled for the domain
+              def secure
+                @properties['secure']
+              end
+
+              ##
+              # @return [String] The SID of the BYOC Trunk resource.
+              def byoc_trunk_sid
+                @properties['byoc_trunk_sid']
+              end
+
+              ##
+              # @return [String] Whether an emergency caller sid is configured for the domain.
+              def emergency_caller_sid
+                @properties['emergency_caller_sid']
+              end
+
+              ##
+              # Fetch the DomainInstance
               # @return [DomainInstance] Fetched DomainInstance
               def fetch
                 context.fetch
@@ -475,20 +561,39 @@ module Twilio
 
               ##
               # Update the DomainInstance
-              # @param [String] auth_type The auth_type
-              # @param [String] friendly_name A user-specified, human-readable name for the
-              #   trigger.
-              # @param [String] voice_fallback_method The voice_fallback_method
-              # @param [String] voice_fallback_url The voice_fallback_url
-              # @param [String] voice_method The HTTP method to use with the voice_url
-              # @param [String] voice_status_callback_method The voice_status_callback_method
-              # @param [String] voice_status_callback_url The voice_status_callback_url
-              # @param [String] voice_url The voice_url
-              # @param [Boolean] sip_registration The sip_registration
+              # @param [String] friendly_name A descriptive string that you created to describe
+              #   the resource. It can be up to 64 characters long.
+              # @param [String] voice_fallback_method The HTTP method we should use to call
+              #   `voice_fallback_url`. Can be: `GET` or `POST`.
+              # @param [String] voice_fallback_url The URL that we should call when an error
+              #   occurs while retrieving or executing the TwiML requested by `voice_url`.
+              # @param [String] voice_method The HTTP method we should use to call `voice_url`
+              # @param [String] voice_status_callback_method The HTTP method we should use to
+              #   call `voice_status_callback_url`. Can be: `GET` or `POST`.
+              # @param [String] voice_status_callback_url The URL that we should call to pass
+              #   status parameters (such as call ended) to your application.
+              # @param [String] voice_url The URL we should call when the domain receives a
+              #   call.
+              # @param [Boolean] sip_registration Whether to allow SIP Endpoints to register
+              #   with the domain to receive calls. Can be `true` or `false`. `true` allows SIP
+              #   Endpoints to register with the domain to receive calls, `false` does not.
+              # @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 `sip.twilio.com`.
+              # @param [Boolean] emergency_calling_enabled Whether emergency calling is enabled
+              #   for the domain. If enabled, allows emergency calls on the domain from phone
+              #   numbers with validated addresses.
+              # @param [Boolean] secure Whether secure SIP is enabled for the domain. If
+              #   enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls
+              #   to this sip domain.
+              # @param [String] byoc_trunk_sid The SID of the BYOC Trunk(Bring Your Own Carrier)
+              #   resource that the Sip Domain will be associated with.
+              # @param [String] emergency_caller_sid Whether an emergency caller sid is
+              #   configured for the domain. If present, this phone number will be used as the
+              #   callback for the emergency call.
               # @return [DomainInstance] Updated DomainInstance
-              def update(auth_type: :unset, friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset)
+              def update(friendly_name: :unset, voice_fallback_method: :unset, voice_fallback_url: :unset, voice_method: :unset, voice_status_callback_method: :unset, voice_status_callback_url: :unset, voice_url: :unset, sip_registration: :unset, domain_name: :unset, emergency_calling_enabled: :unset, secure: :unset, byoc_trunk_sid: :unset, emergency_caller_sid: :unset)
                 context.update(
-                    auth_type: auth_type,
                     friendly_name: friendly_name,
                     voice_fallback_method: voice_fallback_method,
                     voice_fallback_url: voice_fallback_url,
@@ -497,12 +602,17 @@ module Twilio
                     voice_status_callback_url: voice_status_callback_url,
                     voice_url: voice_url,
                     sip_registration: sip_registration,
+                    domain_name: domain_name,
+                    emergency_calling_enabled: emergency_calling_enabled,
+                    secure: secure,
+                    byoc_trunk_sid: byoc_trunk_sid,
+                    emergency_caller_sid: emergency_caller_sid,
                 )
               end
 
               ##
-              # Deletes the DomainInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the DomainInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end
@@ -521,6 +631,13 @@ module Twilio
                 context.credential_list_mappings
               end
 
+              ##
+              # Access the auth
+              # @return [auth] auth
+              def auth
+                context.auth
+              end
+
               ##
               # Provide a user friendly representation
               def to_s