twilio-ruby 5.15.1 → 5.58.1

data/lib/twilio-ruby/rest/voice/v1/{voice_permission → dialing_permissions}/bulk_country_update.rb

@@ -3,14 +3,14 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
     class Voice < Domain
       class V1 < Version
-        class VoicePermissionList < ListResource
+        class DialingPermissionsList < ListResource
           ##
           # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
           class BulkCountryUpdateList < ListResource
@@ -27,21 +27,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of BulkCountryUpdateInstance records from the API.
-            # Request is executed immediately.
+            # Create the BulkCountryUpdateInstance
             # @param [String] update_request URL encoded JSON array of update objects. example
-            #   : [ { "iso_code": "GB", "low_risk_numbers_enabled": "true",
+            #   : `[ { "iso_code": "GB", "low_risk_numbers_enabled": "true",
             #   "high_risk_special_numbers_enabled":"true",
-            #   "high_risk_tollfraud_numbers_enabled": "false" } ]
-            # @return [BulkCountryUpdateInstance] Newly created BulkCountryUpdateInstance
+            #   "high_risk_tollfraud_numbers_enabled": "false" } ]`
+            # @return [BulkCountryUpdateInstance] Created BulkCountryUpdateInstance
             def create(update_request: nil)
               data = Twilio::Values.of({'UpdateRequest' => update_request, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               BulkCountryUpdateInstance.new(@version, payload, )
             end
@@ -109,7 +104,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The update_request
+            # @return [String] A URL encoded JSON array of update objects
             def update_request
               @properties['update_request']
             end

data/lib/twilio-ruby/rest/voice/v1/{voice_permission → dialing_permissions}/country/highrisk_special_prefix.rb

@@ -3,14 +3,14 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
     class Voice < Domain
       class V1 < Version
-        class VoicePermissionList < ListResource
+        class DialingPermissionsList < ListResource
           class CountryContext < InstanceContext
             ##
             # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the HighriskSpecialPrefixList
               # @param [Version] version Version that contains the resource
-              # @param [String] iso_code The [ISO country
-              #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+              # @param [String] iso_code The {ISO country
+              #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2].
               # @return [HighriskSpecialPrefixList] HighriskSpecialPrefixList
               def initialize(version, iso_code: nil)
                 super(version)
@@ -90,11 +90,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 HighriskSpecialPrefixPage.new(@version, response, @solution)
               end
 
@@ -156,8 +154,8 @@ module Twilio
               # Initialize the HighriskSpecialPrefixInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] iso_code The [ISO country
-              #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+              # @param [String] iso_code The {ISO country
+              #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2].
               # @return [HighriskSpecialPrefixInstance] HighriskSpecialPrefixInstance
               def initialize(version, payload, iso_code: nil)
                 super(version)

data/lib/twilio-ruby/rest/voice/v1/{voice_permission → dialing_permissions}/country.rb

@@ -3,14 +3,14 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
   module REST
     class Voice < Domain
       class V1 < Version
-        class VoicePermissionList < ListResource
+        class DialingPermissionsList < ListResource
           ##
           # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
           class CountryList < ListResource
@@ -31,21 +31,21 @@ module Twilio
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [String] iso_code Filter to retrieve the country permissions by
-            #   specifying the [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+            #   specifying the {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2]
             # @param [String] continent Filter to retrieve the country permissions by
             #   specifying the continent
-            # @param [String] country_code Filter the results by specified [country
-            #   codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)
+            # @param [String] country_code Filter the results by specified {country
+            #   codes}[https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html]
             # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country
-            #   permissions with dialing to low-risk numbers enabled set to true / false
+            #   permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`.
             # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the
-            #   country permissions with dialing to high-risk special service numbers enabled
-            #   set to true / false
+            #   country permissions with dialing to high-risk special service numbers enabled.
+            #   Can be: `true` or `false`
             # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the
-            #   country permissions with dialing to high-risk [toll
-            #   fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled
-            #   set to true / false
+            #   country permissions with dialing to high-risk {toll
+            #   fraud}[https://www.twilio.com/learn/voice-and-video/toll-fraud] numbers enabled.
+            #   Can be: `true` or `false`.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -71,21 +71,21 @@ module Twilio
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [String] iso_code Filter to retrieve the country permissions by
-            #   specifying the [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+            #   specifying the {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2]
             # @param [String] continent Filter to retrieve the country permissions by
             #   specifying the continent
-            # @param [String] country_code Filter the results by specified [country
-            #   codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)
+            # @param [String] country_code Filter the results by specified {country
+            #   codes}[https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html]
             # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country
-            #   permissions with dialing to low-risk numbers enabled set to true / false
+            #   permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`.
             # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the
-            #   country permissions with dialing to high-risk special service numbers enabled
-            #   set to true / false
+            #   country permissions with dialing to high-risk special service numbers enabled.
+            #   Can be: `true` or `false`
             # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the
-            #   country permissions with dialing to high-risk [toll
-            #   fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled
-            #   set to true / false
+            #   country permissions with dialing to high-risk {toll
+            #   fraud}[https://www.twilio.com/learn/voice-and-video/toll-fraud] numbers enabled.
+            #   Can be: `true` or `false`.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
             # @param [Integer] page_size Number of records to fetch per request, when
@@ -127,21 +127,21 @@ module Twilio
             # Retrieve a single page of CountryInstance records from the API.
             # Request is executed immediately.
             # @param [String] iso_code Filter to retrieve the country permissions by
-            #   specifying the [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+            #   specifying the {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2]
             # @param [String] continent Filter to retrieve the country permissions by
             #   specifying the continent
-            # @param [String] country_code Filter the results by specified [country
-            #   codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)
+            # @param [String] country_code Filter the results by specified {country
+            #   codes}[https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html]
             # @param [Boolean] low_risk_numbers_enabled Filter to retrieve the country
-            #   permissions with dialing to low-risk numbers enabled set to true / false
+            #   permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`.
             # @param [Boolean] high_risk_special_numbers_enabled Filter to retrieve the
-            #   country permissions with dialing to high-risk special service numbers enabled
-            #   set to true / false
+            #   country permissions with dialing to high-risk special service numbers enabled.
+            #   Can be: `true` or `false`
             # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter to retrieve the
-            #   country permissions with dialing to high-risk [toll
-            #   fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled
-            #   set to true / false
+            #   country permissions with dialing to high-risk {toll
+            #   fraud}[https://www.twilio.com/learn/voice-and-video/toll-fraud] numbers enabled.
+            #   Can be: `true` or `false`.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
@@ -158,11 +158,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               CountryPage.new(@version, response, @solution)
             end
 
@@ -223,8 +221,9 @@ module Twilio
             ##
             # Initialize the CountryContext
             # @param [Version] version Version that contains the resource
-            # @param [String] iso_code The [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+            # @param [String] iso_code The {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the
+            #   DialingPermissions Country resource to fetch
             # @return [CountryContext] CountryContext
             def initialize(version, iso_code)
               super(version)
@@ -238,16 +237,10 @@ module Twilio
             end
 
             ##
-            # Fetch a CountryInstance
+            # Fetch the CountryInstance
             # @return [CountryInstance] Fetched CountryInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               CountryInstance.new(@version, payload, iso_code: @solution[:iso_code], )
             end
@@ -270,6 +263,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Voice.V1.CountryContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Voice.V1.CountryContext #{context}>"
+            end
           end
 
           ##
@@ -279,8 +279,9 @@ module Twilio
             # Initialize the CountryInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] iso_code The [ISO country
-            #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
+            # @param [String] iso_code The {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the
+            #   DialingPermissions Country resource to fetch
             # @return [CountryInstance] CountryInstance
             def initialize(version, payload, iso_code: nil)
               super(version)
@@ -321,55 +322,55 @@ module Twilio
             end
 
             ##
-            # @return [String] Name of the country
+            # @return [String] The name of the country
             def name
               @properties['name']
             end
 
             ##
-            # @return [String] Name of the continent
+            # @return [String] The name of the continent in which the country is located
             def continent
               @properties['continent']
             end
 
             ##
-            # @return [String] The E.164 assigned country codes(s)
+            # @return [Array[String]] The E.164 assigned country codes(s)
             def country_codes
               @properties['country_codes']
             end
 
             ##
-            # @return [Boolean] true, if dialing to low-risk numbers is enabled, else false
+            # @return [Boolean] Whether dialing to low-risk numbers is enabled
             def low_risk_numbers_enabled
               @properties['low_risk_numbers_enabled']
             end
 
             ##
-            # @return [Boolean] true, if dialing to high-risk special services numbers is enabled, else false. This group of prefixes, are number ranges allocated by the corresponding country. They consist of number types such as premium numbers, special services, shared cost and others
+            # @return [Boolean] Whether dialing to high-risk special services numbers is enabled
             def high_risk_special_numbers_enabled
               @properties['high_risk_special_numbers_enabled']
             end
 
             ##
-            # @return [Boolean] true, if dialing to high-risk toll fraud numbers is enabled, else false. This group of prefixes are narrow number ranges that have a high-risk of international revenue sharing fraud (IRSF) attacks also called toll fraud. The group of prefixes is formed through integration with anti-fraud databases and verified by analyzing calls on the Twilio Super Network. This group of prefixes are not available for download and are updated frequently
+            # @return [Boolean] Whether dialing to high-risk toll fraud numbers is enabled, else `false`
             def high_risk_tollfraud_numbers_enabled
               @properties['high_risk_tollfraud_numbers_enabled']
             end
 
             ##
-            # @return [String] The URL for this resource
+            # @return [String] The absolute URL of this resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] A list of URLs related to this resource
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a CountryInstance
+            # Fetch the CountryInstance
             # @return [CountryInstance] Fetched CountryInstance
             def fetch
               context.fetch

data/lib/twilio-ruby/rest/voice/v1/dialing_permissions/settings.rb

@@ -0,0 +1,197 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Voice < Domain
+      class V1 < Version
+        class DialingPermissionsList < ListResource
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SettingsList < ListResource
+            ##
+            # Initialize the SettingsList
+            # @param [Version] version Version that contains the resource
+            # @return [SettingsList] SettingsList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Voice.V1.SettingsList>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SettingsPage < Page
+            ##
+            # Initialize the SettingsPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [SettingsPage] SettingsPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of SettingsInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [SettingsInstance] SettingsInstance
+            def get_instance(payload)
+              SettingsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Voice.V1.SettingsPage>'
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SettingsContext < InstanceContext
+            ##
+            # Initialize the SettingsContext
+            # @param [Version] version Version that contains the resource
+            # @return [SettingsContext] SettingsContext
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/Settings"
+            end
+
+            ##
+            # Fetch the SettingsInstance
+            # @return [SettingsInstance] Fetched SettingsInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              SettingsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Update the SettingsInstance
+            # @param [Boolean] dialing_permissions_inheritance `true` for the sub-account to
+            #   inherit voice dialing permissions from the Master Project; otherwise `false`.
+            # @return [SettingsInstance] Updated SettingsInstance
+            def update(dialing_permissions_inheritance: :unset)
+              data = Twilio::Values.of({'DialingPermissionsInheritance' => dialing_permissions_inheritance, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              SettingsInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Voice.V1.SettingsContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Voice.V1.SettingsContext #{context}>"
+            end
+          end
+
+          ##
+          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+          class SettingsInstance < InstanceResource
+            ##
+            # Initialize the SettingsInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @return [SettingsInstance] SettingsInstance
+            def initialize(version, payload)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'dialing_permissions_inheritance' => payload['dialing_permissions_inheritance'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {}
+            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 [SettingsContext] SettingsContext for this SettingsInstance
+            def context
+              unless @instance_context
+                @instance_context = SettingsContext.new(@version, )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [Boolean] `true` if the sub-account will inherit voice dialing permissions from the Master Project; otherwise `false`
+            def dialing_permissions_inheritance
+              @properties['dialing_permissions_inheritance']
+            end
+
+            ##
+            # @return [String] The absolute URL of this resource
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the SettingsInstance
+            # @return [SettingsInstance] Fetched SettingsInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the SettingsInstance
+            # @param [Boolean] dialing_permissions_inheritance `true` for the sub-account to
+            #   inherit voice dialing permissions from the Master Project; otherwise `false`.
+            # @return [SettingsInstance] Updated SettingsInstance
+            def update(dialing_permissions_inheritance: :unset)
+              context.update(dialing_permissions_inheritance: dialing_permissions_inheritance, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Voice.V1.SettingsInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Voice.V1.SettingsInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end