twilio-ruby 5.48.0 → 5.66.2

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

@@ -29,11 +29,15 @@ module Twilio
           # 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 [Array[room.RoomType]] room_type The room_type
-          # @param [Array[room.Codec]] codec The codec
-          # @param [String] room_name The room_name
-          # @param [Time] created_after The created_after
-          # @param [Time] created_before The created_before
+          # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
+          #   `peer_to_peer`, `group`, or `group_small`.
+          # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
+          #   `VP8`, `H264`, or `VP9`.
+          # @param [String] room_name Room friendly name.
+          # @param [Time] created_after Only read rooms that started on or after this ISO
+          #   8601 timestamp.
+          # @param [Time] created_before Only read rooms that started before this ISO 8601
+          #   timestamp.
           # @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
@@ -57,11 +61,15 @@ 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 [Array[room.RoomType]] room_type The room_type
-          # @param [Array[room.Codec]] codec The codec
-          # @param [String] room_name The room_name
-          # @param [Time] created_after The created_after
-          # @param [Time] created_before The created_before
+          # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
+          #   `peer_to_peer`, `group`, or `group_small`.
+          # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
+          #   `VP8`, `H264`, or `VP9`.
+          # @param [String] room_name Room friendly name.
+          # @param [Time] created_after Only read rooms that started on or after this ISO
+          #   8601 timestamp.
+          # @param [Time] created_before Only read rooms that started before this ISO 8601
+          #   timestamp.
           # @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
@@ -101,11 +109,15 @@ module Twilio
           ##
           # Retrieve a single page of RoomInstance records from the API.
           # Request is executed immediately.
-          # @param [Array[room.RoomType]] room_type The room_type
-          # @param [Array[room.Codec]] codec The codec
-          # @param [String] room_name The room_name
-          # @param [Time] created_after The created_after
-          # @param [Time] created_before The created_before
+          # @param [Array[room.RoomType]] room_type Type of room. Can be `go`,
+          #   `peer_to_peer`, `group`, or `group_small`.
+          # @param [Array[room.Codec]] codec Codecs used by participants in the room. Can be
+          #   `VP8`, `H264`, or `VP9`.
+          # @param [String] room_name Room friendly name.
+          # @param [Time] created_after Only read rooms that started on or after this ISO
+          #   8601 timestamp.
+          # @param [Time] created_before Only read rooms that started before this ISO 8601
+          #   timestamp.
           # @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
@@ -184,7 +196,7 @@ module Twilio
           ##
           # Initialize the RoomContext
           # @param [Version] version Version that contains the resource
-          # @param [String] room_sid The room_sid
+          # @param [String] room_sid The SID of the Room resource.
           # @return [RoomContext] RoomContext
           def initialize(version, room_sid)
             super(version)
@@ -246,7 +258,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] room_sid The room_sid
+          # @param [String] room_sid The SID of the Room resource.
           # @return [RoomInstance] RoomInstance
           def initialize(version, payload, room_sid: nil)
             super(version)
@@ -298,157 +310,157 @@ module Twilio
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] Account SID associated with this room.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The room_sid
+          # @return [String] Unique identifier for the room.
           def room_sid
             @properties['room_sid']
           end
 
           ##
-          # @return [String] The room_name
+          # @return [String] room friendly name.
           def room_name
             @properties['room_name']
           end
 
           ##
-          # @return [Time] The create_time
+          # @return [Time] Creation time of the room.
           def create_time
             @properties['create_time']
           end
 
           ##
-          # @return [Time] The end_time
+          # @return [Time] End time for the room.
           def end_time
             @properties['end_time']
           end
 
           ##
-          # @return [room.RoomType] The room_type
+          # @return [room.RoomType] Type of room.
           def room_type
             @properties['room_type']
           end
 
           ##
-          # @return [room.RoomStatus] The room_status
+          # @return [room.RoomStatus] Status of the room.
           def room_status
             @properties['room_status']
           end
 
           ##
-          # @return [String] The status_callback
+          # @return [String] Webhook provided for status callbacks.
           def status_callback
             @properties['status_callback']
           end
 
           ##
-          # @return [String] The status_callback_method
+          # @return [String] HTTP method provided for status callback URL.
           def status_callback_method
             @properties['status_callback_method']
           end
 
           ##
-          # @return [room.CreatedMethod] The created_method
+          # @return [room.CreatedMethod] How the room was created.
           def created_method
             @properties['created_method']
           end
 
           ##
-          # @return [room.EndReason] The end_reason
+          # @return [room.EndReason] Reason the room ended.
           def end_reason
             @properties['end_reason']
           end
 
           ##
-          # @return [String] The max_participants
+          # @return [String] Max number of total participants allowed by the application settings.
           def max_participants
             @properties['max_participants']
           end
 
           ##
-          # @return [String] The unique_participants
+          # @return [String] Number of participants. May include duplicate identities for participants who left and rejoined.
           def unique_participants
             @properties['unique_participants']
           end
 
           ##
-          # @return [String] The unique_participant_identities
+          # @return [String] Unique number of participant identities.
           def unique_participant_identities
             @properties['unique_participant_identities']
           end
 
           ##
-          # @return [String] The concurrent_participants
+          # @return [String] Actual number of concurrent participants.
           def concurrent_participants
             @properties['concurrent_participants']
           end
 
           ##
-          # @return [String] The max_concurrent_participants
+          # @return [String] Maximum number of participants allowed in the room at the same time allowed by the application settings.
           def max_concurrent_participants
             @properties['max_concurrent_participants']
           end
 
           ##
-          # @return [Array[room.Codec]] The codecs
+          # @return [Array[room.Codec]] Codecs used by participants in the room.
           def codecs
             @properties['codecs']
           end
 
           ##
-          # @return [room.TwilioRealm] The media_region
+          # @return [room.TwilioRealm] Region of Twilio media servers for the room.
           def media_region
             @properties['media_region']
           end
 
           ##
-          # @return [String] The duration_sec
+          # @return [String] Total room duration from create time to end time.
           def duration_sec
             @properties['duration_sec']
           end
 
           ##
-          # @return [String] The total_participant_duration_sec
+          # @return [String] Combined amount of participant time in the room.
           def total_participant_duration_sec
             @properties['total_participant_duration_sec']
           end
 
           ##
-          # @return [String] The total_recording_duration_sec
+          # @return [String] Combined amount of recorded seconds for participants in the room.
           def total_recording_duration_sec
             @properties['total_recording_duration_sec']
           end
 
           ##
-          # @return [room.ProcessingState] The processing_state
+          # @return [room.ProcessingState] Video Log Analyzer resource state. Will be either `in-progress` or `complete`.
           def processing_state
             @properties['processing_state']
           end
 
           ##
-          # @return [Boolean] The recording_enabled
+          # @return [Boolean] Boolean indicating if recording is enabled for the room.
           def recording_enabled
             @properties['recording_enabled']
           end
 
           ##
-          # @return [room.EdgeLocation] The edge_location
+          # @return [room.EdgeLocation] Edge location of Twilio media servers for the room.
           def edge_location
             @properties['edge_location']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] URL for the room resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Room subresources.
           def links
             @properties['links']
           end

data/lib/twilio-ruby/rest/insights/v1/setting.rb

@@ -0,0 +1,215 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Insights < Domain
+      class V1 < Version
+        class SettingList < ListResource
+          ##
+          # Initialize the SettingList
+          # @param [Version] version Version that contains the resource
+          # @return [SettingList] SettingList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Insights.V1.SettingList>'
+          end
+        end
+
+        class SettingPage < Page
+          ##
+          # Initialize the SettingPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [SettingPage] SettingPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of SettingInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [SettingInstance] SettingInstance
+          def get_instance(payload)
+            SettingInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Insights.V1.SettingPage>'
+          end
+        end
+
+        class SettingContext < InstanceContext
+          ##
+          # Initialize the SettingContext
+          # @param [Version] version Version that contains the resource
+          # @return [SettingContext] SettingContext
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Voice/Settings"
+          end
+
+          ##
+          # Fetch the SettingInstance
+          # @param [String] subaccount_sid The subaccount_sid
+          # @return [SettingInstance] Fetched SettingInstance
+          def fetch(subaccount_sid: :unset)
+            params = Twilio::Values.of({'SubaccountSid' => subaccount_sid, })
+
+            payload = @version.fetch('GET', @uri, params: params)
+
+            SettingInstance.new(@version, payload, )
+          end
+
+          ##
+          # Update the SettingInstance
+          # @param [Boolean] advanced_features The advanced_features
+          # @param [Boolean] voice_trace The voice_trace
+          # @param [String] subaccount_sid The subaccount_sid
+          # @return [SettingInstance] Updated SettingInstance
+          def update(advanced_features: :unset, voice_trace: :unset, subaccount_sid: :unset)
+            data = Twilio::Values.of({
+                'AdvancedFeatures' => advanced_features,
+                'VoiceTrace' => voice_trace,
+                'SubaccountSid' => subaccount_sid,
+            })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            SettingInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Insights.V1.SettingContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Insights.V1.SettingContext #{context}>"
+          end
+        end
+
+        class SettingInstance < InstanceResource
+          ##
+          # Initialize the SettingInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @return [SettingInstance] SettingInstance
+          def initialize(version, payload)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'advanced_features' => payload['advanced_features'],
+                'voice_trace' => payload['voice_trace'],
+                '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 [SettingContext] SettingContext for this SettingInstance
+          def context
+            unless @instance_context
+              @instance_context = SettingContext.new(@version, )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The account_sid
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [Boolean] The advanced_features
+          def advanced_features
+            @properties['advanced_features']
+          end
+
+          ##
+          # @return [Boolean] The voice_trace
+          def voice_trace
+            @properties['voice_trace']
+          end
+
+          ##
+          # @return [String] The url
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the SettingInstance
+          # @param [String] subaccount_sid The subaccount_sid
+          # @return [SettingInstance] Fetched SettingInstance
+          def fetch(subaccount_sid: :unset)
+            context.fetch(subaccount_sid: subaccount_sid, )
+          end
+
+          ##
+          # Update the SettingInstance
+          # @param [Boolean] advanced_features The advanced_features
+          # @param [Boolean] voice_trace The voice_trace
+          # @param [String] subaccount_sid The subaccount_sid
+          # @return [SettingInstance] Updated SettingInstance
+          def update(advanced_features: :unset, voice_trace: :unset, subaccount_sid: :unset)
+            context.update(
+                advanced_features: advanced_features,
+                voice_trace: voice_trace,
+                subaccount_sid: subaccount_sid,
+            )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Insights.V1.SettingInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Insights.V1.SettingInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -15,35 +15,83 @@ module Twilio
         def initialize(domain)
           super
           @version = 'v1'
+          @settings = nil
+          @annotation = nil
           @calls = nil
+          @call_summaries = nil
+          @conferences = nil
           @rooms = nil
         end
 
+        ##
+        # @return [Twilio::REST::Insights::V1::SettingContext]
+        def settings
+          @settings ||= SettingContext.new self
+        end
+
+        ##
+        # @param [String] call_sid The call_sid
+        # @return [Twilio::REST::Insights::V1::AnnotationContext] if call_sid was passed.
+        # @return [Twilio::REST::Insights::V1::AnnotationList]
+        def annotation(call_sid=:unset)
+          if call_sid.nil?
+              raise ArgumentError, 'call_sid cannot be nil'
+          end
+          if call_sid == :unset
+              @annotation ||= AnnotationList.new self
+          else
+              AnnotationContext.new(self, call_sid)
+          end
+        end
+
         ##
         # @param [String] sid The sid
         # @return [Twilio::REST::Insights::V1::CallContext] if sid was passed.
         # @return [Twilio::REST::Insights::V1::CallList]
         def calls(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @calls ||= CallList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @calls ||= CallList.new self
           else
-            CallContext.new(self, sid)
+              CallContext.new(self, sid)
           end
         end
 
         ##
-        # @param [String] room_sid The room_sid
+        # @return [Twilio::REST::Insights::V1::CallSummariesContext]
+        def call_summaries
+          @call_summaries ||= CallSummariesList.new self
+        end
+
+        ##
+        # @param [String] conference_sid The unique SID identifier of the Conference.
+        # @return [Twilio::REST::Insights::V1::ConferenceContext] if conference_sid was passed.
+        # @return [Twilio::REST::Insights::V1::ConferenceList]
+        def conferences(conference_sid=:unset)
+          if conference_sid.nil?
+              raise ArgumentError, 'conference_sid cannot be nil'
+          end
+          if conference_sid == :unset
+              @conferences ||= ConferenceList.new self
+          else
+              ConferenceContext.new(self, conference_sid)
+          end
+        end
+
+        ##
+        # @param [String] room_sid The SID of the Room resource.
         # @return [Twilio::REST::Insights::V1::RoomContext] if room_sid was passed.
         # @return [Twilio::REST::Insights::V1::RoomList]
         def rooms(room_sid=:unset)
           if room_sid.nil?
-            raise ArgumentError, 'room_sid cannot be nil'
-          elsif room_sid == :unset
-            @rooms ||= RoomList.new self
+              raise ArgumentError, 'room_sid cannot be nil'
+          end
+          if room_sid == :unset
+              @rooms ||= RoomList.new self
           else
-            RoomContext.new(self, room_sid)
+              RoomContext.new(self, room_sid)
           end
         end
 

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

@@ -28,6 +28,20 @@ module Twilio
         @v1 ||= V1.new self
       end
 
+      ##
+      # @return [Twilio::REST::Insights::V1::SettingInstance]
+      def settings
+        self.v1.settings()
+      end
+
+      ##
+      # @param [String] call_sid The call_sid
+      # @return [Twilio::REST::Insights::V1::AnnotationInstance] if call_sid was passed.
+      # @return [Twilio::REST::Insights::V1::AnnotationList]
+      def annotation(call_sid=:unset)
+        self.v1.annotation(call_sid)
+      end
+
       ##
       # @param [String] sid The sid
       # @return [Twilio::REST::Insights::V1::CallInstance] if sid was passed.
@@ -37,7 +51,21 @@ module Twilio
       end
 
       ##
-      # @param [String] room_sid The room_sid
+      # @return [Twilio::REST::Insights::V1::CallSummariesInstance]
+      def call_summaries
+        self.v1.call_summaries()
+      end
+
+      ##
+      # @param [String] conference_sid The unique SID identifier of the Conference.
+      # @return [Twilio::REST::Insights::V1::ConferenceInstance] if conference_sid was passed.
+      # @return [Twilio::REST::Insights::V1::ConferenceList]
+      def conferences(conference_sid=:unset)
+        self.v1.conferences(conference_sid)
+      end
+
+      ##
+      # @param [String] room_sid Unique identifier for the room.
       # @return [Twilio::REST::Insights::V1::RoomInstance] if room_sid was passed.
       # @return [Twilio::REST::Insights::V1::RoomList]
       def rooms(room_sid=:unset)

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

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V1::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V1::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/ip_messaging/v2.rb

@@ -25,11 +25,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V2::CredentialList]
         def credentials(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @credentials ||= CredentialList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @credentials ||= CredentialList.new self
           else
-            CredentialContext.new(self, sid)
+              CredentialContext.new(self, sid)
           end
         end
 
@@ -39,11 +40,12 @@ module Twilio
         # @return [Twilio::REST::Ip_messaging::V2::ServiceList]
         def services(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @services ||= ServiceList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @services ||= ServiceList.new self
           else
-            ServiceContext.new(self, sid)
+              ServiceContext.new(self, sid)
           end
         end