daily-ruby 0.0.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/Gemfile.lock +13 -12
- data/README.md +203 -40
- data/daily-ruby.gemspec +4 -4
- data/docs/BatchRoomCreateRequest.md +18 -0
- data/docs/BatchRoomCreateRequestRoomsInner.md +22 -0
- data/docs/BatchRoomDelete200Response.md +18 -0
- data/docs/BatchRoomsApi.md +150 -0
- data/docs/CreateMeetingToken200Response.md +1 -1
- data/docs/CreateMeetingTokenRequest.md +18 -0
- data/docs/CreateRoom200Response.md +30 -0
- data/docs/{RoomRequest.md → CreateRoomRequest.md} +3 -3
- data/docs/DailyLiveStreamingOptions.md +40 -0
- data/docs/DailyLiveStreamingOptionsRtmpUrl.md +49 -0
- data/docs/DailyStreamingActiveParticipantLayoutConfig.md +18 -0
- data/docs/DailyStreamingCustomLayoutConfig.md +24 -0
- data/docs/DailyStreamingCustomLayoutConfigCompositionParams.md +15 -0
- data/docs/DailyStreamingDefaultLayoutConfig.md +20 -0
- data/docs/{ServerErrorResponse.md → DailyStreamingEndpoint.md} +4 -4
- data/docs/DailyStreamingLayoutConfig.md +69 -0
- data/docs/DailyStreamingOptions.md +36 -0
- data/docs/DailyStreamingPortraitLayoutConfig.md +22 -0
- data/docs/DailyStreamingPortraitLayoutVariant.md +15 -0
- data/docs/DailyStreamingSingleParticipantLayoutConfig.md +20 -0
- data/docs/DeleteTranscript200Response.md +30 -0
- data/docs/Domain.md +18 -0
- data/docs/DomainApi.md +149 -0
- data/docs/DomainProperties.md +74 -0
- data/docs/Eject200Response.md +18 -0
- data/docs/EjectRequest.md +18 -0
- data/docs/GetDomainConfig200Response.md +22 -0
- data/docs/GetDomainConfig200ResponseConfig.md +54 -0
- data/docs/GetDomainConfig200ResponseConfigRecordingsBucket.md +20 -0
- data/docs/GetMeetingInfo200Response.md +20 -0
- data/docs/GetMeetingInfo200ResponseDataInner.md +28 -0
- data/docs/GetMeetingInfo200ResponseDataInnerParticipantsInner.md +26 -0
- data/docs/GetPresence200Response.md +18 -0
- data/docs/GetPresence200ResponseAIVWWhzHlLHrSdHdw7EWInner.md +28 -0
- data/docs/GetRecordingInfo200Response.md +36 -0
- data/docs/GetRecordingInfo200ResponseTracksInner.md +22 -0
- data/docs/GetRecordingLink200Response.md +20 -0
- data/docs/GetTranscriptInfo200Response.md +32 -0
- data/docs/GetTranscriptInfo200ResponseOutParams.md +22 -0
- data/docs/GetTranscriptLink200Response.md +22 -0
- data/docs/ListAPILogs200Response.md +38 -0
- data/docs/ListRecordings200Response.md +20 -0
- data/docs/ListRecordings200ResponseDataInner.md +30 -0
- data/docs/ListRooms200Response.md +20 -0
- data/docs/ListRooms200ResponseDataInner.md +30 -0
- data/docs/ListRooms200ResponseDataInnerConfig.md +18 -0
- data/docs/ListTranscript200Response.md +20 -0
- data/docs/ListTranscript200ResponseDataInner.md +28 -0
- data/docs/LogsApi.md +177 -0
- data/docs/MeetingParticipantsGetRes.md +20 -0
- data/docs/MeetingParticipantsGetResDataInner.md +28 -0
- data/docs/MeetingTokensApi.md +88 -10
- data/docs/MeetingsApi.md +247 -0
- data/docs/MeetingsMeetingGetRes.md +28 -0
- data/docs/Permissions.md +22 -0
- data/docs/{MeetingTokenRequestPropertiesPermissionsCanSend.md → PermissionsCanAdmin.md} +4 -4
- data/docs/{MeetingTokenRequestPropertiesPermissionsCanAdmin.md → PermissionsCanSend.md} +4 -4
- data/docs/PostWebhook.md +22 -0
- data/docs/PresenceApi.md +74 -0
- data/docs/Properties.md +60 -0
- data/docs/RecordingError.md +24 -0
- data/docs/RecordingErrorPayload.md +26 -0
- data/docs/RecordingReadyToDownload.md +24 -0
- data/docs/RecordingReadyToDownloadPayload.md +34 -0
- data/docs/RecordingStarted.md +24 -0
- data/docs/RecordingStartedPayload.md +28 -0
- data/docs/RecordingStreamingOptions.md +38 -0
- data/docs/RecordingsApi.md +303 -0
- data/docs/RecordingsBucket.md +26 -0
- data/docs/RoomProperties.md +94 -0
- data/docs/RoomPropertiesStreamingEndpointsInner.md +28 -0
- data/docs/RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner.md +26 -0
- data/docs/RoomsApi.md +1418 -0
- data/docs/RoomsRoomNameGetRes.md +30 -0
- data/docs/RoomsRoomNamePresenceGetRes.md +20 -0
- data/docs/RoomsRoomNamePresenceGetResDataInner.md +28 -0
- data/docs/SendAppMessageRequest.md +20 -0
- data/docs/SetRoomConfigRequest.md +20 -0
- data/docs/SetSessionDataRequest.md +22 -0
- data/docs/StreamingEnded.md +24 -0
- data/docs/StreamingEndedPayload.md +22 -0
- data/docs/StreamingError.md +24 -0
- data/docs/StreamingErrorPayload.md +26 -0
- data/docs/StreamingStarted.md +24 -0
- data/docs/StreamingStartedPayload.md +24 -0
- data/docs/StreamingUpdated.md +24 -0
- data/docs/StreamingUpdatedPayload.md +24 -0
- data/docs/TranscriptApi.md +305 -0
- data/docs/TranscriptionBucket.md +24 -0
- data/docs/TranscriptionProperties.md +32 -0
- data/docs/TranscriptionPropertiesEndpointing.md +49 -0
- data/docs/TranscriptionPropertiesRedact.md +51 -0
- data/docs/UpdatePermissionsRequest.md +18 -0
- data/docs/UpdatePermissionsRequestDataValue.md +22 -0
- data/docs/UpdatePermissionsRequestDataValueCanSend.md +49 -0
- data/docs/UpdateWebhook.md +22 -0
- data/docs/ValidateMeetingToken200Response.md +28 -0
- data/docs/Webhook.md +38 -0
- data/docs/WebhooksApi.md +370 -0
- data/example.rb +61 -0
- data/lib/daily-ruby/api/batch_rooms_api.rb +143 -0
- data/lib/daily-ruby/api/domain_api.rb +143 -0
- data/lib/daily-ruby/api/logs_api.rb +181 -0
- data/lib/daily-ruby/api/meeting_tokens_api.rb +78 -12
- data/lib/daily-ruby/api/meetings_api.rb +238 -0
- data/lib/daily-ruby/api/presence_api.rb +77 -0
- data/lib/daily-ruby/api/recordings_api.rb +280 -0
- data/lib/daily-ruby/api/rooms_api.rb +1302 -0
- data/lib/daily-ruby/api/transcript_api.rb +283 -0
- data/lib/daily-ruby/api/webhooks_api.rb +339 -0
- data/lib/daily-ruby/api_client.rb +4 -4
- data/lib/daily-ruby/api_error.rb +4 -4
- data/lib/daily-ruby/configuration.rb +19 -7
- data/lib/daily-ruby/models/{room_deleted_response.rb → batch_room_create_request.rb} +16 -24
- data/lib/daily-ruby/models/batch_room_create_request_rooms_inner.rb +232 -0
- data/lib/daily-ruby/models/batch_room_delete200_response.rb +214 -0
- data/lib/daily-ruby/models/create_meeting_token200_response.rb +4 -4
- data/lib/daily-ruby/models/{server_error_response.rb → create_meeting_token_request.rb} +14 -15
- data/lib/daily-ruby/models/create_room200_response.rb +270 -0
- data/lib/daily-ruby/models/create_room_request.rb +232 -0
- data/lib/daily-ruby/models/daily_live_streaming_options.rb +324 -0
- data/lib/daily-ruby/models/{meeting_token_request_properties_permissions_can_send.rb → daily_live_streaming_options_rtmp_url.rb} +6 -6
- data/lib/daily-ruby/models/{room_request.rb → daily_streaming_active_participant_layout_config.rb} +29 -41
- data/lib/daily-ruby/models/daily_streaming_custom_layout_config.rb +293 -0
- data/lib/daily-ruby/models/daily_streaming_custom_layout_config_composition_params.rb +105 -0
- data/lib/daily-ruby/models/daily_streaming_default_layout_config.rb +264 -0
- data/lib/daily-ruby/models/daily_streaming_endpoint.rb +221 -0
- data/lib/daily-ruby/models/daily_streaming_layout_config.rb +46 -0
- data/lib/daily-ruby/models/daily_streaming_options.rb +304 -0
- data/lib/daily-ruby/models/daily_streaming_portrait_layout_config.rb +273 -0
- data/lib/daily-ruby/models/daily_streaming_portrait_layout_variant.rb +40 -0
- data/lib/daily-ruby/models/daily_streaming_single_participant_layout_config.rb +271 -0
- data/lib/daily-ruby/models/delete_transcript200_response.rb +307 -0
- data/lib/daily-ruby/models/{meeting_token_request.rb → domain.rb} +8 -9
- data/lib/daily-ruby/models/domain_properties.rb +570 -0
- data/lib/daily-ruby/models/eject200_response.rb +216 -0
- data/lib/daily-ruby/models/eject_request.rb +217 -0
- data/lib/daily-ruby/models/get_domain_config200_response.rb +271 -0
- data/lib/daily-ruby/models/get_domain_config200_response_config.rb +395 -0
- data/lib/daily-ruby/models/get_domain_config200_response_config_recordings_bucket.rb +223 -0
- data/lib/daily-ruby/models/get_meeting_info200_response.rb +259 -0
- data/lib/daily-ruby/models/get_meeting_info200_response_data_inner.rb +353 -0
- data/lib/daily-ruby/models/get_meeting_info200_response_data_inner_participants_inner.rb +290 -0
- data/lib/daily-ruby/models/get_presence200_response.rb +243 -0
- data/lib/daily-ruby/models/get_presence200_response_aivw_whz_hl_lhr_sd_hdw7_ew_inner.rb +370 -0
- data/lib/daily-ruby/models/get_recording_info200_response.rb +340 -0
- data/lib/daily-ruby/models/get_recording_info200_response_tracks_inner.rb +269 -0
- data/lib/daily-ruby/models/get_recording_link200_response.rb +225 -0
- data/lib/daily-ruby/models/get_transcript_info200_response.rb +317 -0
- data/lib/daily-ruby/models/get_transcript_info200_response_out_params.rb +232 -0
- data/lib/daily-ruby/models/get_transcript_link200_response.rb +233 -0
- data/lib/daily-ruby/models/list_api_logs200_response.rb +315 -0
- data/lib/daily-ruby/models/list_recordings200_response.rb +227 -0
- data/lib/daily-ruby/models/list_recordings200_response_data_inner.rb +272 -0
- data/lib/daily-ruby/models/list_rooms200_response.rb +227 -0
- data/lib/daily-ruby/models/list_rooms200_response_data_inner.rb +270 -0
- data/lib/daily-ruby/models/list_rooms200_response_data_inner_config.rb +216 -0
- data/lib/daily-ruby/models/list_transcript200_response.rb +227 -0
- data/lib/daily-ruby/models/list_transcript200_response_data_inner.rb +298 -0
- data/lib/daily-ruby/models/meeting_participants_get_res.rb +225 -0
- data/lib/daily-ruby/models/meeting_participants_get_res_data_inner.rb +259 -0
- data/lib/daily-ruby/models/meetings_meeting_get_res.rb +259 -0
- data/lib/daily-ruby/models/permissions.rb +234 -0
- data/lib/daily-ruby/models/permissions_can_admin.rb +106 -0
- data/lib/daily-ruby/models/permissions_can_send.rb +106 -0
- data/lib/daily-ruby/models/post_webhook.rb +259 -0
- data/lib/daily-ruby/models/{meeting_token_request_properties.rb → properties.rb} +81 -29
- data/lib/daily-ruby/models/recording_error.rb +278 -0
- data/lib/daily-ruby/models/recording_error_payload.rb +290 -0
- data/lib/daily-ruby/models/recording_ready_to_download.rb +278 -0
- data/lib/daily-ruby/models/recording_ready_to_download_payload.rb +344 -0
- data/lib/daily-ruby/models/recording_started.rb +278 -0
- data/lib/daily-ruby/models/recording_started_payload.rb +299 -0
- data/lib/daily-ruby/models/recording_streaming_options.rb +350 -0
- data/lib/daily-ruby/models/recordings_bucket.rb +258 -0
- data/lib/daily-ruby/models/room_properties.rb +678 -0
- data/lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb +267 -0
- data/lib/daily-ruby/models/room_properties_streaming_endpoints_inner_hls_config_variants_inner.rb +255 -0
- data/lib/daily-ruby/models/{room_response.rb → rooms_room_name_get_res.rb} +22 -12
- data/lib/daily-ruby/models/rooms_room_name_presence_get_res.rb +225 -0
- data/lib/daily-ruby/models/rooms_room_name_presence_get_res_data_inner.rb +259 -0
- data/lib/daily-ruby/models/send_app_message_request.rb +227 -0
- data/lib/daily-ruby/models/set_room_config_request.rb +223 -0
- data/lib/daily-ruby/models/set_session_data_request.rb +273 -0
- data/lib/daily-ruby/models/streaming_ended.rb +278 -0
- data/lib/daily-ruby/models/streaming_ended_payload.rb +236 -0
- data/lib/daily-ruby/models/streaming_error.rb +278 -0
- data/lib/daily-ruby/models/streaming_error_payload.rb +256 -0
- data/lib/daily-ruby/models/streaming_started.rb +278 -0
- data/lib/daily-ruby/models/streaming_started_payload.rb +245 -0
- data/lib/daily-ruby/models/streaming_updated.rb +278 -0
- data/lib/daily-ruby/models/streaming_updated_payload.rb +245 -0
- data/lib/daily-ruby/models/transcription_bucket.rb +246 -0
- data/lib/daily-ruby/models/transcription_properties.rb +283 -0
- data/lib/daily-ruby/models/transcription_properties_endpointing.rb +106 -0
- data/lib/daily-ruby/models/transcription_properties_redact.rb +107 -0
- data/lib/daily-ruby/models/{room_not_found_response.rb → update_permissions_request.rb} +16 -24
- data/lib/daily-ruby/models/{meeting_token_request_properties_permissions.rb → update_permissions_request_data_value.rb} +13 -12
- data/lib/daily-ruby/models/{meeting_token_request_properties_permissions_can_admin.rb → update_permissions_request_data_value_can_send.rb} +5 -5
- data/lib/daily-ruby/models/update_webhook.rb +259 -0
- data/lib/daily-ruby/models/validate_meeting_token200_response.rb +265 -0
- data/lib/daily-ruby/models/webhook.rb +339 -0
- data/lib/daily-ruby/version.rb +5 -5
- data/lib/daily-ruby.rb +101 -16
- data/run.sh +1 -1
- data/spec/api/batch_rooms_api_spec.rb +58 -0
- data/spec/api/domain_api_spec.rb +58 -0
- data/spec/api/logs_api_spec.rb +70 -0
- data/spec/api/meeting_tokens_api_spec.rb +20 -7
- data/spec/api/meetings_api_spec.rb +81 -0
- data/spec/api/presence_api_spec.rb +45 -0
- data/spec/api/recordings_api_spec.rb +86 -0
- data/spec/api/rooms_api_spec.rb +278 -0
- data/spec/api/transcript_api_spec.rb +87 -0
- data/spec/api/webhooks_api_spec.rb +95 -0
- data/spec/models/batch_room_create_request_rooms_inner_spec.rb +48 -0
- data/spec/models/batch_room_create_request_spec.rb +36 -0
- data/spec/models/batch_room_delete200_response_spec.rb +36 -0
- data/spec/models/create_meeting_token200_response_spec.rb +4 -4
- data/spec/models/create_meeting_token_request_spec.rb +36 -0
- data/spec/models/create_room200_response_spec.rb +72 -0
- data/spec/models/{room_request_spec.rb → create_room_request_spec.rb} +10 -14
- data/spec/models/daily_live_streaming_options_rtmp_url_spec.rb +32 -0
- data/spec/models/daily_live_streaming_options_spec.rb +102 -0
- data/spec/models/daily_streaming_active_participant_layout_config_spec.rb +40 -0
- data/spec/models/daily_streaming_custom_layout_config_composition_params_spec.rb +21 -0
- data/spec/models/daily_streaming_custom_layout_config_spec.rb +58 -0
- data/spec/models/daily_streaming_default_layout_config_spec.rb +46 -0
- data/spec/models/daily_streaming_endpoint_spec.rb +36 -0
- data/spec/models/daily_streaming_layout_config_spec.rb +38 -0
- data/spec/models/daily_streaming_options_spec.rb +90 -0
- data/spec/models/daily_streaming_portrait_layout_config_spec.rb +52 -0
- data/spec/models/daily_streaming_portrait_layout_variant_spec.rb +30 -0
- data/spec/models/daily_streaming_single_participant_layout_config_spec.rb +46 -0
- data/spec/models/delete_transcript200_response_spec.rb +76 -0
- data/spec/models/{room_request_properties_spec.rb → domain_properties_spec.rb} +39 -49
- data/spec/models/domain_spec.rb +36 -0
- data/spec/models/eject200_response_spec.rb +36 -0
- data/spec/models/eject_request_spec.rb +36 -0
- data/spec/models/get_domain_config200_response_config_recordings_bucket_spec.rb +42 -0
- data/spec/models/get_domain_config200_response_config_spec.rb +144 -0
- data/spec/models/get_domain_config200_response_spec.rb +48 -0
- data/spec/models/get_meeting_info200_response_data_inner_participants_inner_spec.rb +60 -0
- data/spec/models/get_meeting_info200_response_data_inner_spec.rb +66 -0
- data/spec/models/get_meeting_info200_response_spec.rb +42 -0
- data/spec/models/get_presence200_response_aivw_whz_hl_lhr_sd_hdw7_ew_inner_spec.rb +66 -0
- data/spec/models/get_presence200_response_spec.rb +36 -0
- data/spec/models/get_recording_info200_response_spec.rb +94 -0
- data/spec/models/get_recording_info200_response_tracks_inner_spec.rb +52 -0
- data/spec/models/get_recording_link200_response_spec.rb +42 -0
- data/spec/models/get_transcript_info200_response_out_params_spec.rb +48 -0
- data/spec/models/get_transcript_info200_response_spec.rb +82 -0
- data/spec/models/get_transcript_link200_response_spec.rb +48 -0
- data/spec/models/list_api_logs200_response_spec.rb +96 -0
- data/spec/models/list_recordings200_response_data_inner_spec.rb +72 -0
- data/spec/models/list_recordings200_response_spec.rb +42 -0
- data/spec/models/list_rooms200_response_data_inner_config_spec.rb +36 -0
- data/spec/models/list_rooms200_response_data_inner_spec.rb +72 -0
- data/spec/models/list_rooms200_response_spec.rb +42 -0
- data/spec/models/list_transcript200_response_data_inner_spec.rb +70 -0
- data/spec/models/list_transcript200_response_spec.rb +42 -0
- data/spec/models/meeting_participants_get_res_data_inner_spec.rb +66 -0
- data/spec/models/meeting_participants_get_res_spec.rb +42 -0
- data/spec/models/meetings_meeting_get_res_spec.rb +66 -0
- data/spec/models/{meeting_token_request_properties_permissions_can_send_spec.rb → permissions_can_admin_spec.rb} +6 -6
- data/spec/models/{meeting_token_request_properties_permissions_can_admin_spec.rb → permissions_can_send_spec.rb} +6 -6
- data/spec/models/{meeting_token_request_properties_permissions_spec.rb → permissions_spec.rb} +10 -10
- data/spec/models/post_webhook_spec.rb +52 -0
- data/spec/models/{meeting_token_request_properties_spec.rb → properties_spec.rb} +27 -15
- data/spec/models/recording_error_payload_spec.rb +64 -0
- data/spec/models/recording_error_spec.rb +58 -0
- data/spec/models/recording_ready_to_download_payload_spec.rb +92 -0
- data/spec/models/recording_ready_to_download_spec.rb +58 -0
- data/spec/models/recording_started_payload_spec.rb +70 -0
- data/spec/models/recording_started_spec.rb +58 -0
- data/spec/models/recording_streaming_options_spec.rb +100 -0
- data/spec/models/recordings_bucket_spec.rb +60 -0
- data/spec/models/room_properties_spec.rb +272 -0
- data/spec/models/room_properties_streaming_endpoints_inner_hls_config_variants_inner_spec.rb +60 -0
- data/spec/models/room_properties_streaming_endpoints_inner_spec.rb +66 -0
- data/spec/models/{room_response_spec.rb → rooms_room_name_get_res_spec.rb} +16 -10
- data/spec/models/rooms_room_name_presence_get_res_data_inner_spec.rb +66 -0
- data/spec/models/rooms_room_name_presence_get_res_spec.rb +42 -0
- data/spec/models/send_app_message_request_spec.rb +42 -0
- data/spec/models/set_room_config_request_spec.rb +42 -0
- data/spec/models/set_session_data_request_spec.rb +52 -0
- data/spec/models/streaming_ended_payload_spec.rb +48 -0
- data/spec/models/streaming_ended_spec.rb +58 -0
- data/spec/models/streaming_error_payload_spec.rb +60 -0
- data/spec/models/streaming_error_spec.rb +58 -0
- data/spec/models/streaming_started_payload_spec.rb +54 -0
- data/spec/models/streaming_started_spec.rb +58 -0
- data/spec/models/streaming_updated_payload_spec.rb +54 -0
- data/spec/models/streaming_updated_spec.rb +58 -0
- data/spec/models/transcription_bucket_spec.rb +54 -0
- data/spec/models/transcription_properties_endpointing_spec.rb +32 -0
- data/spec/models/transcription_properties_redact_spec.rb +32 -0
- data/spec/models/transcription_properties_spec.rb +78 -0
- data/spec/models/update_permissions_request_data_value_can_send_spec.rb +32 -0
- data/spec/models/update_permissions_request_data_value_spec.rb +48 -0
- data/spec/models/update_permissions_request_spec.rb +36 -0
- data/spec/models/update_webhook_spec.rb +52 -0
- data/spec/models/validate_meeting_token200_response_spec.rb +66 -0
- data/spec/models/webhook_spec.rb +100 -0
- data/spec/spec_helper.rb +4 -4
- metadata +391 -52
- data/daily.yaml +0 -422
- data/docs/MeetingTokenRequest.md +0 -18
- data/docs/MeetingTokenRequestProperties.md +0 -56
- data/docs/MeetingTokenRequestPropertiesPermissions.md +0 -22
- data/docs/RoomApi.md +0 -227
- data/docs/RoomDeletedResponse.md +0 -20
- data/docs/RoomNotFoundResponse.md +0 -20
- data/docs/RoomRequestProperties.md +0 -76
- data/docs/RoomResponse.md +0 -28
- data/lib/daily-ruby/api/room_api.rb +0 -218
- data/lib/daily-ruby/models/room_request_properties.rb +0 -521
- data/script.rb +0 -35
- data/spec/api/room_api_spec.rb +0 -74
- data/spec/models/meeting_token_request_spec.rb +0 -36
- data/spec/models/room_deleted_response_spec.rb +0 -42
- data/spec/models/room_not_found_response_spec.rb +0 -42
- data/spec/models/server_error_response_spec.rb +0 -36
@@ -0,0 +1,678 @@
|
|
1
|
+
=begin
|
2
|
+
#Daily API
|
3
|
+
|
4
|
+
#The Daily REST API offers the ability to manage the following: - Overall Domain Configuration - Individual Room creation and config management - Meeting token creation and validation - Recording and compositing management - Meeting analytics - Logs and metrics - Real-time presence Please reach out to help@daily.co if we can help with anything
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.1.1
|
7
|
+
Contact: help@daily.co
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.3.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module Daily
|
17
|
+
class RoomProperties
|
18
|
+
# \"Not before\". This is a [unix timestamp](https://stackoverflow.com/questions/20822821/what-is-a-unix-timestamp-and-why-use-it) (seconds since the epoch.) Users cannot join a meeting in this room before this time.
|
19
|
+
attr_accessor :nbf
|
20
|
+
|
21
|
+
# \"Expires\". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting in this room after this time. More resources: - [Add advanced security to video chats with the Daily API](https://www.daily.co/blog/add-advanced-security-features-to-video-chats-with-the-daily-api/)
|
22
|
+
attr_accessor :exp
|
23
|
+
|
24
|
+
# How many people are allowed in a room at the same time. ⚠️ [Contact us](https://www.daily.co/contact) if you need to set the limit above 200.
|
25
|
+
attr_accessor :max_participants
|
26
|
+
|
27
|
+
# Determines if [Daily Prebuilt](/guides/products/prebuilt) displays the People UI. When set to true, a People button in the call tray reveals a People tab in the call sidebar. The tab lists all participants, and next to each name indicates audio status and an option to pin the participant. When `enable_people_ui` is set to false, the button and tab are hidden. ⚠️ Has no effect on custom calls built on the Daily [call object](/guides/products/call-object).
|
28
|
+
attr_accessor :enable_people_ui
|
29
|
+
|
30
|
+
# Sets whether the room can use [Daily Prebuilt](https://www.daily.co/prebuilt)'s Picture in Picture controls. When set to `true`, an additional button will be available in Daily Prebuilt's UI to toggle the Picture in Picture feature. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.
|
31
|
+
attr_accessor :enable_pip_ui
|
32
|
+
|
33
|
+
# Determines if [Daily Prebuilt](https://www.daily.co/prebuilt) displays the Emoji Reactions UI. When set to `true`, a Reactions button appears in the call tray. This button allows users to select and send a reaction into the call. When set to `false`, the Reactions button is hidden and the feature is disabled. Usage: This feature is a good fit for meetings when a host or presenter would benefit from receiving nonverbal cues from the audience. It's also great to keep meetings fun. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.
|
34
|
+
attr_accessor :enable_emoji_reactions
|
35
|
+
|
36
|
+
# Sets whether the participants in the room can use [Daily Prebuilt](https://www.daily.co/prebuilt)'s hand raising controls. When set to `true`, an additional button will be available in Daily Prebuilt's UI to toggle a hand raise. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.
|
37
|
+
attr_accessor :enable_hand_raising
|
38
|
+
|
39
|
+
# 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`.
|
40
|
+
attr_accessor :enable_prejoin_ui
|
41
|
+
|
42
|
+
# 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`.
|
43
|
+
attr_accessor :enable_network_ui
|
44
|
+
|
45
|
+
# Determines whether Daily Prebuilt displays noise cancellation controls. When set to `true`, a participant can enable microphone noise cancellation during a Daily Prebuilt call. ⚠️ This flag only applies to [Daily Prebuilt](https://daily.co/prebuilt). It has no effect when building custom video applications with the Daily call object. To learn more about adding noise cancellation to a custom application, see the [`updateInputSettings()` docs](/reference/daily-js/instance-methods/update-input-settings).
|
46
|
+
attr_accessor :enable_noise_cancellation_ui
|
47
|
+
|
48
|
+
# Sets whether [Daily Prebuilt](https://www.daily.co/prebuilt)’s breakout rooms feature is enabled. When set to `true`, an owner in a Prebuilt call can create breakout rooms to divide participants into smaller, private groups. ⚠️ You must be using [Daily Prebuilt](https://daily.co/blog/daily-prebuilt-video-chat) to use `enable_breakout_rooms`. ⚠️ This property is in beta.
|
49
|
+
attr_accessor :enable_breakout_rooms
|
50
|
+
|
51
|
+
# Turns on a lobby experience for private rooms. A participant without a corresponding [meeting token](/reference/rest-api/meeting-tokens/config) can request to be admitted to the meeting with a \"knock\", and wait for the meeting owner to admit them.
|
52
|
+
attr_accessor :enable_knocking
|
53
|
+
|
54
|
+
# Sets whether users in a room can screen share during a session. This property cannot be changed after a session starts. For dynamic control over permissions, use the [`updateParticipant()`](/reference/daily-js/instance-methods/update-participant#permissions) method to control user permissions.
|
55
|
+
attr_accessor :enable_screenshare
|
56
|
+
|
57
|
+
# Determines whether Daily Prebuilt displays background blur controls. When set to `true`, a participant can enable blur during a Daily Prebuilt call. ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.
|
58
|
+
attr_accessor :enable_video_processing_ui
|
59
|
+
|
60
|
+
# 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/).
|
61
|
+
attr_accessor :enable_chat
|
62
|
+
|
63
|
+
# Disable the default behavior of automatically turning on a participant's camera on a direct `join()` (i.e. without `startCamera()` first).
|
64
|
+
attr_accessor :start_video_off
|
65
|
+
|
66
|
+
# Disable the default behavior of automatically turning on a participant's microphone on a direct `join()` (i.e. without `startCamera()` first).
|
67
|
+
attr_accessor :start_audio_off
|
68
|
+
|
69
|
+
# In Daily Prebuilt, only the meeting owners will be able to turn on camera, unmute mic, and share screen. See [setting up calls](https://docs.daily.co/docs/setting-up-calls).
|
70
|
+
attr_accessor :owner_only_broadcast
|
71
|
+
|
72
|
+
# Jump to [recording docs](/reference/rest-api/recordings).
|
73
|
+
attr_accessor :enable_recording
|
74
|
+
|
75
|
+
# If there's a meeting going on at room `exp` time, end the meeting by kicking everyone out. This behavior can be overridden by setting `eject` properties of a [meeting token](/reference/rest-api/meeting-tokens).
|
76
|
+
attr_accessor :eject_at_room_exp
|
77
|
+
|
78
|
+
# Eject a meeting participant this many seconds after the participant joins the meeting. You can use this is a default length limit to prevent long meetings. This can be overridden by setting `eject` properties of a [meeting token](/reference/rest-api/meeting-tokens).
|
79
|
+
attr_accessor :eject_after_elapsed
|
80
|
+
|
81
|
+
# Property that gives end users a richer chat experience. This includes: * Emoji reactions to chat messages * Emoji picker in the chat input form * Ability to send a Giphy chat message ⚠️ This flag only applies to Daily Prebuilt. It has no effect when building custom video applications with the Daily call object.
|
82
|
+
attr_accessor :enable_advanced_chat
|
83
|
+
|
84
|
+
# When enabled, non-owner users join a meeting with a hidden presence, meaning they won't appear as a named participant in the meeting and have no [participant events](https://docs.daily.co/reference/daily-js/events/participant-events) associated to them. Additionally, these participants can _only_ receive media tracks from owner participants. Hidden participants can be tracked using the [`participantCounts()`](/reference/daily-js/instance-methods/participant-counts) method. Hidden participants do _not_ have entries in the [`participants()`](/reference/daily-js/instance-methods/participants) method return value. When used with [Daily Prebuilt](/guides/products/prebuilt), hidden participants are included in the participant count available in the UI; however, are _not_ included in the People panel and can only read chat messages. This property should be used to support hosting large meetings. See our [guide on interactive live streaming](/guides/scaling-calls/interactive-live-streaming-rtmp-output#interactive-live-streaming-up-to-100-000-participants) for additional instruction.
|
85
|
+
attr_accessor :enable_hidden_participants
|
86
|
+
|
87
|
+
# 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.
|
88
|
+
attr_accessor :enable_mesh_sfu
|
89
|
+
|
90
|
+
# 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.
|
91
|
+
attr_accessor :sfu_switchover
|
92
|
+
|
93
|
+
# 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.
|
94
|
+
attr_accessor :experimental_optimize_large_calls
|
95
|
+
|
96
|
+
# 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.
|
97
|
+
attr_accessor :lang
|
98
|
+
|
99
|
+
# 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/)
|
100
|
+
attr_accessor :meeting_join_hook
|
101
|
+
|
102
|
+
# 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)
|
103
|
+
attr_accessor :geo
|
104
|
+
|
105
|
+
# Used to select the region where an RTMP stream should originate. In cases where RTMP streaming services aren't available in the desired region, we'll attempt to fall back to the default region based on the SFU being used for the meeting. Available regions: - `\"us-west-2\"` (Oregon) - `\"eu-central-1\"` (Frankfurt) - `\"ap-south-1\"` (Mumbai) The default regions are grouped based on the SFU region like so: - RTMP region `\"us-west-2\"` includes SFU regions: `\"us-west-2\"`, `\"us-east-1\"`, `\"sa-east-1\"` - RTMP region `\"eu-central-1\"` includes SFU regions: `\"eu-central-1\"`, `\"eu-west-2\"`, `\"af-south-1\"` - RTMP region `\"ap-south-1\"` includes SFU regions: `\"ap-southeast-1\"`, `\"ap-southeast-2\"`, `\"ap-northeast-2\"`, `\"ap-south-1\"`
|
106
|
+
attr_accessor :rtmp_geo
|
107
|
+
|
108
|
+
# Disable the fall back behavior of rtmp_geo. When rtmp_geo is set, we first try to connect to a media server in desired region. If a media server is not available in the desired region, we fall back to default region based on SFU's region. This property disables this automatic fall back. When this property is set, we will trigger a recording/streaming error event when media worker is unavailable. Also, the client should retry recording/streaming.
|
109
|
+
attr_accessor :disable_rtmp_geo_fallback
|
110
|
+
|
111
|
+
attr_accessor :recordings_bucket
|
112
|
+
|
113
|
+
# Reduces the volume of log messages. This feature should be enabled when there are more than 200 participants in a meeting to help improve performance. See our [guides for supporting large experiences](/guides/scaling-calls) for additional instruction.
|
114
|
+
attr_accessor :enable_terse_logging
|
115
|
+
|
116
|
+
# Options to use when `auto_start_transcription` is true. See [`startTranscription()`](/reference/daily-js/instance-methods/start-transcription) for available options.
|
117
|
+
attr_accessor :auto_transcription_settings
|
118
|
+
|
119
|
+
# Live transcriptions generated can be saved as WebVTT. This flag controls if transcription started with [`startTranscription()`](/reference/daily-js/instance-methods/start-transcription) should be saved or not.
|
120
|
+
attr_accessor :enable_transcription_storage
|
121
|
+
|
122
|
+
attr_accessor :transcription_bucket
|
123
|
+
|
124
|
+
# Cloud recordings are stored in either Daily's S3 bucket or the customer's own S3 bucket. By default recordings are stored as `{domain_name}/{room_name}/{epoch_time}`. Sometimes, the use case may call for custom recording file names to be used (for example, if you'd like to enforce the presence of the .mp4 extension in the file name). `recordings_template` is made up of a replacement string with prefixes, suffixes, or both. The currently supported replacements are: - `epoch_time`: The epoch time in seconds (mandatory) - `domain_name`: Your Daily domain (optional) - `room_name`: The name of the room which is getting recorded (optional) - `mtg_session_id`: The ID of the meeting session which is getting recorded (optional) - `instance_id`: The instance ID of the recording (optional) - `recording_id`: The recording ID of the recording (optional) The restrictions for defining a recording template are as follows: - The `epoch_time` tag is mandatory to ensure the recording file name is unique under all conditions - The maximum size of the template is 1024 characters - Each replacement parameter should be placed within a curly bracket (e.g., `{domain_name}`) - Only alphanumeric characters `(0-9, A-Z, a-z)` and `.`, `/`, `-`, `_` are valid within the template - `.mp4` is the only valid extension Examples - Example domain: \"myDomain\" - Example room: \"myRoom\" Example 1: - Template: `myprefix-{domain_name}-{epoch_time}.mp4` - Resulting file name: `myprefix-myDomain-1675842936274.mp4` Example 2: - Template: `{room_name}/{instance_id}/{epoch_time}` - Resulting room name: `myRoom/d529cd2f-fbcc-4fb7-b2c0-c4995b1162b6/1675842936274`
|
125
|
+
attr_accessor :recordings_template
|
126
|
+
|
127
|
+
# An array of stream endpoint configuration objects, which allows configurations to be pre-defined without having to pass them into [`startLiveStreaming()`](/reference/daily-js/instance-methods/start-live-streaming) at runtime. For example, an RTMP endpoint can be set up for YouTube as a `streaming_endpoints` configuration along with another configuration for HLS storage. HLS output can only be stored on a customer's S3, not in Daily's storage infrastructure. The stream configuration defines which S3 bucket to store the HLS output. (See the [S3 bucket guide](/guides/products/live-streaming-recording/storing-recordings-in-a-custom-s3-bucket) for more information.) Example: ```json { \"properties\": { // ... add additional room properties here \"streaming_endpoints\": [ { \"name\": \"rtmp_youtube\", \"type\": \"rtmp\", \"rtmp_config\": { \"url\": \"rtmps://exampleYouTubeServer.com:443/stream\" } }, { \"name\": \"rtmp_ivs\", \"type\": \"rtmp\", \"rtmp_config\": { \"url\": \"rtmps://811111111111.global-contribute.live-video.net:443/app/\" } }, { \"name\": \"hls_akamai\", \"type\": \"hls\", \"hls_config\": { \"save_hls_recording\": true/false, \"storage\": { \"bucket_name\": \"daily-hls-streams\", \"bucket_region\": \"us-west-2\", \"assume_role_arn\": \"arn:aws:iam::999999999999:role/DailyS3AccessRole\", \"path_template\": \"testHarness/{live_streaming_id}/{instance_id}\" }, \"variant\" : [ { \"width\": 1920, \"height\": 1080, \"fps\": 30, \"bitrate\": 3500, \"iframe_only\": false }, { \"width\": 1280, \"height\": 720, \"fps\": 30, \"bitrate\": 2500, \"iframe_only\": false }, { \"width\": 640, \"height\": 360, \"fps\": 30, \"bitrate\": 780, \"iframe_only\": true } ] } } ] } } ``` To reset the `streaming_endpoints` property, pass `null` instead of an array. When calling `startLiveStreaming()`, the pre-defined `streaming_endpoints` `name` can be used: ```javascript await callObject.startLiveStreaming({ endpoints: [{\"endpoint\":\"rtmp_youtube\"},{\"endpoint\":\"rtmp_fb\"}], width: 1280, height: 720, }); ``` Properties:
|
128
|
+
attr_accessor :streaming_endpoints
|
129
|
+
|
130
|
+
attr_accessor :permissions
|
131
|
+
|
132
|
+
class EnumAttributeValidator
|
133
|
+
attr_reader :datatype
|
134
|
+
attr_reader :allowable_values
|
135
|
+
|
136
|
+
def initialize(datatype, allowable_values)
|
137
|
+
@allowable_values = allowable_values.map do |value|
|
138
|
+
case datatype.to_s
|
139
|
+
when /Integer/i
|
140
|
+
value.to_i
|
141
|
+
when /Float/i
|
142
|
+
value.to_f
|
143
|
+
else
|
144
|
+
value
|
145
|
+
end
|
146
|
+
end
|
147
|
+
end
|
148
|
+
|
149
|
+
def valid?(value)
|
150
|
+
!value || allowable_values.include?(value)
|
151
|
+
end
|
152
|
+
end
|
153
|
+
|
154
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
155
|
+
def self.attribute_map
|
156
|
+
{
|
157
|
+
:'nbf' => :'nbf',
|
158
|
+
:'exp' => :'exp',
|
159
|
+
:'max_participants' => :'max_participants',
|
160
|
+
:'enable_people_ui' => :'enable_people_ui',
|
161
|
+
:'enable_pip_ui' => :'enable_pip_ui',
|
162
|
+
:'enable_emoji_reactions' => :'enable_emoji_reactions',
|
163
|
+
:'enable_hand_raising' => :'enable_hand_raising',
|
164
|
+
:'enable_prejoin_ui' => :'enable_prejoin_ui',
|
165
|
+
:'enable_network_ui' => :'enable_network_ui',
|
166
|
+
:'enable_noise_cancellation_ui' => :'enable_noise_cancellation_ui',
|
167
|
+
:'enable_breakout_rooms' => :'enable_breakout_rooms',
|
168
|
+
:'enable_knocking' => :'enable_knocking',
|
169
|
+
:'enable_screenshare' => :'enable_screenshare',
|
170
|
+
:'enable_video_processing_ui' => :'enable_video_processing_ui',
|
171
|
+
:'enable_chat' => :'enable_chat',
|
172
|
+
:'start_video_off' => :'start_video_off',
|
173
|
+
:'start_audio_off' => :'start_audio_off',
|
174
|
+
:'owner_only_broadcast' => :'owner_only_broadcast',
|
175
|
+
:'enable_recording' => :'enable_recording',
|
176
|
+
:'eject_at_room_exp' => :'eject_at_room_exp',
|
177
|
+
:'eject_after_elapsed' => :'eject_after_elapsed',
|
178
|
+
:'enable_advanced_chat' => :'enable_advanced_chat',
|
179
|
+
:'enable_hidden_participants' => :'enable_hidden_participants',
|
180
|
+
:'enable_mesh_sfu' => :'enable_mesh_sfu',
|
181
|
+
:'sfu_switchover' => :'sfu_switchover',
|
182
|
+
:'experimental_optimize_large_calls' => :'experimental_optimize_large_calls',
|
183
|
+
:'lang' => :'lang',
|
184
|
+
:'meeting_join_hook' => :'meeting_join_hook',
|
185
|
+
:'geo' => :'geo',
|
186
|
+
:'rtmp_geo' => :'rtmp_geo',
|
187
|
+
:'disable_rtmp_geo_fallback' => :'disable_rtmp_geo_fallback',
|
188
|
+
:'recordings_bucket' => :'recordings_bucket',
|
189
|
+
:'enable_terse_logging' => :'enable_terse_logging',
|
190
|
+
:'auto_transcription_settings' => :'auto_transcription_settings',
|
191
|
+
:'enable_transcription_storage' => :'enable_transcription_storage',
|
192
|
+
:'transcription_bucket' => :'transcription_bucket',
|
193
|
+
:'recordings_template' => :'recordings_template',
|
194
|
+
:'streaming_endpoints' => :'streaming_endpoints',
|
195
|
+
:'permissions' => :'permissions'
|
196
|
+
}
|
197
|
+
end
|
198
|
+
|
199
|
+
# Returns all the JSON keys this model knows about
|
200
|
+
def self.acceptable_attributes
|
201
|
+
attribute_map.values
|
202
|
+
end
|
203
|
+
|
204
|
+
# Attribute type mapping.
|
205
|
+
def self.openapi_types
|
206
|
+
{
|
207
|
+
:'nbf' => :'Integer',
|
208
|
+
:'exp' => :'Integer',
|
209
|
+
:'max_participants' => :'Integer',
|
210
|
+
:'enable_people_ui' => :'Boolean',
|
211
|
+
:'enable_pip_ui' => :'Boolean',
|
212
|
+
:'enable_emoji_reactions' => :'Boolean',
|
213
|
+
:'enable_hand_raising' => :'Boolean',
|
214
|
+
:'enable_prejoin_ui' => :'Boolean',
|
215
|
+
:'enable_network_ui' => :'Boolean',
|
216
|
+
:'enable_noise_cancellation_ui' => :'Boolean',
|
217
|
+
:'enable_breakout_rooms' => :'Boolean',
|
218
|
+
:'enable_knocking' => :'Boolean',
|
219
|
+
:'enable_screenshare' => :'Boolean',
|
220
|
+
:'enable_video_processing_ui' => :'Boolean',
|
221
|
+
:'enable_chat' => :'Boolean',
|
222
|
+
:'start_video_off' => :'Boolean',
|
223
|
+
:'start_audio_off' => :'Boolean',
|
224
|
+
:'owner_only_broadcast' => :'Boolean',
|
225
|
+
:'enable_recording' => :'String',
|
226
|
+
:'eject_at_room_exp' => :'Boolean',
|
227
|
+
:'eject_after_elapsed' => :'Integer',
|
228
|
+
:'enable_advanced_chat' => :'Boolean',
|
229
|
+
:'enable_hidden_participants' => :'Boolean',
|
230
|
+
:'enable_mesh_sfu' => :'Boolean',
|
231
|
+
:'sfu_switchover' => :'Float',
|
232
|
+
:'experimental_optimize_large_calls' => :'Boolean',
|
233
|
+
:'lang' => :'String',
|
234
|
+
:'meeting_join_hook' => :'String',
|
235
|
+
:'geo' => :'String',
|
236
|
+
:'rtmp_geo' => :'String',
|
237
|
+
:'disable_rtmp_geo_fallback' => :'Boolean',
|
238
|
+
:'recordings_bucket' => :'RecordingsBucket',
|
239
|
+
:'enable_terse_logging' => :'Boolean',
|
240
|
+
:'auto_transcription_settings' => :'Object',
|
241
|
+
:'enable_transcription_storage' => :'Boolean',
|
242
|
+
:'transcription_bucket' => :'TranscriptionBucket',
|
243
|
+
:'recordings_template' => :'String',
|
244
|
+
:'streaming_endpoints' => :'Array<RoomPropertiesStreamingEndpointsInner>',
|
245
|
+
:'permissions' => :'Permissions'
|
246
|
+
}
|
247
|
+
end
|
248
|
+
|
249
|
+
# List of attributes with nullable: true
|
250
|
+
def self.openapi_nullable
|
251
|
+
Set.new([
|
252
|
+
])
|
253
|
+
end
|
254
|
+
|
255
|
+
# Initializes the object
|
256
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
257
|
+
def initialize(attributes = {})
|
258
|
+
if (!attributes.is_a?(Hash))
|
259
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Daily::RoomProperties` initialize method"
|
260
|
+
end
|
261
|
+
|
262
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
263
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
264
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
265
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Daily::RoomProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
266
|
+
end
|
267
|
+
h[k.to_sym] = v
|
268
|
+
}
|
269
|
+
|
270
|
+
if attributes.key?(:'nbf')
|
271
|
+
self.nbf = attributes[:'nbf']
|
272
|
+
end
|
273
|
+
|
274
|
+
if attributes.key?(:'exp')
|
275
|
+
self.exp = attributes[:'exp']
|
276
|
+
end
|
277
|
+
|
278
|
+
if attributes.key?(:'max_participants')
|
279
|
+
self.max_participants = attributes[:'max_participants']
|
280
|
+
else
|
281
|
+
self.max_participants = 200
|
282
|
+
end
|
283
|
+
|
284
|
+
if attributes.key?(:'enable_people_ui')
|
285
|
+
self.enable_people_ui = attributes[:'enable_people_ui']
|
286
|
+
end
|
287
|
+
|
288
|
+
if attributes.key?(:'enable_pip_ui')
|
289
|
+
self.enable_pip_ui = attributes[:'enable_pip_ui']
|
290
|
+
end
|
291
|
+
|
292
|
+
if attributes.key?(:'enable_emoji_reactions')
|
293
|
+
self.enable_emoji_reactions = attributes[:'enable_emoji_reactions']
|
294
|
+
end
|
295
|
+
|
296
|
+
if attributes.key?(:'enable_hand_raising')
|
297
|
+
self.enable_hand_raising = attributes[:'enable_hand_raising']
|
298
|
+
end
|
299
|
+
|
300
|
+
if attributes.key?(:'enable_prejoin_ui')
|
301
|
+
self.enable_prejoin_ui = attributes[:'enable_prejoin_ui']
|
302
|
+
end
|
303
|
+
|
304
|
+
if attributes.key?(:'enable_network_ui')
|
305
|
+
self.enable_network_ui = attributes[:'enable_network_ui']
|
306
|
+
end
|
307
|
+
|
308
|
+
if attributes.key?(:'enable_noise_cancellation_ui')
|
309
|
+
self.enable_noise_cancellation_ui = attributes[:'enable_noise_cancellation_ui']
|
310
|
+
end
|
311
|
+
|
312
|
+
if attributes.key?(:'enable_breakout_rooms')
|
313
|
+
self.enable_breakout_rooms = attributes[:'enable_breakout_rooms']
|
314
|
+
end
|
315
|
+
|
316
|
+
if attributes.key?(:'enable_knocking')
|
317
|
+
self.enable_knocking = attributes[:'enable_knocking']
|
318
|
+
end
|
319
|
+
|
320
|
+
if attributes.key?(:'enable_screenshare')
|
321
|
+
self.enable_screenshare = attributes[:'enable_screenshare']
|
322
|
+
else
|
323
|
+
self.enable_screenshare = true
|
324
|
+
end
|
325
|
+
|
326
|
+
if attributes.key?(:'enable_video_processing_ui')
|
327
|
+
self.enable_video_processing_ui = attributes[:'enable_video_processing_ui']
|
328
|
+
else
|
329
|
+
self.enable_video_processing_ui = true
|
330
|
+
end
|
331
|
+
|
332
|
+
if attributes.key?(:'enable_chat')
|
333
|
+
self.enable_chat = attributes[:'enable_chat']
|
334
|
+
else
|
335
|
+
self.enable_chat = false
|
336
|
+
end
|
337
|
+
|
338
|
+
if attributes.key?(:'start_video_off')
|
339
|
+
self.start_video_off = attributes[:'start_video_off']
|
340
|
+
else
|
341
|
+
self.start_video_off = false
|
342
|
+
end
|
343
|
+
|
344
|
+
if attributes.key?(:'start_audio_off')
|
345
|
+
self.start_audio_off = attributes[:'start_audio_off']
|
346
|
+
else
|
347
|
+
self.start_audio_off = false
|
348
|
+
end
|
349
|
+
|
350
|
+
if attributes.key?(:'owner_only_broadcast')
|
351
|
+
self.owner_only_broadcast = attributes[:'owner_only_broadcast']
|
352
|
+
else
|
353
|
+
self.owner_only_broadcast = false
|
354
|
+
end
|
355
|
+
|
356
|
+
if attributes.key?(:'enable_recording')
|
357
|
+
self.enable_recording = attributes[:'enable_recording']
|
358
|
+
else
|
359
|
+
self.enable_recording = '<not set>'
|
360
|
+
end
|
361
|
+
|
362
|
+
if attributes.key?(:'eject_at_room_exp')
|
363
|
+
self.eject_at_room_exp = attributes[:'eject_at_room_exp']
|
364
|
+
else
|
365
|
+
self.eject_at_room_exp = false
|
366
|
+
end
|
367
|
+
|
368
|
+
if attributes.key?(:'eject_after_elapsed')
|
369
|
+
self.eject_after_elapsed = attributes[:'eject_after_elapsed']
|
370
|
+
end
|
371
|
+
|
372
|
+
if attributes.key?(:'enable_advanced_chat')
|
373
|
+
self.enable_advanced_chat = attributes[:'enable_advanced_chat']
|
374
|
+
else
|
375
|
+
self.enable_advanced_chat = false
|
376
|
+
end
|
377
|
+
|
378
|
+
if attributes.key?(:'enable_hidden_participants')
|
379
|
+
self.enable_hidden_participants = attributes[:'enable_hidden_participants']
|
380
|
+
else
|
381
|
+
self.enable_hidden_participants = false
|
382
|
+
end
|
383
|
+
|
384
|
+
if attributes.key?(:'enable_mesh_sfu')
|
385
|
+
self.enable_mesh_sfu = attributes[:'enable_mesh_sfu']
|
386
|
+
end
|
387
|
+
|
388
|
+
if attributes.key?(:'sfu_switchover')
|
389
|
+
self.sfu_switchover = attributes[:'sfu_switchover']
|
390
|
+
else
|
391
|
+
self.sfu_switchover = 2
|
392
|
+
end
|
393
|
+
|
394
|
+
if attributes.key?(:'experimental_optimize_large_calls')
|
395
|
+
self.experimental_optimize_large_calls = attributes[:'experimental_optimize_large_calls']
|
396
|
+
end
|
397
|
+
|
398
|
+
if attributes.key?(:'lang')
|
399
|
+
self.lang = attributes[:'lang']
|
400
|
+
else
|
401
|
+
self.lang = 'en'
|
402
|
+
end
|
403
|
+
|
404
|
+
if attributes.key?(:'meeting_join_hook')
|
405
|
+
self.meeting_join_hook = attributes[:'meeting_join_hook']
|
406
|
+
end
|
407
|
+
|
408
|
+
if attributes.key?(:'geo')
|
409
|
+
self.geo = attributes[:'geo']
|
410
|
+
else
|
411
|
+
self.geo = 'NULL'
|
412
|
+
end
|
413
|
+
|
414
|
+
if attributes.key?(:'rtmp_geo')
|
415
|
+
self.rtmp_geo = attributes[:'rtmp_geo']
|
416
|
+
else
|
417
|
+
self.rtmp_geo = 'The closest available region to the SFU region used by the meeting.'
|
418
|
+
end
|
419
|
+
|
420
|
+
if attributes.key?(:'disable_rtmp_geo_fallback')
|
421
|
+
self.disable_rtmp_geo_fallback = attributes[:'disable_rtmp_geo_fallback']
|
422
|
+
else
|
423
|
+
self.disable_rtmp_geo_fallback = false
|
424
|
+
end
|
425
|
+
|
426
|
+
if attributes.key?(:'recordings_bucket')
|
427
|
+
self.recordings_bucket = attributes[:'recordings_bucket']
|
428
|
+
end
|
429
|
+
|
430
|
+
if attributes.key?(:'enable_terse_logging')
|
431
|
+
self.enable_terse_logging = attributes[:'enable_terse_logging']
|
432
|
+
else
|
433
|
+
self.enable_terse_logging = false
|
434
|
+
end
|
435
|
+
|
436
|
+
if attributes.key?(:'auto_transcription_settings')
|
437
|
+
self.auto_transcription_settings = attributes[:'auto_transcription_settings']
|
438
|
+
end
|
439
|
+
|
440
|
+
if attributes.key?(:'enable_transcription_storage')
|
441
|
+
self.enable_transcription_storage = attributes[:'enable_transcription_storage']
|
442
|
+
else
|
443
|
+
self.enable_transcription_storage = false
|
444
|
+
end
|
445
|
+
|
446
|
+
if attributes.key?(:'transcription_bucket')
|
447
|
+
self.transcription_bucket = attributes[:'transcription_bucket']
|
448
|
+
end
|
449
|
+
|
450
|
+
if attributes.key?(:'recordings_template')
|
451
|
+
self.recordings_template = attributes[:'recordings_template']
|
452
|
+
else
|
453
|
+
self.recordings_template = '{domain_name}/{room_name}/{epoch_time}.'
|
454
|
+
end
|
455
|
+
|
456
|
+
if attributes.key?(:'streaming_endpoints')
|
457
|
+
if (value = attributes[:'streaming_endpoints']).is_a?(Array)
|
458
|
+
self.streaming_endpoints = value
|
459
|
+
end
|
460
|
+
end
|
461
|
+
|
462
|
+
if attributes.key?(:'permissions')
|
463
|
+
self.permissions = attributes[:'permissions']
|
464
|
+
end
|
465
|
+
end
|
466
|
+
|
467
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
468
|
+
# @return Array for valid properties with the reasons
|
469
|
+
def list_invalid_properties
|
470
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
471
|
+
invalid_properties = Array.new
|
472
|
+
invalid_properties
|
473
|
+
end
|
474
|
+
|
475
|
+
# Check to see if the all the properties in the model are valid
|
476
|
+
# @return true if the model is valid
|
477
|
+
def valid?
|
478
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
479
|
+
enable_recording_validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>"])
|
480
|
+
return false unless enable_recording_validator.valid?(@enable_recording)
|
481
|
+
lang_validator = EnumAttributeValidator.new('String', ["de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user"])
|
482
|
+
return false unless lang_validator.valid?(@lang)
|
483
|
+
true
|
484
|
+
end
|
485
|
+
|
486
|
+
# Custom attribute writer method checking allowed values (enum).
|
487
|
+
# @param [Object] enable_recording Object to be assigned
|
488
|
+
def enable_recording=(enable_recording)
|
489
|
+
validator = EnumAttributeValidator.new('String', ["cloud", "local", "raw-tracks", "<not set>"])
|
490
|
+
unless validator.valid?(enable_recording)
|
491
|
+
fail ArgumentError, "invalid value for \"enable_recording\", must be one of #{validator.allowable_values}."
|
492
|
+
end
|
493
|
+
@enable_recording = enable_recording
|
494
|
+
end
|
495
|
+
|
496
|
+
# Custom attribute writer method checking allowed values (enum).
|
497
|
+
# @param [Object] lang Object to be assigned
|
498
|
+
def lang=(lang)
|
499
|
+
validator = EnumAttributeValidator.new('String', ["de", "en", "es", "fi", "fr", "it", "jp", "ka", "nl", "no", "pt", "pt-BR", "pl", "ru", "sv", "tr", "user"])
|
500
|
+
unless validator.valid?(lang)
|
501
|
+
fail ArgumentError, "invalid value for \"lang\", must be one of #{validator.allowable_values}."
|
502
|
+
end
|
503
|
+
@lang = lang
|
504
|
+
end
|
505
|
+
|
506
|
+
# Checks equality by comparing each attribute.
|
507
|
+
# @param [Object] Object to be compared
|
508
|
+
def ==(o)
|
509
|
+
return true if self.equal?(o)
|
510
|
+
self.class == o.class &&
|
511
|
+
nbf == o.nbf &&
|
512
|
+
exp == o.exp &&
|
513
|
+
max_participants == o.max_participants &&
|
514
|
+
enable_people_ui == o.enable_people_ui &&
|
515
|
+
enable_pip_ui == o.enable_pip_ui &&
|
516
|
+
enable_emoji_reactions == o.enable_emoji_reactions &&
|
517
|
+
enable_hand_raising == o.enable_hand_raising &&
|
518
|
+
enable_prejoin_ui == o.enable_prejoin_ui &&
|
519
|
+
enable_network_ui == o.enable_network_ui &&
|
520
|
+
enable_noise_cancellation_ui == o.enable_noise_cancellation_ui &&
|
521
|
+
enable_breakout_rooms == o.enable_breakout_rooms &&
|
522
|
+
enable_knocking == o.enable_knocking &&
|
523
|
+
enable_screenshare == o.enable_screenshare &&
|
524
|
+
enable_video_processing_ui == o.enable_video_processing_ui &&
|
525
|
+
enable_chat == o.enable_chat &&
|
526
|
+
start_video_off == o.start_video_off &&
|
527
|
+
start_audio_off == o.start_audio_off &&
|
528
|
+
owner_only_broadcast == o.owner_only_broadcast &&
|
529
|
+
enable_recording == o.enable_recording &&
|
530
|
+
eject_at_room_exp == o.eject_at_room_exp &&
|
531
|
+
eject_after_elapsed == o.eject_after_elapsed &&
|
532
|
+
enable_advanced_chat == o.enable_advanced_chat &&
|
533
|
+
enable_hidden_participants == o.enable_hidden_participants &&
|
534
|
+
enable_mesh_sfu == o.enable_mesh_sfu &&
|
535
|
+
sfu_switchover == o.sfu_switchover &&
|
536
|
+
experimental_optimize_large_calls == o.experimental_optimize_large_calls &&
|
537
|
+
lang == o.lang &&
|
538
|
+
meeting_join_hook == o.meeting_join_hook &&
|
539
|
+
geo == o.geo &&
|
540
|
+
rtmp_geo == o.rtmp_geo &&
|
541
|
+
disable_rtmp_geo_fallback == o.disable_rtmp_geo_fallback &&
|
542
|
+
recordings_bucket == o.recordings_bucket &&
|
543
|
+
enable_terse_logging == o.enable_terse_logging &&
|
544
|
+
auto_transcription_settings == o.auto_transcription_settings &&
|
545
|
+
enable_transcription_storage == o.enable_transcription_storage &&
|
546
|
+
transcription_bucket == o.transcription_bucket &&
|
547
|
+
recordings_template == o.recordings_template &&
|
548
|
+
streaming_endpoints == o.streaming_endpoints &&
|
549
|
+
permissions == o.permissions
|
550
|
+
end
|
551
|
+
|
552
|
+
# @see the `==` method
|
553
|
+
# @param [Object] Object to be compared
|
554
|
+
def eql?(o)
|
555
|
+
self == o
|
556
|
+
end
|
557
|
+
|
558
|
+
# Calculates hash code according to all attributes.
|
559
|
+
# @return [Integer] Hash code
|
560
|
+
def hash
|
561
|
+
[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
|
562
|
+
end
|
563
|
+
|
564
|
+
# Builds the object from hash
|
565
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
566
|
+
# @return [Object] Returns the model itself
|
567
|
+
def self.build_from_hash(attributes)
|
568
|
+
return nil unless attributes.is_a?(Hash)
|
569
|
+
attributes = attributes.transform_keys(&:to_sym)
|
570
|
+
transformed_hash = {}
|
571
|
+
openapi_types.each_pair do |key, type|
|
572
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
573
|
+
transformed_hash["#{key}"] = nil
|
574
|
+
elsif type =~ /\AArray<(.*)>/i
|
575
|
+
# check to ensure the input is an array given that the attribute
|
576
|
+
# is documented as an array but the input is not
|
577
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
578
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
579
|
+
end
|
580
|
+
elsif !attributes[attribute_map[key]].nil?
|
581
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
582
|
+
end
|
583
|
+
end
|
584
|
+
new(transformed_hash)
|
585
|
+
end
|
586
|
+
|
587
|
+
# Deserializes the data based on type
|
588
|
+
# @param string type Data type
|
589
|
+
# @param string value Value to be deserialized
|
590
|
+
# @return [Object] Deserialized data
|
591
|
+
def self._deserialize(type, value)
|
592
|
+
case type.to_sym
|
593
|
+
when :Time
|
594
|
+
Time.parse(value)
|
595
|
+
when :Date
|
596
|
+
Date.parse(value)
|
597
|
+
when :String
|
598
|
+
value.to_s
|
599
|
+
when :Integer
|
600
|
+
value.to_i
|
601
|
+
when :Float
|
602
|
+
value.to_f
|
603
|
+
when :Boolean
|
604
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
605
|
+
true
|
606
|
+
else
|
607
|
+
false
|
608
|
+
end
|
609
|
+
when :Object
|
610
|
+
# generic object (usually a Hash), return directly
|
611
|
+
value
|
612
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
613
|
+
inner_type = Regexp.last_match[:inner_type]
|
614
|
+
value.map { |v| _deserialize(inner_type, v) }
|
615
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
616
|
+
k_type = Regexp.last_match[:k_type]
|
617
|
+
v_type = Regexp.last_match[:v_type]
|
618
|
+
{}.tap do |hash|
|
619
|
+
value.each do |k, v|
|
620
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
621
|
+
end
|
622
|
+
end
|
623
|
+
else # model
|
624
|
+
# models (e.g. Pet) or oneOf
|
625
|
+
klass = Daily.const_get(type)
|
626
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
627
|
+
end
|
628
|
+
end
|
629
|
+
|
630
|
+
# Returns the string representation of the object
|
631
|
+
# @return [String] String presentation of the object
|
632
|
+
def to_s
|
633
|
+
to_hash.to_s
|
634
|
+
end
|
635
|
+
|
636
|
+
# to_body is an alias to to_hash (backward compatibility)
|
637
|
+
# @return [Hash] Returns the object in the form of hash
|
638
|
+
def to_body
|
639
|
+
to_hash
|
640
|
+
end
|
641
|
+
|
642
|
+
# Returns the object in the form of hash
|
643
|
+
# @return [Hash] Returns the object in the form of hash
|
644
|
+
def to_hash
|
645
|
+
hash = {}
|
646
|
+
self.class.attribute_map.each_pair do |attr, param|
|
647
|
+
value = self.send(attr)
|
648
|
+
if value.nil?
|
649
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
650
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
651
|
+
end
|
652
|
+
|
653
|
+
hash[param] = _to_hash(value)
|
654
|
+
end
|
655
|
+
hash
|
656
|
+
end
|
657
|
+
|
658
|
+
# Outputs non-array value in the form of hash
|
659
|
+
# For object, use to_hash. Otherwise, just return the value
|
660
|
+
# @param [Object] value Any valid value
|
661
|
+
# @return [Hash] Returns the value in the form of hash
|
662
|
+
def _to_hash(value)
|
663
|
+
if value.is_a?(Array)
|
664
|
+
value.compact.map { |v| _to_hash(v) }
|
665
|
+
elsif value.is_a?(Hash)
|
666
|
+
{}.tap do |hash|
|
667
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
668
|
+
end
|
669
|
+
elsif value.respond_to? :to_hash
|
670
|
+
value.to_hash
|
671
|
+
else
|
672
|
+
value
|
673
|
+
end
|
674
|
+
end
|
675
|
+
|
676
|
+
end
|
677
|
+
|
678
|
+
end
|