twilio-ruby 5.13.0 → 5.14.0

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

@@ -15,13 +15,44 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @compositions = nil
+          @composition_hooks = nil
           @composition_settings = nil
           @recordings = nil
           @recording_settings = nil
-          @compositions = nil
           @rooms = nil
         end
 
+        ##
+        # @param [String] sid The Composition Sid that uniquely identifies the Composition
+        #   to fetch.
+        # @return [Twilio::REST::Video::V1::CompositionContext] if sid was passed.
+        # @return [Twilio::REST::Video::V1::CompositionList]
+        def compositions(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @compositions ||= CompositionList.new self
+          else
+            CompositionContext.new(self, sid)
+          end
+        end
+
+        ##
+        # @param [String] sid The Composition Hook Sid that uniquely identifies the
+        #   Composition Hook to fetch.
+        # @return [Twilio::REST::Video::V1::CompositionHookContext] if sid was passed.
+        # @return [Twilio::REST::Video::V1::CompositionHookList]
+        def composition_hooks(sid=:unset)
+          if sid.nil?
+            raise ArgumentError, 'sid cannot be nil'
+          elsif sid == :unset
+            @composition_hooks ||= CompositionHookList.new self
+          else
+            CompositionHookContext.new(self, sid)
+          end
+        end
+
         ##
         # @return [Twilio::REST::Video::V1::CompositionSettingsContext]
         def composition_settings
@@ -49,21 +80,6 @@ module Twilio
           @recording_settings ||= RecordingSettingsContext.new self
         end
 
-        ##
-        # @param [String] sid The Composition Sid that uniquely identifies the Composition
-        #   to fetch.
-        # @return [Twilio::REST::Video::V1::CompositionContext] if sid was passed.
-        # @return [Twilio::REST::Video::V1::CompositionList]
-        def compositions(sid=:unset)
-          if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @compositions ||= CompositionList.new self
-          else
-            CompositionContext.new(self, sid)
-          end
-        end
-
         ##
         # @param [String] sid The Room Sid or name that uniquely identifies this resource.
         # @return [Twilio::REST::Video::V1::RoomContext] if sid was passed.

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

@@ -28,6 +28,24 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @param [String] sid `CJxx…xx` A system-generated 34-character string that
+      #   uniquely identifies this Composition.
+      # @return [Twilio::REST::Video::V1::CompositionInstance] if sid was passed.
+      # @return [Twilio::REST::Video::V1::CompositionList]
+      def compositions(sid=:unset)
+        self.v1.compositions(sid)
+      end
+
+      ##
+      # @param [String] sid `HKxx…xx` A system-generated 34-character string that
+      #   uniquely identifies this Composition Hook.
+      # @return [Twilio::REST::Video::V1::CompositionHookInstance] if sid was passed.
+      # @return [Twilio::REST::Video::V1::CompositionHookList]
+      def composition_hooks(sid=:unset)
+        self.v1.composition_hooks(sid)
+      end
+
       ##
       # @return [Twilio::REST::Video::V1::CompositionSettingsInstance]
       def composition_settings
@@ -49,15 +67,6 @@ module Twilio
         self.v1.recording_settings()
       end
 
-      ##
-      # @param [String] sid `CJxx…xx` A system-generated 34-character string that
-      #   uniquely identifies this Composition.
-      # @return [Twilio::REST::Video::V1::CompositionInstance] if sid was passed.
-      # @return [Twilio::REST::Video::V1::CompositionList]
-      def compositions(sid=:unset)
-        self.v1.compositions(sid)
-      end
-
       ##
       # @param [String] sid A system-generated 34-character string that uniquely
       #   identifies this resource.

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

@@ -8,8 +8,8 @@
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Permissions < Version
+    class Voice < Domain
+      class V1 < Version
         class VoicePermissionList < 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.
@@ -23,15 +23,16 @@ module Twilio
 
               # Path Solution
               @solution = {}
-              @uri = "/VoicePermissions/BulkCountryUpdates"
+              @uri = "/DialingPermissions/BulkCountryUpdates"
             end
 
             ##
             # Retrieve a single page of BulkCountryUpdateInstance records from the API.
             # Request is executed immediately.
-            # @param [String] update_request Json list of update objects. eg : [ { "iso_code":
-            #   "GB", "low_risk_numbers": "Enabled", "high_risk_special_numbers":"Enabled",
-            #   "high_risk_irsf_numbers": "Enabled" } ]
+            # @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
             def create(update_request: nil)
               data = Twilio::Values.of({'UpdateRequest' => update_request, })
@@ -48,7 +49,7 @@ module Twilio
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Preview.Permissions.BulkCountryUpdateList>'
+              '#<Twilio.Voice.V1.BulkCountryUpdateList>'
             end
           end
 
@@ -79,7 +80,7 @@ module Twilio
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Preview.Permissions.BulkCountryUpdatePage>'
+              '<Twilio.Voice.V1.BulkCountryUpdatePage>'
             end
           end
 
@@ -102,7 +103,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The number of countries successfully updated
+            # @return [String] The number of countries updated
             def update_count
               @properties['update_count']
             end
@@ -116,13 +117,13 @@ module Twilio
             ##
             # Provide a user friendly representation
             def to_s
-              "<Twilio.Preview.Permissions.BulkCountryUpdateInstance>"
+              "<Twilio.Voice.V1.BulkCountryUpdateInstance>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
-              "<Twilio.Preview.Permissions.BulkCountryUpdateInstance>"
+              "<Twilio.Voice.V1.BulkCountryUpdateInstance>"
             end
           end
         end

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

@@ -8,8 +8,8 @@
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Permissions < Version
+    class Voice < Domain
+      class V1 < Version
         class VoicePermissionList < ListResource
           class CountryContext < InstanceContext
             ##
@@ -18,15 +18,15 @@ module Twilio
               ##
               # Initialize the HighriskSpecialPrefixList
               # @param [Version] version Version that contains the resource
-              # @param [String] parent_iso_code The [ISO country
+              # @param [String] iso_code The [ISO country
               #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
               # @return [HighriskSpecialPrefixList] HighriskSpecialPrefixList
-              def initialize(version, parent_iso_code: nil)
+              def initialize(version, iso_code: nil)
                 super(version)
 
                 # Path Solution
-                @solution = {parent_iso_code: parent_iso_code}
-                @uri = "/VoicePermissions/Countries/#{@solution[:parent_iso_code]}/HighRiskSpecialPrefixes"
+                @solution = {iso_code: iso_code}
+                @uri = "/DialingPermissions/Countries/#{@solution[:iso_code]}/HighRiskSpecialPrefixes"
               end
 
               ##
@@ -114,7 +114,7 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Preview.Permissions.HighriskSpecialPrefixList>'
+                '#<Twilio.Voice.V1.HighriskSpecialPrefixList>'
               end
             end
 
@@ -139,13 +139,13 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [HighriskSpecialPrefixInstance] HighriskSpecialPrefixInstance
               def get_instance(payload)
-                HighriskSpecialPrefixInstance.new(@version, payload, parent_iso_code: @solution[:parent_iso_code], )
+                HighriskSpecialPrefixInstance.new(@version, payload, iso_code: @solution[:iso_code], )
               end
 
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Preview.Permissions.HighriskSpecialPrefixPage>'
+                '<Twilio.Voice.V1.HighriskSpecialPrefixPage>'
               end
             end
 
@@ -156,10 +156,10 @@ module Twilio
               # Initialize the HighriskSpecialPrefixInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] parent_iso_code The [ISO country
+              # @param [String] iso_code The [ISO country
               #   code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
               # @return [HighriskSpecialPrefixInstance] HighriskSpecialPrefixInstance
-              def initialize(version, payload, parent_iso_code: nil)
+              def initialize(version, payload, iso_code: nil)
                 super(version)
 
                 # Marshaled Properties
@@ -167,7 +167,7 @@ module Twilio
               end
 
               ##
-              # @return [String] prefix string of phone number
+              # @return [String] A prefix that includes the E.164 assigned country code
               def prefix
                 @properties['prefix']
               end
@@ -175,13 +175,13 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                "<Twilio.Preview.Permissions.HighriskSpecialPrefixInstance>"
+                "<Twilio.Voice.V1.HighriskSpecialPrefixInstance>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
-                "<Twilio.Preview.Permissions.HighriskSpecialPrefixInstance>"
+                "<Twilio.Voice.V1.HighriskSpecialPrefixInstance>"
               end
             end
           end

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

@@ -8,8 +8,8 @@
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Permissions < Version
+    class Voice < Domain
+      class V1 < Version
         class VoicePermissionList < 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.
@@ -23,24 +23,29 @@ module Twilio
 
               # Path Solution
               @solution = {}
-              @uri = "/VoicePermissions/Countries"
+              @uri = "/DialingPermissions/Countries"
             end
 
             ##
             # Lists CountryInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] iso_code The [ISO country
+            # @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)
-            # @param [String] continent Filter the results by specified continent
+            # @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://countrycode.org/)
-            # @param [Boolean] low_risk_numbers_enabled Filter the results by specified  low
-            #   risk special status
-            # @param [Boolean] high_risk_special_numbers_enabled Filter the results by
-            #   specified the status of high risk special
-            # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter the results by
-            #   specified the status of high risk tollfraud special
+            #   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
+            # @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
+            # @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
             # @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
@@ -65,17 +70,22 @@ module Twilio
             # Streams CountryInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] iso_code The [ISO country
+            # @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)
-            # @param [String] continent Filter the results by specified continent
+            # @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://countrycode.org/)
-            # @param [Boolean] low_risk_numbers_enabled Filter the results by specified  low
-            #   risk special status
-            # @param [Boolean] high_risk_special_numbers_enabled Filter the results by
-            #   specified the status of high risk special
-            # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter the results by
-            #   specified the status of high risk tollfraud special
+            #   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
+            # @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
+            # @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
             # @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
@@ -116,17 +126,22 @@ module Twilio
             ##
             # Retrieve a single page of CountryInstance records from the API.
             # Request is executed immediately.
-            # @param [String] iso_code The [ISO country
+            # @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)
-            # @param [String] continent Filter the results by specified continent
+            # @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://countrycode.org/)
-            # @param [Boolean] low_risk_numbers_enabled Filter the results by specified  low
-            #   risk special status
-            # @param [Boolean] high_risk_special_numbers_enabled Filter the results by
-            #   specified the status of high risk special
-            # @param [Boolean] high_risk_tollfraud_numbers_enabled Filter the results by
-            #   specified the status of high risk tollfraud special
+            #   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
+            # @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
+            # @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
             # @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
@@ -167,7 +182,7 @@ module Twilio
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Preview.Permissions.CountryList>'
+              '#<Twilio.Voice.V1.CountryList>'
             end
           end
 
@@ -198,7 +213,7 @@ module Twilio
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Preview.Permissions.CountryPage>'
+              '<Twilio.Voice.V1.CountryPage>'
             end
           end
 
@@ -216,7 +231,7 @@ module Twilio
 
               # Path Solution
               @solution = {iso_code: iso_code, }
-              @uri = "/VoicePermissions/Countries/#{@solution[:iso_code]}"
+              @uri = "/DialingPermissions/Countries/#{@solution[:iso_code]}"
 
               # Dependents
               @highrisk_special_prefixes = nil
@@ -243,10 +258,7 @@ module Twilio
             # @return [HighriskSpecialPrefixContext]
             def highrisk_special_prefixes
               unless @highrisk_special_prefixes
-                @highrisk_special_prefixes = HighriskSpecialPrefixList.new(
-                    @version,
-                    parent_iso_code: @solution[:iso_code],
-                )
+                @highrisk_special_prefixes = HighriskSpecialPrefixList.new(@version, iso_code: @solution[:iso_code], )
               end
 
               @highrisk_special_prefixes
@@ -256,7 +268,7 @@ module Twilio
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Permissions.CountryContext #{context}>"
+              "#<Twilio.Voice.V1.CountryContext #{context}>"
             end
           end
 
@@ -321,31 +333,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The list of country codes
+            # @return [String] The E.164 assigned country codes(s)
             def country_codes
               @properties['country_codes']
             end
 
             ##
-            # @return [Boolean] True, if low risk numbers are enabled, else false
+            # @return [Boolean] true, if dialing to low-risk numbers is enabled, else false
             def low_risk_numbers_enabled
               @properties['low_risk_numbers_enabled']
             end
 
             ##
-            # @return [Boolean] True, if high risk special numbers are enabled, else false
+            # @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
             def high_risk_special_numbers_enabled
               @properties['high_risk_special_numbers_enabled']
             end
 
             ##
-            # @return [Boolean] True, if high risk tollfraud numbers are enabled, else false
+            # @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
             def high_risk_tollfraud_numbers_enabled
               @properties['high_risk_tollfraud_numbers_enabled']
             end
 
             ##
-            # @return [String] The URL for this resource.
+            # @return [String] The URL for this resource
             def url
               @properties['url']
             end
@@ -374,14 +386,14 @@ module Twilio
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Permissions.CountryInstance #{values}>"
+              "<Twilio.Voice.V1.CountryInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Permissions.CountryInstance #{values}>"
+              "<Twilio.Voice.V1.CountryInstance #{values}>"
             end
           end
         end