twilio-ruby 5.31.0 → 5.46.0

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

@@ -31,8 +31,8 @@ module Twilio
 
           ##
           # Access the countries
-          # @param [String] iso_code The [ISO country
-          #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+          # @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 [CountryList]
           # @return [CountryContext] if iso_code was passed.
@@ -48,12 +48,9 @@ module Twilio
 
           ##
           # Access the settings
-          # @return [SettingsList]
-          # @return [SettingsContext]
+          # @return [SettingsContext] SettingsContext
           def settings
             return SettingsContext.new(@version, )
-
-            @settings ||= SettingsList.new(@version, )
           end
 
           ##

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

@@ -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",
             #   "high_risk_special_numbers_enabled":"true",
             #   "high_risk_tollfraud_numbers_enabled": "false" } ]`
-            # @return [BulkCountryUpdateInstance] Newly created BulkCountryUpdateInstance
+            # @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

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

@@ -31,20 +31,20 @@ 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](https://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. 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.
             #   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.
+            #   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
@@ -71,20 +71,20 @@ 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](https://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. 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.
             #   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.
+            #   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.
@@ -127,20 +127,20 @@ 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](https://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. 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.
             #   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.
+            #   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
@@ -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,8 @@ module Twilio
             ##
             # Initialize the CountryContext
             # @param [Version] version Version that contains the resource
-            # @param [String] iso_code The [ISO country
-            #   code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+            # @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)
@@ -239,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
@@ -287,8 +279,8 @@ 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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+            # @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)
@@ -342,7 +334,7 @@ module Twilio
             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
@@ -378,7 +370,7 @@ module Twilio
             end
 
             ##
-            # Fetch a CountryInstance
+            # Fetch the CountryInstance
             # @return [CountryInstance] Fetched CountryInstance
             def fetch
               context.fetch

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

@@ -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](https://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](https://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/dialing_permissions/settings.rb

@@ -79,16 +79,10 @@ module Twilio
             end
 
             ##
-            # Fetch a SettingsInstance
+            # Fetch the SettingsInstance
             # @return [SettingsInstance] Fetched SettingsInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               SettingsInstance.new(@version, payload, )
             end
@@ -101,11 +95,7 @@ module Twilio
             def update(dialing_permissions_inheritance: :unset)
               data = Twilio::Values.of({'DialingPermissionsInheritance' => dialing_permissions_inheritance, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               SettingsInstance.new(@version, payload, )
             end
@@ -171,7 +161,7 @@ module Twilio
             end
 
             ##
-            # Fetch a SettingsInstance
+            # Fetch the SettingsInstance
             # @return [SettingsInstance] Fetched SettingsInstance
             def fetch
               context.fetch

data/lib/twilio-ruby/rest/voice/v1/ip_record.rb

@@ -0,0 +1,349 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Voice < Domain
+      class V1 < Version
+        class IpRecordList < ListResource
+          ##
+          # Initialize the IpRecordList
+          # @param [Version] version Version that contains the resource
+          # @return [IpRecordList] IpRecordList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/IpRecords"
+          end
+
+          ##
+          # Create the IpRecordInstance
+          # @param [String] ip_address An IP address in dotted decimal notation, IPv4 only.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It is not unique and can be up to 255 characters long.
+          # @param [String] cidr_prefix_length An integer representing the length of the
+          #   {CIDR}[https://tools.ietf.org/html/rfc4632] prefix to use with this IP address.
+          #   By default the entire IP address is used, which for IPv4 is value 32.
+          # @return [IpRecordInstance] Created IpRecordInstance
+          def create(ip_address: nil, friendly_name: :unset, cidr_prefix_length: :unset)
+            data = Twilio::Values.of({
+                'IpAddress' => ip_address,
+                'FriendlyName' => friendly_name,
+                'CidrPrefixLength' => cidr_prefix_length,
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            IpRecordInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists IpRecordInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @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
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams IpRecordInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @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
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields IpRecordInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of IpRecordInstance records from the API.
+          # Request is executed immediately.
+          # @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
+          # @return [Page] Page of IpRecordInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            IpRecordPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of IpRecordInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of IpRecordInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            IpRecordPage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Voice.V1.IpRecordList>'
+          end
+        end
+
+        class IpRecordPage < Page
+          ##
+          # Initialize the IpRecordPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [IpRecordPage] IpRecordPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of IpRecordInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [IpRecordInstance] IpRecordInstance
+          def get_instance(payload)
+            IpRecordInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Voice.V1.IpRecordPage>'
+          end
+        end
+
+        class IpRecordContext < InstanceContext
+          ##
+          # Initialize the IpRecordContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The Twilio-provided string that uniquely identifies the IP
+          #   Record resource to fetch.
+          # @return [IpRecordContext] IpRecordContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/IpRecords/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the IpRecordInstance
+          # @return [IpRecordInstance] Fetched IpRecordInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            IpRecordInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the IpRecordInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It is not unique and can be up to 255 characters long.
+          # @return [IpRecordInstance] Updated IpRecordInstance
+          def update(friendly_name: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            IpRecordInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Delete the IpRecordInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Voice.V1.IpRecordContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Voice.V1.IpRecordContext #{context}>"
+          end
+        end
+
+        class IpRecordInstance < InstanceResource
+          ##
+          # Initialize the IpRecordInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The Twilio-provided string that uniquely identifies the IP
+          #   Record resource to fetch.
+          # @return [IpRecordInstance] IpRecordInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
+                'ip_address' => payload['ip_address'],
+                'cidr_prefix_length' => payload['cidr_prefix_length'].to_i,
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['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 [IpRecordContext] IpRecordContext for this IpRecordInstance
+          def context
+            unless @instance_context
+              @instance_context = IpRecordContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the resource
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] An IP address in dotted decimal notation, IPv4 only.
+          def ip_address
+            @properties['ip_address']
+          end
+
+          ##
+          # @return [String] An integer representing the length of the {CIDR}[https://tools.ietf.org/html/rfc4632] prefix to use with this IP address. By default the entire IP address is used, which for IPv4 is value 32.
+          def cidr_prefix_length
+            @properties['cidr_prefix_length']
+          end
+
+          ##
+          # @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 RFC 2822 date and time in GMT that the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] The absolute URL of the resource
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the IpRecordInstance
+          # @return [IpRecordInstance] Fetched IpRecordInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the IpRecordInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the resource. It is not unique and can be up to 255 characters long.
+          # @return [IpRecordInstance] Updated IpRecordInstance
+          def update(friendly_name: :unset)
+            context.update(friendly_name: friendly_name, )
+          end
+
+          ##
+          # Delete the IpRecordInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Voice.V1.IpRecordInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Voice.V1.IpRecordInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end