daily-ruby 1.0.0 → 1.0.1

data/lib/daily-ruby/models/room_properties.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.1.1
 Contact: help@daily.co
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.3.0
+Generator version: 7.8.0
 
 =end
 
@@ -39,6 +39,9 @@ module Daily
     # Determines whether participants enter a waiting room with a camera, mic, and browser check before joining a call.  ⚠️ You must be using [Daily Prebuilt](https://daily.co/prebuilt) to use `enable_prejoin_ui`.
     attr_accessor :enable_prejoin_ui
 
+    # Sets whether participants in a room see a closed captions button in their Daily Prebuilt call tray. When the closed caption button is clicked, closed captions are displayed locally.  When set to `true`, a closed captions button appears in the call tray. When set to `false`, the closed captions button is hidden from the call tray.  Note: Transcription must be enabled for the room or users must have permission to start transcription for this feature to be enabled. View the [transcription guide](/guides/products/transcription) for more details.  ⚠️ You must be using [Daily Prebuilt](https://daily.co/blog/daily-prebuilt-video-chat) to use `enable_live_captions_ui`.
+    attr_accessor :enable_live_captions_ui
+
     # Determines whether the network button, and the network panel it reveals on click, appears in this room.  ⚠️ You must be using [Daily Prebuilt](https://daily.co/prebuilt) to use `enable_network_ui`.
     attr_accessor :enable_network_ui
 
@@ -60,6 +63,9 @@ module Daily
     # This property is one of [multiple ways to add chat to Daily video calls](https://www.daily.co/blog/three-ways-to-add-chat-to-your-video-calls-with-the-daily-api/).
     attr_accessor :enable_chat
 
+    # When enabled, newly joined participants in Prebuilt calls will request chat history from remote peers, in order to view chat messages from before they joined.
+    attr_accessor :enable_shared_chat_history
+
     # Disable the default behavior of automatically turning on a participant's camera on a direct `join()` (i.e. without `startCamera()` first).
     attr_accessor :start_video_off
 
@@ -87,16 +93,25 @@ module Daily
     # Configures a room to use multiple SFUs for a call's media. This feature enables calls to scale to large sizes and to reduce latency between participants. It is recommended specifically for interactive live streaming.  See our [guide for interactive live streaming](/guides/scaling-calls/interactive-live-streaming-rtmp-output#daily-prebuilt-configurations-to-support-100-000-participants) for additional instruction.
     attr_accessor :enable_mesh_sfu
 
-    # Dictates the participant count after which room topology automatically switches from Peer-to-Peer (P2P) to Selective Forwarding Unit (SFU) mode, or vice versa.  For example, if `sfu_switchover` is set to `3` and the current network topology is P2P, the topology will switch to SFU mode when the _fourth_ participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from `3` to `2`.  We recommend specifying an integer value for this property except for cases where you would like the room to switch to SFU mode as soon as the first participant joins. In this case, set `sfu_switchover` to `0.5`.  See our [guide about video call architecture](/guides/architecture-and-monitoring/intro-to-video-arch#the-architecture-of-a-room-p2p-vs-sfu-calls) for additional information.
+    # Dictates the participant count after which room topology automatically switches from Peer-to-Peer (P2P) to Selective Forwarding Unit (SFU) mode, or vice versa.  For example, if `sfu_switchover` is set to `2` and the current network topology is P2P, the topology will switch to SFU mode when the _third_ participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from `2` to `1`.  We recommend specifying an integer value for this property except for cases where you would like the room to switch to SFU mode as soon as the first participant joins. In this case, set `sfu_switchover` to `0.5`.  See our [guide about video call architecture](/guides/architecture-and-monitoring/intro-to-video-arch#the-architecture-of-a-room-p2p-vs-sfu-calls) for additional information.
     attr_accessor :sfu_switchover
 
+    # Configures a domain or room to use [Daily Adaptive Bitrate](/guides/building-additional-features/daily-adaptive-bitrate). When enabled, along with configuring the client to [`allowAdaptiveLayers`](/reference/daily-js/instance-methods/update-send-settings#sendsettings), the Daily client will continually adapt send settings to the current network conditions. `allowAdaptiveLayers` is `true` by default; if you haven't modified that setting, then setting `enable_adaptive_simulcast` to `true` will enable Daily Adaptive Bitrate for 1:1 calls.
+    attr_accessor :enable_adaptive_simulcast
+
+    # Configures a domain or room to use [Daily Adaptive Bitrate](/guides/building-additional-features/daily-adaptive-bitrate). When enabled, along with configuring the client to [`allowAdaptiveLayers`](/reference/daily-js/instance-methods/update-send-settings#sendsettings), the Daily client will continually adapt send settings to the current network conditions. `allowAdaptiveLayers` is `true` by default; if you haven't modified that setting, then setting `enable_multiparty_adaptive_simulcast` to `true` will enable Daily Adaptive Bitrate for multi-party calls. To use this feature, `enable_adaptive_simulcast` must also be set to `true`.
+    attr_accessor :enable_multiparty_adaptive_simulcast
+
+    # Configures a domain or room to disallow multiple participants from having the same `user_id`. This feature can be enabled to prevent users from \"sharing\" meeting tokens. When enabled, a participant joining or reconnecting to a meeting will cause existing participants with the same user_id to be ejected.
+    attr_accessor :enforce_unique_user_ids
+
     # Enables Daily Prebuilt to support group calls of up to 1,000 participants and [owner only broadcast](/reference/rest-api/rooms/config#owner_only_broadcast) calls of up to 100K participants.  When set to true, Daily Prebuilt will: - Automatically mute the local user on joining - Update grid view to show a maximum of 12 users in the grid at a time - Allow only 16 users to be unmuted at the same time. When more than 16 users are unmuted, the oldest active speaker will be automatically muted.  See our [guide on large real-time calls](/guides/scaling-calls/large-real-time-calls) for additional instruction.  ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.
     attr_accessor :experimental_optimize_large_calls
 
     # The default language of the [Daily prebuilt video call UI](/guides/products/prebuilt#daily-prebuilt-ui), for this room.  Setting the language at the room level will override any domain-level language settings you have.  Read more about [changing prebuilt UI language settings](https://help.daily.co/en/articles/4579930-changing-the-language-setting-of-the-prebuilt-ui).  `*` Norwegian `\"no\"` and Russian `\"ru\"` are only available in the new Daily Prebuilt.
     attr_accessor :lang
 
-    # Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255.  More resources: - [Configuring a webhook to send notifications when someone joins your video calls](https://www.daily.co/blog/configure-a-webhook-to-send-notifications-when-someone-joins-your-video-calls/)
+    # Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255.  ⚠️ In place of the `meeting_join_hook`, we recommend setting up a [webhook](/reference/rest-api/webhooks) and listening for the [`participant.joined`](/reference/rest-api/webhooks/events/participant-joined) event.
     attr_accessor :meeting_join_hook
 
     # Daily uses signaling servers to manage all of the participants in a given call session. In an SFU/server mode call, the server will send and receive all audio and video from each participant. In a peer-to-peer call, each participant sends media directly to and from each other peer, but a signaling server still manages call state.  Daily runs servers in several different AWS regions to minimize latency for users around the world. The job of 'picking' a call server is handled when the first participant joins a room. The first participant's browser connects to a call server using Amazon's Route 53 DNS resolution, which chooses a server in the region closest to them.  This isn't always optimal. For example, if one person joins in London, and then ten more people join from Cape Town, the call will still be hosted out of `eu-west-2` . The majority of the participants will have higher latency to the server than if one of them had joined first and the call was being hosted in `af-south-1`. In cases like this, you may want to configure your domain (or a specific room) to always choose a call server in a specific AWS region.  Available regions: - `\"af-south-1\"` (Cape Town) - `\"ap-northeast-2\"` (Seoul) - `\"ap-southeast-1\"` (Singapore) - `\"ap-southeast-2\"` (Sydney) - `\"ap-south-1\"` (Mumbai) - `\"eu-central-1\"` (Frankfurt) - `\"eu-west-2\"` (London) - `\"sa-east-1\"` (São Paulo) - `\"us-east-1\"` (N. Virginia) - `\"us-west-2\"` (Oregon)
@@ -162,6 +177,7 @@ module Daily
         :'enable_emoji_reactions' => :'enable_emoji_reactions',
         :'enable_hand_raising' => :'enable_hand_raising',
         :'enable_prejoin_ui' => :'enable_prejoin_ui',
+        :'enable_live_captions_ui' => :'enable_live_captions_ui',
         :'enable_network_ui' => :'enable_network_ui',
         :'enable_noise_cancellation_ui' => :'enable_noise_cancellation_ui',
         :'enable_breakout_rooms' => :'enable_breakout_rooms',
@@ -169,6 +185,7 @@ module Daily
         :'enable_screenshare' => :'enable_screenshare',
         :'enable_video_processing_ui' => :'enable_video_processing_ui',
         :'enable_chat' => :'enable_chat',
+        :'enable_shared_chat_history' => :'enable_shared_chat_history',
         :'start_video_off' => :'start_video_off',
         :'start_audio_off' => :'start_audio_off',
         :'owner_only_broadcast' => :'owner_only_broadcast',
@@ -179,6 +196,9 @@ module Daily
         :'enable_hidden_participants' => :'enable_hidden_participants',
         :'enable_mesh_sfu' => :'enable_mesh_sfu',
         :'sfu_switchover' => :'sfu_switchover',
+        :'enable_adaptive_simulcast' => :'enable_adaptive_simulcast',
+        :'enable_multiparty_adaptive_simulcast' => :'enable_multiparty_adaptive_simulcast',
+        :'enforce_unique_user_ids' => :'enforce_unique_user_ids',
         :'experimental_optimize_large_calls' => :'experimental_optimize_large_calls',
         :'lang' => :'lang',
         :'meeting_join_hook' => :'meeting_join_hook',
@@ -212,6 +232,7 @@ module Daily
         :'enable_emoji_reactions' => :'Boolean',
         :'enable_hand_raising' => :'Boolean',
         :'enable_prejoin_ui' => :'Boolean',
+        :'enable_live_captions_ui' => :'Boolean',
         :'enable_network_ui' => :'Boolean',
         :'enable_noise_cancellation_ui' => :'Boolean',
         :'enable_breakout_rooms' => :'Boolean',
@@ -219,6 +240,7 @@ module Daily
         :'enable_screenshare' => :'Boolean',
         :'enable_video_processing_ui' => :'Boolean',
         :'enable_chat' => :'Boolean',
+        :'enable_shared_chat_history' => :'Boolean',
         :'start_video_off' => :'Boolean',
         :'start_audio_off' => :'Boolean',
         :'owner_only_broadcast' => :'Boolean',
@@ -229,6 +251,9 @@ module Daily
         :'enable_hidden_participants' => :'Boolean',
         :'enable_mesh_sfu' => :'Boolean',
         :'sfu_switchover' => :'Float',
+        :'enable_adaptive_simulcast' => :'Boolean',
+        :'enable_multiparty_adaptive_simulcast' => :'Boolean',
+        :'enforce_unique_user_ids' => :'Boolean',
         :'experimental_optimize_large_calls' => :'Boolean',
         :'lang' => :'String',
         :'meeting_join_hook' => :'String',
@@ -301,6 +326,10 @@ module Daily
         self.enable_prejoin_ui = attributes[:'enable_prejoin_ui']
       end
 
+      if attributes.key?(:'enable_live_captions_ui')
+        self.enable_live_captions_ui = attributes[:'enable_live_captions_ui']
+      end
+
       if attributes.key?(:'enable_network_ui')
         self.enable_network_ui = attributes[:'enable_network_ui']
       end
@@ -335,6 +364,12 @@ module Daily
         self.enable_chat = false
       end
 
+      if attributes.key?(:'enable_shared_chat_history')
+        self.enable_shared_chat_history = attributes[:'enable_shared_chat_history']
+      else
+        self.enable_shared_chat_history = true
+      end
+
       if attributes.key?(:'start_video_off')
         self.start_video_off = attributes[:'start_video_off']
       else
@@ -388,7 +423,25 @@ module Daily
       if attributes.key?(:'sfu_switchover')
         self.sfu_switchover = attributes[:'sfu_switchover']
       else
-        self.sfu_switchover = 2
+        self.sfu_switchover = 0.5
+      end
+
+      if attributes.key?(:'enable_adaptive_simulcast')
+        self.enable_adaptive_simulcast = attributes[:'enable_adaptive_simulcast']
+      else
+        self.enable_adaptive_simulcast = true
+      end
+
+      if attributes.key?(:'enable_multiparty_adaptive_simulcast')
+        self.enable_multiparty_adaptive_simulcast = attributes[:'enable_multiparty_adaptive_simulcast']
+      else
+        self.enable_multiparty_adaptive_simulcast = false
+      end
+
+      if attributes.key?(:'enforce_unique_user_ids')
+        self.enforce_unique_user_ids = attributes[:'enforce_unique_user_ids']
+      else
+        self.enforce_unique_user_ids = false
       end
 
       if attributes.key?(:'experimental_optimize_large_calls')
@@ -476,9 +529,9 @@ module Daily
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      enable_recording_validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>"])
+      enable_recording_validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>", "unknown_default_open_api"])
       return false unless enable_recording_validator.valid?(@enable_recording)
-      lang_validator = EnumAttributeValidator.new('String', ["de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user"])
+      lang_validator = EnumAttributeValidator.new('String', ["da", "de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user", "unknown_default_open_api"])
       return false unless lang_validator.valid?(@lang)
       true
     end
@@ -486,7 +539,7 @@ module Daily
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] enable_recording Object to be assigned
     def enable_recording=(enable_recording)
-      validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>"])
+      validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>", "unknown_default_open_api"])
       unless validator.valid?(enable_recording)
         fail ArgumentError, "invalid value for \"enable_recording\", must be one of #{validator.allowable_values}."
       end
@@ -496,7 +549,7 @@ module Daily
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] lang Object to be assigned
     def lang=(lang)
-      validator = EnumAttributeValidator.new('String', ["de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user"])
+      validator = EnumAttributeValidator.new('String', ["da", "de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user", "unknown_default_open_api"])
       unless validator.valid?(lang)
         fail ArgumentError, "invalid value for \"lang\", must be one of #{validator.allowable_values}."
       end
@@ -516,6 +569,7 @@ module Daily
           enable_emoji_reactions == o.enable_emoji_reactions &&
           enable_hand_raising == o.enable_hand_raising &&
           enable_prejoin_ui == o.enable_prejoin_ui &&
+          enable_live_captions_ui == o.enable_live_captions_ui &&
           enable_network_ui == o.enable_network_ui &&
           enable_noise_cancellation_ui == o.enable_noise_cancellation_ui &&
           enable_breakout_rooms == o.enable_breakout_rooms &&
@@ -523,6 +577,7 @@ module Daily
           enable_screenshare == o.enable_screenshare &&
           enable_video_processing_ui == o.enable_video_processing_ui &&
           enable_chat == o.enable_chat &&
+          enable_shared_chat_history == o.enable_shared_chat_history &&
           start_video_off == o.start_video_off &&
           start_audio_off == o.start_audio_off &&
           owner_only_broadcast == o.owner_only_broadcast &&
@@ -533,6 +588,9 @@ module Daily
           enable_hidden_participants == o.enable_hidden_participants &&
           enable_mesh_sfu == o.enable_mesh_sfu &&
           sfu_switchover == o.sfu_switchover &&
+          enable_adaptive_simulcast == o.enable_adaptive_simulcast &&
+          enable_multiparty_adaptive_simulcast == o.enable_multiparty_adaptive_simulcast &&
+          enforce_unique_user_ids == o.enforce_unique_user_ids &&
           experimental_optimize_large_calls == o.experimental_optimize_large_calls &&
           lang == o.lang &&
           meeting_join_hook == o.meeting_join_hook &&
@@ -558,7 +616,7 @@ module Daily
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [nbf, exp, max_participants, enable_people_ui, enable_pip_ui, enable_emoji_reactions, enable_hand_raising, enable_prejoin_ui, enable_network_ui, enable_noise_cancellation_ui, enable_breakout_rooms, enable_knocking, enable_screenshare, enable_video_processing_ui, enable_chat, start_video_off, start_audio_off, owner_only_broadcast, enable_recording, eject_at_room_exp, eject_after_elapsed, enable_advanced_chat, enable_hidden_participants, enable_mesh_sfu, sfu_switchover, experimental_optimize_large_calls, lang, meeting_join_hook, geo, rtmp_geo, disable_rtmp_geo_fallback, recordings_bucket, enable_terse_logging, auto_transcription_settings, enable_transcription_storage, transcription_bucket, recordings_template, streaming_endpoints, permissions].hash
+      [nbf, exp, max_participants, enable_people_ui, enable_pip_ui, enable_emoji_reactions, enable_hand_raising, enable_prejoin_ui, enable_live_captions_ui, enable_network_ui, enable_noise_cancellation_ui, enable_breakout_rooms, enable_knocking, enable_screenshare, enable_video_processing_ui, enable_chat, enable_shared_chat_history, start_video_off, start_audio_off, owner_only_broadcast, enable_recording, eject_at_room_exp, eject_after_elapsed, enable_advanced_chat, enable_hidden_participants, enable_mesh_sfu, sfu_switchover, enable_adaptive_simulcast, enable_multiparty_adaptive_simulcast, enforce_unique_user_ids, experimental_optimize_large_calls, lang, meeting_join_hook, geo, rtmp_geo, disable_rtmp_geo_fallback, recordings_bucket, enable_terse_logging, auto_transcription_settings, enable_transcription_storage, transcription_bucket, recordings_template, streaming_endpoints, permissions].hash
     end
 
     # Builds the object from hash