twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -24,16 +26,38 @@ module Twilio
           ##
           # Retrieve a single page of RoomInstance records from the API.
           # Request is executed immediately.
-          # @param [Boolean] enable_turn The enable_turn
-          # @param [room.RoomType] type The type
-          # @param [String] unique_name The unique_name
-          # @param [String] status_callback The status_callback
-          # @param [String] status_callback_method The status_callback_method
-          # @param [String] max_participants The max_participants
-          # @param [Boolean] record_participants_on_connect The
-          #   record_participants_on_connect
-          # @param [room.VideoCodec] video_codecs The video_codecs
-          # @param [String] media_region The media_region
+          # @param [Boolean] enable_turn Deprecated. Whether to enable [Twilio's Network
+          #   Traversal TURN service](https://www.twilio.com/stun-turn). TURN service is used
+          #   when direct peer-to-peer media connections cannot be established due to firewall
+          #   restrictions. This setting only applies to rooms with type `peer-to-peer`.
+          # @param [room.RoomType] type The type of room. Can be: `peer-to-peer`,
+          #   `group-small`, or `group`. The default value is `group`.
+          # @param [String] unique_name An application-defined string that uniquely
+          #   identifies the resource. It can be used as a `room_sid` in place of the
+          #   resource's `sid` in the URL to address the resource. This value is unique for
+          #   `in-progress` rooms. SDK clients can use this name to connect to the room. REST
+          #   API clients can use this name in place of the Room SID to interact with the room
+          #   as long as the room is `in-progress`.
+          # @param [String] status_callback The URL we should call using the
+          #   `status_callback_method` to send status information to your application on every
+          #   room event. See [Status
+          #   Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more
+          #   info.
+          # @param [String] status_callback_method The HTTP method we should use to call
+          #   `status_callback`. Can be `POST` or `GET`.
+          # @param [String] max_participants The maximum number of concurrent Participants
+          #   allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small
+          #   Group rooms can have up to 4 Participants. Group rooms can have up to 50
+          #   Participants.
+          # @param [Boolean] record_participants_on_connect Whether to start recording when
+          #   Participants connect. ***This feature is not available in `peer-to-peer`
+          #   rooms.***
+          # @param [room.VideoCodec] video_codecs An array of the video codecs that are
+          #   supported when publishing a track in the room.  Can be: `VP8` and `H264`.
+          #   ***This feature is not available in `peer-to-peer` rooms***
+          # @param [String] media_region The region for the media server in Group Rooms.
+          #   Can be: one of the [available Media
+          #   Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***
           # @return [RoomInstance] Newly created RoomInstance
           def create(enable_turn: :unset, type: :unset, unique_name: :unset, status_callback: :unset, status_callback_method: :unset, max_participants: :unset, record_participants_on_connect: :unset, video_codecs: :unset, media_region: :unset)
             data = Twilio::Values.of({
@@ -54,17 +78,20 @@ module Twilio
                 data: data
             )
 
-            RoomInstance.new(@version, payload)
+            RoomInstance.new(@version, payload, )
           end
 
           ##
           # Lists RoomInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [room.RoomStatus] status The status
-          # @param [String] unique_name The unique_name
-          # @param [Time] date_created_after The date_created_after
-          # @param [Time] date_created_before The date_created_before
+          # @param [room.RoomStatus] status Read only the rooms with this status. Can be:
+          #   `in-progress` (default) or `completed`
+          # @param [String] unique_name Read only rooms with the this `unique_name`.
+          # @param [Time] date_created_after Read only rooms that started on or after this
+          #   date, given as `YYYY-MM-DD`.
+          # @param [Time] date_created_before Read only rooms that started before this date,
+          #   given as `YYYY-MM-DD`.
           # @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
@@ -87,10 +114,13 @@ module Twilio
           # Streams RoomInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [room.RoomStatus] status The status
-          # @param [String] unique_name The unique_name
-          # @param [Time] date_created_after The date_created_after
-          # @param [Time] date_created_before The date_created_before
+          # @param [room.RoomStatus] status Read only the rooms with this status. Can be:
+          #   `in-progress` (default) or `completed`
+          # @param [String] unique_name Read only rooms with the this `unique_name`.
+          # @param [Time] date_created_after Read only rooms that started on or after this
+          #   date, given as `YYYY-MM-DD`.
+          # @param [Time] date_created_before Read only rooms that started before this date,
+          #   given as `YYYY-MM-DD`.
           # @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
@@ -119,7 +149,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],
@@ -129,10 +159,13 @@ module Twilio
           ##
           # Retrieve a single page of RoomInstance records from the API.
           # Request is executed immediately.
-          # @param [room.RoomStatus] status The status
-          # @param [String] unique_name The unique_name
-          # @param [Time] date_created_after The date_created_after
-          # @param [Time] date_created_before The date_created_before
+          # @param [room.RoomStatus] status Read only the rooms with this status. Can be:
+          #   `in-progress` (default) or `completed`
+          # @param [String] unique_name Read only rooms with the this `unique_name`.
+          # @param [Time] date_created_after Read only rooms that started on or after this
+          #   date, given as `YYYY-MM-DD`.
+          # @param [Time] date_created_before Read only rooms that started before this date,
+          #   given as `YYYY-MM-DD`.
           # @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
@@ -194,7 +227,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [RoomInstance] RoomInstance
           def get_instance(payload)
-            RoomInstance.new(@version, payload)
+            RoomInstance.new(@version, payload, )
           end
 
           ##
@@ -208,13 +241,13 @@ module Twilio
           ##
           # Initialize the RoomContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Room resource to fetch.
           # @return [RoomContext] RoomContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Rooms/#{@solution[:sid]}"
 
             # Dependents
@@ -234,15 +267,16 @@ module Twilio
                 params,
             )
 
-            RoomInstance.new(@version, payload, sid: @solution[:sid])
+            RoomInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the RoomInstance
-          # @param [room.RoomStatus] status The status
+          # @param [room.RoomStatus] status The new status of the resource. Set to
+          #   `completed` to end the room.
           # @return [RoomInstance] Updated RoomInstance
           def update(status: nil)
-            data = Twilio::Values.of({'Status' => status})
+            data = Twilio::Values.of({'Status' => status, })
 
             payload = @version.update(
                 'POST',
@@ -250,7 +284,7 @@ module Twilio
                 data: data,
             )
 
-            RoomInstance.new(@version, payload, sid: @solution[:sid])
+            RoomInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
@@ -261,11 +295,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return RoomRecordingContext.new(@version, @solution[:sid], sid)
+              return RoomRecordingContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @recordings
-              @recordings = RoomRecordingList.new(@version, room_sid: @solution[:sid])
+              @recordings = RoomRecordingList.new(@version, room_sid: @solution[:sid], )
             end
 
             @recordings
@@ -279,11 +313,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return ParticipantContext.new(@version, @solution[:sid], sid)
+              return ParticipantContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @participants
-              @participants = ParticipantList.new(@version, room_sid: @solution[:sid])
+              @participants = ParticipantList.new(@version, room_sid: @solution[:sid], )
             end
 
             @participants
@@ -295,6 +329,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Video.V1.RoomContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Video.V1.RoomContext #{context}>"
+          end
         end
 
         class RoomInstance < InstanceResource
@@ -302,7 +343,7 @@ module Twilio
           # Initialize the RoomInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Room resource to fetch.
           # @return [RoomInstance] RoomInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -331,7 +372,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -340,115 +381,115 @@ module Twilio
           # @return [RoomContext] RoomContext for this RoomInstance
           def context
             unless @instance_context
-              @instance_context = RoomContext.new(@version, @params['sid'])
+              @instance_context = RoomContext.new(@version, @params['sid'], )
             end
             @instance_context
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [room.RoomStatus] The status
+          # @return [room.RoomStatus] The status of the room
           def status
             @properties['status']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] The SID of the Account that created the resource
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [Boolean] The enable_turn
+          # @return [Boolean] Enable Twilio's Network Traversal TURN service
           def enable_turn
             @properties['enable_turn']
           end
 
           ##
-          # @return [String] The unique_name
+          # @return [String] An application-defined string that uniquely identifies the resource
           def unique_name
             @properties['unique_name']
           end
 
           ##
-          # @return [String] The status_callback
+          # @return [String] The URL to send status information to your application
           def status_callback
             @properties['status_callback']
           end
 
           ##
-          # @return [String] The status_callback_method
+          # @return [String] The HTTP method we use to call status_callback
           def status_callback_method
             @properties['status_callback_method']
           end
 
           ##
-          # @return [Time] The end_time
+          # @return [Time] The UTC end time of the room in UTC ISO 8601 format
           def end_time
             @properties['end_time']
           end
 
           ##
-          # @return [String] The duration
+          # @return [String] The duration of the room in seconds
           def duration
             @properties['duration']
           end
 
           ##
-          # @return [room.RoomType] The type
+          # @return [room.RoomType] The type of room
           def type
             @properties['type']
           end
 
           ##
-          # @return [String] The max_participants
+          # @return [String] The maximum number of concurrent Participants allowed in the room
           def max_participants
             @properties['max_participants']
           end
 
           ##
-          # @return [Boolean] The record_participants_on_connect
+          # @return [Boolean] Whether to start recording when Participants connect
           def record_participants_on_connect
             @properties['record_participants_on_connect']
           end
 
           ##
-          # @return [room.VideoCodec] The video_codecs
+          # @return [room.VideoCodec] An array of the video codecs that are supported when publishing a track in the room
           def video_codecs
             @properties['video_codecs']
           end
 
           ##
-          # @return [String] The media_region
+          # @return [String] The region for the media server in Group Rooms
           def media_region
             @properties['media_region']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           end
@@ -462,10 +503,11 @@ module Twilio
 
           ##
           # Update the RoomInstance
-          # @param [room.RoomStatus] status The status
+          # @param [room.RoomStatus] status The new status of the resource. Set to
+          #   `completed` to end the room.
           # @return [RoomInstance] Updated RoomInstance
           def update(status: nil)
-            context.update(status: status)
+            context.update(status: status, )
           end
 
           ##

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,12 +15,50 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @compositions = nil
+          @composition_hooks = nil
+          @composition_settings = nil
           @recordings = nil
+          @recording_settings = nil
           @rooms = nil
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Composition resource 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 SID of the CompositionHook resource 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
+          @composition_settings ||= CompositionSettingsContext.new self
+        end
+
+        ##
+        # @param [String] sid The SID of the Recording resource to fetch.
         # @return [Twilio::REST::Video::V1::RecordingContext] if sid was passed.
         # @return [Twilio::REST::Video::V1::RecordingList]
         def recordings(sid=:unset)
@@ -32,7 +72,13 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @return [Twilio::REST::Video::V1::RecordingSettingsContext]
+        def recording_settings
+          @recording_settings ||= RecordingSettingsContext.new self
+        end
+
+        ##
+        # @param [String] sid The SID of the Room resource to fetch.
         # @return [Twilio::REST::Video::V1::RoomContext] if sid was passed.
         # @return [Twilio::REST::Video::V1::RoomList]
         def rooms(sid=:unset)

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,32 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the
+      #   Composition resource.
+      # @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 The unique string that we created to identify the
+      #   CompositionHook resource.
+      # @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
+        self.v1.composition_settings()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Recording
+      #   resource.
       # @return [Twilio::REST::Video::V1::RecordingInstance] if sid was passed.
       # @return [Twilio::REST::Video::V1::RecordingList]
       def recordings(sid=:unset)
@@ -35,7 +62,14 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @return [Twilio::REST::Video::V1::RecordingSettingsInstance]
+      def recording_settings
+        self.v1.recording_settings()
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Room
+      #   resource.
       # @return [Twilio::REST::Video::V1::RoomInstance] if sid was passed.
       # @return [Twilio::REST::Video::V1::RoomList]
       def rooms(sid=:unset)

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

@@ -0,0 +1,133 @@
+##
+# 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 BulkCountryUpdateList < ListResource
+            ##
+            # Initialize the BulkCountryUpdateList
+            # @param [Version] version Version that contains the resource
+            # @return [BulkCountryUpdateList] BulkCountryUpdateList
+            def initialize(version)
+              super(version)
+
+              # Path Solution
+              @solution = {}
+              @uri = "/DialingPermissions/BulkCountryUpdates"
+            end
+
+            ##
+            # Retrieve a single page of BulkCountryUpdateInstance records from the API.
+            # Request is executed immediately.
+            # @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, })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              BulkCountryUpdateInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Voice.V1.BulkCountryUpdateList>'
+            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 BulkCountryUpdatePage < Page
+            ##
+            # Initialize the BulkCountryUpdatePage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [BulkCountryUpdatePage] BulkCountryUpdatePage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of BulkCountryUpdateInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [BulkCountryUpdateInstance] BulkCountryUpdateInstance
+            def get_instance(payload)
+              BulkCountryUpdateInstance.new(@version, payload, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Voice.V1.BulkCountryUpdatePage>'
+            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 BulkCountryUpdateInstance < InstanceResource
+            ##
+            # Initialize the BulkCountryUpdateInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @return [BulkCountryUpdateInstance] BulkCountryUpdateInstance
+            def initialize(version, payload)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'update_count' => payload['update_count'].to_i,
+                  'update_request' => payload['update_request'],
+              }
+            end
+
+            ##
+            # @return [String] The number of countries updated
+            def update_count
+              @properties['update_count']
+            end
+
+            ##
+            # @return [String] A URL encoded JSON array of update objects
+            def update_request
+              @properties['update_request']
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              "<Twilio.Voice.V1.BulkCountryUpdateInstance>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              "<Twilio.Voice.V1.BulkCountryUpdateInstance>"
+            end
+          end
+        end
+      end
+    end
+  end
+end