daily-ruby 0.0.2 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +7 -5
- data/README.md +248 -79
- data/daily-ruby-1.0.0.gem +0 -0
- data/daily-ruby.gemspec +6 -5
- data/docs/BatchProcessorError.md +24 -0
- data/docs/BatchProcessorErrorPayload.md +26 -0
- data/docs/BatchProcessorErrorPayloadInput.md +24 -0
- data/docs/BatchProcessorJobFinished.md +24 -0
- data/docs/BatchProcessorJobFinishedPayload.md +26 -0
- data/docs/BatchProcessorJobFinishedPayloadInput.md +24 -0
- data/docs/BatchProcessorJobFinishedPayloadOutput.md +24 -0
- data/docs/BatchProcessorJobFinishedPayloadOutputConcept.md +20 -0
- data/docs/BatchProcessorJobFinishedPayloadOutputSoap.md +20 -0
- data/docs/BatchProcessorJobFinishedPayloadOutputSoapS3Config.md +22 -0
- data/docs/BatchProcessorJobFinishedPayloadOutputSummary.md +20 -0
- data/docs/BatchProcessorJobFinishedPayloadOutputTranscriptionInner.md +20 -0
- 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/BuyPhoneNumberRequest.md +18 -0
- data/docs/CreateMeetingToken200Response.md +18 -0
- 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/DailyStreamingCustomLayoutConfigCompositionParamsValue.md +15 -0
- data/docs/DailyStreamingDefaultLayoutConfig.md +20 -0
- data/docs/DailyStreamingEndpoint.md +18 -0
- 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/DialinApi.md +80 -0
- data/docs/DialoutProperties.md +26 -0
- data/docs/DialoutPropertiesCodecs.md +20 -0
- data/docs/Domain.md +18 -0
- data/docs/DomainApi.md +149 -0
- data/docs/DomainProperties.md +84 -0
- data/docs/Eject200Response.md +18 -0
- data/docs/EjectRequest.md +22 -0
- data/docs/GetDomainConfig200Response.md +22 -0
- data/docs/GetDomainConfig200ResponseConfig.md +56 -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/MeetingEnded.md +24 -0
- data/docs/MeetingEndedPayload.md +24 -0
- data/docs/MeetingParticipantsGetRes.md +18 -0
- data/docs/MeetingParticipantsGetResDataInner.md +28 -0
- data/docs/MeetingStarted.md +24 -0
- data/docs/MeetingStartedPayload.md +22 -0
- data/docs/MeetingTokensApi.md +92 -14
- data/docs/MeetingsApi.md +247 -0
- data/docs/MeetingsMeetingGetRes.md +28 -0
- data/docs/ParticipantJoined.md +24 -0
- data/docs/ParticipantJoinedPayload.md +32 -0
- data/docs/ParticipantJoinedPayloadPermissions.md +22 -0
- data/docs/ParticipantLeft.md +24 -0
- data/docs/ParticipantLeftPayload.md +34 -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/PhoneNumbersApi.md +304 -0
- data/docs/PinDialinInner.md +22 -0
- data/docs/PinDialinInnerIvrGreeting.md +18 -0
- data/docs/PinlessCallUpdateRequest.md +22 -0
- data/docs/PinlessDialinInner.md +24 -0
- data/docs/PostWebhook.md +26 -0
- data/docs/PresenceApi.md +74 -0
- data/docs/Properties.md +62 -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/RoomDialOutSendDTMFRequest.md +20 -0
- data/docs/RoomDialOutStopRequest.md +18 -0
- data/docs/RoomProperties.md +104 -0
- data/docs/RoomPropertiesStreamingEndpointsInner.md +28 -0
- data/docs/RoomPropertiesStreamingEndpointsInnerHlsConfigVariantsInner.md +26 -0
- data/docs/RoomSipCallTransferRequest.md +20 -0
- data/docs/RoomsApi.md +1794 -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 +34 -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 +26 -0
- data/docs/ValidateMeetingToken200Response.md +28 -0
- data/docs/WaitingParticipantJoined.md +24 -0
- data/docs/WaitingParticipantJoinedPayload.md +32 -0
- data/docs/WaitingParticipantLeft.md +24 -0
- data/docs/WaitingParticipantLeftPayload.md +34 -0
- data/docs/Webhook.md +40 -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/dialin_api.rb +86 -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 +83 -17
- data/lib/daily-ruby/api/meetings_api.rb +238 -0
- data/lib/daily-ruby/api/phone_numbers_api.rb +281 -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 +1652 -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 +38 -32
- data/lib/daily-ruby/api_error.rb +5 -5
- data/lib/daily-ruby/configuration.rb +30 -8
- data/lib/daily-ruby/models/batch_processor_error.rb +278 -0
- data/lib/daily-ruby/models/batch_processor_error_payload.rb +289 -0
- data/lib/daily-ruby/models/batch_processor_error_payload_input.rb +280 -0
- data/lib/daily-ruby/models/batch_processor_job_finished.rb +278 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload.rb +288 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_input.rb +280 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_output.rb +245 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_output_concept.rb +259 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_output_soap.rb +259 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_output_soap_s3_config.rb +236 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_output_summary.rb +259 -0
- data/lib/daily-ruby/models/batch_processor_job_finished_payload_output_transcription_inner.rb +258 -0
- data/lib/daily-ruby/models/batch_room_create_request.rb +216 -0
- 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/{room_not_found_response.rb → buy_phone_number_request.rb} +16 -25
- data/lib/daily-ruby/models/{meeting_token_response.rb → create_meeting_token200_response.rb} +8 -10
- data/lib/daily-ruby/models/create_meeting_token_request.rb +214 -0
- 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} +7 -7
- data/lib/daily-ruby/models/{room_request.rb → daily_streaming_active_participant_layout_config.rb} +30 -42
- 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_custom_layout_config_composition_params_value.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 +41 -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/dialout_properties.rb +254 -0
- data/lib/daily-ruby/models/dialout_properties_codecs.rb +228 -0
- data/lib/daily-ruby/models/{meeting_token_request.rb → domain.rb} +9 -10
- data/lib/daily-ruby/models/domain_properties.rb +628 -0
- data/lib/daily-ruby/models/eject200_response.rb +216 -0
- data/lib/daily-ruby/models/eject_request.rb +241 -0
- data/lib/daily-ruby/models/get_domain_config200_response.rb +271 -0
- data/lib/daily-ruby/models/get_domain_config200_response_config.rb +404 -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 +233 -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_ended.rb +278 -0
- data/lib/daily-ruby/models/{server_error_response.rb → meeting_ended_payload.rb} +47 -17
- data/lib/daily-ruby/models/meeting_participants_get_res.rb +216 -0
- data/lib/daily-ruby/models/meeting_participants_get_res_data_inner.rb +259 -0
- data/lib/daily-ruby/models/meeting_started.rb +278 -0
- data/lib/daily-ruby/models/meeting_started_payload.rb +236 -0
- data/lib/daily-ruby/models/meetings_meeting_get_res.rb +259 -0
- data/lib/daily-ruby/models/participant_joined.rb +278 -0
- data/lib/daily-ruby/models/participant_joined_payload.rb +285 -0
- data/lib/daily-ruby/models/participant_joined_payload_permissions.rb +240 -0
- data/lib/daily-ruby/models/participant_left.rb +278 -0
- data/lib/daily-ruby/models/participant_left_payload.rb +295 -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/pin_dialin_inner.rb +234 -0
- data/lib/daily-ruby/models/pin_dialin_inner_ivr_greeting.rb +215 -0
- data/lib/daily-ruby/models/pinless_call_update_request.rb +235 -0
- data/lib/daily-ruby/models/pinless_dialin_inner.rb +245 -0
- data/lib/daily-ruby/models/post_webhook.rb +291 -0
- data/lib/daily-ruby/models/{meeting_token_request_properties.rb → properties.rb} +83 -21
- 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_dial_out_send_dtmf_request.rb +224 -0
- data/lib/daily-ruby/models/{room_deleted_response.rb → room_dial_out_stop_request.rb} +16 -25
- data/lib/daily-ruby/models/room_properties.rb +736 -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_sip_call_transfer_request.rb +224 -0
- data/lib/daily-ruby/models/{room_response.rb → rooms_room_name_get_res.rb} +23 -13
- 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 +293 -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/update_permissions_request.rb +216 -0
- data/lib/daily-ruby/models/{meeting_token_request_properties_permissions.rb → update_permissions_request_data_value.rb} +14 -13
- data/lib/daily-ruby/models/{meeting_token_request_properties_permissions_can_admin.rb → update_permissions_request_data_value_can_send.rb} +6 -6
- data/lib/daily-ruby/models/update_webhook.rb +291 -0
- data/lib/daily-ruby/models/validate_meeting_token200_response.rb +265 -0
- data/lib/daily-ruby/models/waiting_participant_joined.rb +278 -0
- data/lib/daily-ruby/models/waiting_participant_joined_payload.rb +285 -0
- data/lib/daily-ruby/models/waiting_participant_left.rb +278 -0
- data/lib/daily-ruby/models/waiting_participant_left_payload.rb +295 -0
- data/lib/daily-ruby/models/webhook.rb +361 -0
- data/lib/daily-ruby/version.rb +6 -6
- data/lib/daily-ruby.rb +140 -18
- data/run.sh +3 -3
- data/spec/api/batch_rooms_api_spec.rb +58 -0
- data/spec/api/dialin_api_spec.rb +47 -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 +21 -8
- data/spec/api/meetings_api_spec.rb +81 -0
- data/spec/api/phone_numbers_api_spec.rb +87 -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_processor_error_payload_input_spec.rb +58 -0
- data/spec/models/batch_processor_error_payload_spec.rb +64 -0
- data/spec/models/batch_processor_error_spec.rb +58 -0
- data/spec/models/batch_processor_job_finished_payload_input_spec.rb +58 -0
- data/spec/models/batch_processor_job_finished_payload_output_concept_spec.rb +46 -0
- data/spec/models/batch_processor_job_finished_payload_output_soap_s3_config_spec.rb +48 -0
- data/spec/models/batch_processor_job_finished_payload_output_soap_spec.rb +46 -0
- data/spec/models/batch_processor_job_finished_payload_output_spec.rb +54 -0
- data/spec/models/batch_processor_job_finished_payload_output_summary_spec.rb +46 -0
- data/spec/models/batch_processor_job_finished_payload_output_transcription_inner_spec.rb +46 -0
- data/spec/models/batch_processor_job_finished_payload_spec.rb +64 -0
- data/spec/models/batch_processor_job_finished_spec.rb +58 -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/buy_phone_number_request_spec.rb +36 -0
- data/spec/models/create_meeting_token200_response_spec.rb +36 -0
- 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_composition_params_value_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/dialout_properties_codecs_spec.rb +42 -0
- data/spec/models/dialout_properties_spec.rb +60 -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_ended_payload_spec.rb +54 -0
- data/spec/models/meeting_ended_spec.rb +58 -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/meeting_started_payload_spec.rb +48 -0
- data/spec/models/meeting_started_spec.rb +58 -0
- data/spec/models/meetings_meeting_get_res_spec.rb +66 -0
- data/spec/models/participant_joined_payload_permissions_spec.rb +48 -0
- data/spec/models/participant_joined_payload_spec.rb +78 -0
- data/spec/models/participant_joined_spec.rb +58 -0
- data/spec/models/participant_left_payload_spec.rb +84 -0
- data/spec/models/participant_left_spec.rb +58 -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/pin_dialin_inner_ivr_greeting_spec.rb +36 -0
- data/spec/models/pin_dialin_inner_spec.rb +48 -0
- data/spec/models/pinless_call_update_request_spec.rb +48 -0
- data/spec/models/pinless_dialin_inner_spec.rb +54 -0
- 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_dial_out_send_dtmf_request_spec.rb +42 -0
- data/spec/models/room_dial_out_stop_request_spec.rb +36 -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_sip_call_transfer_request_spec.rb +42 -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/waiting_participant_joined_payload_spec.rb +78 -0
- data/spec/models/waiting_participant_joined_spec.rb +58 -0
- data/spec/models/waiting_participant_left_payload_spec.rb +84 -0
- data/spec/models/waiting_participant_left_spec.rb +58 -0
- data/spec/models/webhook_spec.rb +100 -0
- data/spec/spec_helper.rb +5 -5
- metadata +563 -56
- data/daily.yaml +0 -460
- data/docs/MeetingTokenRequest.md +0 -18
- data/docs/MeetingTokenRequestProperties.md +0 -56
- data/docs/MeetingTokenRequestPropertiesPermissions.md +0 -22
- data/docs/MeetingTokenResponse.md +0 -18
- data/docs/RoomApi.md +0 -297
- 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/docs/ServerErrorResponse.md +0 -18
- data/lib/daily-ruby/api/room_api.rb +0 -281
- data/lib/daily-ruby/models/room_request_properties.rb +0 -521
- data/spec/api/room_api_spec.rb +0 -86
- data/spec/models/meeting_token_request_spec.rb +0 -36
- data/spec/models/meeting_token_response_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
data/docs/RoomsApi.md
ADDED
@@ -0,0 +1,1794 @@
|
|
1
|
+
# Daily::RoomsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.daily.co/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_room**](RoomsApi.md#create_room) | **POST** /rooms | /rooms |
|
8
|
+
| [**delete_room**](RoomsApi.md#delete_room) | **DELETE** /rooms/{room_name} | rooms/:name |
|
9
|
+
| [**eject**](RoomsApi.md#eject) | **POST** /rooms/{room_name}/eject | rooms/:name/eject |
|
10
|
+
| [**get_room_config**](RoomsApi.md#get_room_config) | **GET** /rooms/{room_name} | rooms/:name |
|
11
|
+
| [**get_room_presence**](RoomsApi.md#get_room_presence) | **GET** /rooms/{room_name}/presence | rooms/:name/presence |
|
12
|
+
| [**get_session_data**](RoomsApi.md#get_session_data) | **GET** /rooms/{room_name}/get-session-data | rooms/:name/get-session-data |
|
13
|
+
| [**list_rooms**](RoomsApi.md#list_rooms) | **GET** /rooms | /rooms |
|
14
|
+
| [**room_dial_out_send_dtmf**](RoomsApi.md#room_dial_out_send_dtmf) | **POST** /rooms/{room_name}/dialOut/sendDTMF | rooms/:name/dialOut/sendDTMF |
|
15
|
+
| [**room_dial_out_start**](RoomsApi.md#room_dial_out_start) | **POST** /rooms/{room_name}/dialOut/start | rooms/:name/dialOut/start |
|
16
|
+
| [**room_dial_out_stop**](RoomsApi.md#room_dial_out_stop) | **POST** /rooms/{room_name}/dialOut/stop | rooms/:name/dialOut/stop |
|
17
|
+
| [**room_livestreaming_start**](RoomsApi.md#room_livestreaming_start) | **POST** /rooms/{room_name}/live-streaming/start | rooms/:name/live-streaming/start |
|
18
|
+
| [**room_livestreaming_stop**](RoomsApi.md#room_livestreaming_stop) | **POST** /rooms/{room_name}/live-streaming/stop | rooms/:name/live-streaming/stop |
|
19
|
+
| [**room_livestreaming_update**](RoomsApi.md#room_livestreaming_update) | **POST** /rooms/{room_name}/live-streaming/update | rooms/:name/live-streaming/update |
|
20
|
+
| [**room_recordings_start**](RoomsApi.md#room_recordings_start) | **POST** /rooms/{room_name}/recordings/start | rooms/:name/recordings/start |
|
21
|
+
| [**room_recordings_stop**](RoomsApi.md#room_recordings_stop) | **POST** /rooms/{room_name}/recordings/stop | rooms/:name/recordings/stop |
|
22
|
+
| [**room_recordings_update**](RoomsApi.md#room_recordings_update) | **POST** /rooms/{room_name}/recordings/update | rooms/:name/recordings/update |
|
23
|
+
| [**room_sip_call_transfer**](RoomsApi.md#room_sip_call_transfer) | **POST** /rooms/{room_name}/sipCallTransfer | rooms/:name/sipCallTransfer |
|
24
|
+
| [**room_sip_refer**](RoomsApi.md#room_sip_refer) | **POST** /rooms/{room_name}/sipRefer | rooms/:name/sipRefer |
|
25
|
+
| [**room_transcription_start**](RoomsApi.md#room_transcription_start) | **POST** /rooms/{room_name}/transcription/start | rooms/:name/transcription/start |
|
26
|
+
| [**room_transcription_stop**](RoomsApi.md#room_transcription_stop) | **POST** /rooms/{room_name}/transcription/stop | rooms/:name/transcription/stop |
|
27
|
+
| [**send_app_message**](RoomsApi.md#send_app_message) | **POST** /rooms/{room_name}/send-app-message | rooms/:name/send-app-message |
|
28
|
+
| [**set_room_config**](RoomsApi.md#set_room_config) | **POST** /rooms/{room_name} | rooms/:name |
|
29
|
+
| [**set_session_data**](RoomsApi.md#set_session_data) | **POST** /rooms/{room_name}/set-session-data | rooms/:name/set-session-data |
|
30
|
+
| [**update_permissions**](RoomsApi.md#update_permissions) | **POST** /rooms/{room_name}/update-permissions | rooms/:name/update-permissions |
|
31
|
+
|
32
|
+
|
33
|
+
## create_room
|
34
|
+
|
35
|
+
> <CreateRoom200Response> create_room(opts)
|
36
|
+
|
37
|
+
/rooms
|
38
|
+
|
39
|
+
Create a room
|
40
|
+
|
41
|
+
### Examples
|
42
|
+
|
43
|
+
```ruby
|
44
|
+
require 'time'
|
45
|
+
require 'daily-ruby'
|
46
|
+
# setup authorization
|
47
|
+
Daily.configure do |config|
|
48
|
+
# Configure API key authorization: sec0
|
49
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
50
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
51
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
52
|
+
end
|
53
|
+
|
54
|
+
api_instance = Daily::RoomsApi.new
|
55
|
+
opts = {
|
56
|
+
create_room_request: Daily::CreateRoomRequest.new # CreateRoomRequest |
|
57
|
+
}
|
58
|
+
|
59
|
+
begin
|
60
|
+
# /rooms
|
61
|
+
result = api_instance.create_room(opts)
|
62
|
+
p result
|
63
|
+
rescue Daily::ApiError => e
|
64
|
+
puts "Error when calling RoomsApi->create_room: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
#### Using the create_room_with_http_info variant
|
69
|
+
|
70
|
+
This returns an Array which contains the response data, status code and headers.
|
71
|
+
|
72
|
+
> <Array(<CreateRoom200Response>, Integer, Hash)> create_room_with_http_info(opts)
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
begin
|
76
|
+
# /rooms
|
77
|
+
data, status_code, headers = api_instance.create_room_with_http_info(opts)
|
78
|
+
p status_code # => 2xx
|
79
|
+
p headers # => { ... }
|
80
|
+
p data # => <CreateRoom200Response>
|
81
|
+
rescue Daily::ApiError => e
|
82
|
+
puts "Error when calling RoomsApi->create_room_with_http_info: #{e}"
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
### Parameters
|
87
|
+
|
88
|
+
| Name | Type | Description | Notes |
|
89
|
+
| ---- | ---- | ----------- | ----- |
|
90
|
+
| **create_room_request** | [**CreateRoomRequest**](CreateRoomRequest.md) | | [optional] |
|
91
|
+
|
92
|
+
### Return type
|
93
|
+
|
94
|
+
[**CreateRoom200Response**](CreateRoom200Response.md)
|
95
|
+
|
96
|
+
### Authorization
|
97
|
+
|
98
|
+
[sec0](../README.md#sec0)
|
99
|
+
|
100
|
+
### HTTP request headers
|
101
|
+
|
102
|
+
- **Content-Type**: application/json
|
103
|
+
- **Accept**: application/json
|
104
|
+
|
105
|
+
|
106
|
+
## delete_room
|
107
|
+
|
108
|
+
> Object delete_room(room_name)
|
109
|
+
|
110
|
+
rooms/:name
|
111
|
+
|
112
|
+
Delete a room
|
113
|
+
|
114
|
+
### Examples
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
require 'time'
|
118
|
+
require 'daily-ruby'
|
119
|
+
# setup authorization
|
120
|
+
Daily.configure do |config|
|
121
|
+
# Configure API key authorization: sec0
|
122
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
125
|
+
end
|
126
|
+
|
127
|
+
api_instance = Daily::RoomsApi.new
|
128
|
+
room_name = 'room_name_example' # String |
|
129
|
+
|
130
|
+
begin
|
131
|
+
# rooms/:name
|
132
|
+
result = api_instance.delete_room(room_name)
|
133
|
+
p result
|
134
|
+
rescue Daily::ApiError => e
|
135
|
+
puts "Error when calling RoomsApi->delete_room: #{e}"
|
136
|
+
end
|
137
|
+
```
|
138
|
+
|
139
|
+
#### Using the delete_room_with_http_info variant
|
140
|
+
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
142
|
+
|
143
|
+
> <Array(Object, Integer, Hash)> delete_room_with_http_info(room_name)
|
144
|
+
|
145
|
+
```ruby
|
146
|
+
begin
|
147
|
+
# rooms/:name
|
148
|
+
data, status_code, headers = api_instance.delete_room_with_http_info(room_name)
|
149
|
+
p status_code # => 2xx
|
150
|
+
p headers # => { ... }
|
151
|
+
p data # => Object
|
152
|
+
rescue Daily::ApiError => e
|
153
|
+
puts "Error when calling RoomsApi->delete_room_with_http_info: #{e}"
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
### Parameters
|
158
|
+
|
159
|
+
| Name | Type | Description | Notes |
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
161
|
+
| **room_name** | **String** | | |
|
162
|
+
|
163
|
+
### Return type
|
164
|
+
|
165
|
+
**Object**
|
166
|
+
|
167
|
+
### Authorization
|
168
|
+
|
169
|
+
[sec0](../README.md#sec0)
|
170
|
+
|
171
|
+
### HTTP request headers
|
172
|
+
|
173
|
+
- **Content-Type**: Not defined
|
174
|
+
- **Accept**: application/json
|
175
|
+
|
176
|
+
|
177
|
+
## eject
|
178
|
+
|
179
|
+
> <Eject200Response> eject(room_name, opts)
|
180
|
+
|
181
|
+
rooms/:name/eject
|
182
|
+
|
183
|
+
Ejects participants from a room
|
184
|
+
|
185
|
+
### Examples
|
186
|
+
|
187
|
+
```ruby
|
188
|
+
require 'time'
|
189
|
+
require 'daily-ruby'
|
190
|
+
# setup authorization
|
191
|
+
Daily.configure do |config|
|
192
|
+
# Configure API key authorization: sec0
|
193
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
194
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
195
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
196
|
+
end
|
197
|
+
|
198
|
+
api_instance = Daily::RoomsApi.new
|
199
|
+
room_name = 'room_name_example' # String |
|
200
|
+
opts = {
|
201
|
+
eject_request: Daily::EjectRequest.new # EjectRequest |
|
202
|
+
}
|
203
|
+
|
204
|
+
begin
|
205
|
+
# rooms/:name/eject
|
206
|
+
result = api_instance.eject(room_name, opts)
|
207
|
+
p result
|
208
|
+
rescue Daily::ApiError => e
|
209
|
+
puts "Error when calling RoomsApi->eject: #{e}"
|
210
|
+
end
|
211
|
+
```
|
212
|
+
|
213
|
+
#### Using the eject_with_http_info variant
|
214
|
+
|
215
|
+
This returns an Array which contains the response data, status code and headers.
|
216
|
+
|
217
|
+
> <Array(<Eject200Response>, Integer, Hash)> eject_with_http_info(room_name, opts)
|
218
|
+
|
219
|
+
```ruby
|
220
|
+
begin
|
221
|
+
# rooms/:name/eject
|
222
|
+
data, status_code, headers = api_instance.eject_with_http_info(room_name, opts)
|
223
|
+
p status_code # => 2xx
|
224
|
+
p headers # => { ... }
|
225
|
+
p data # => <Eject200Response>
|
226
|
+
rescue Daily::ApiError => e
|
227
|
+
puts "Error when calling RoomsApi->eject_with_http_info: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
### Parameters
|
232
|
+
|
233
|
+
| Name | Type | Description | Notes |
|
234
|
+
| ---- | ---- | ----------- | ----- |
|
235
|
+
| **room_name** | **String** | | |
|
236
|
+
| **eject_request** | [**EjectRequest**](EjectRequest.md) | | [optional] |
|
237
|
+
|
238
|
+
### Return type
|
239
|
+
|
240
|
+
[**Eject200Response**](Eject200Response.md)
|
241
|
+
|
242
|
+
### Authorization
|
243
|
+
|
244
|
+
[sec0](../README.md#sec0)
|
245
|
+
|
246
|
+
### HTTP request headers
|
247
|
+
|
248
|
+
- **Content-Type**: application/json
|
249
|
+
- **Accept**: application/json
|
250
|
+
|
251
|
+
|
252
|
+
## get_room_config
|
253
|
+
|
254
|
+
> <RoomsRoomNameGetRes> get_room_config(room_name)
|
255
|
+
|
256
|
+
rooms/:name
|
257
|
+
|
258
|
+
Get info about a room
|
259
|
+
|
260
|
+
### Examples
|
261
|
+
|
262
|
+
```ruby
|
263
|
+
require 'time'
|
264
|
+
require 'daily-ruby'
|
265
|
+
# setup authorization
|
266
|
+
Daily.configure do |config|
|
267
|
+
# Configure API key authorization: sec0
|
268
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
269
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
270
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
271
|
+
end
|
272
|
+
|
273
|
+
api_instance = Daily::RoomsApi.new
|
274
|
+
room_name = 'room_name_example' # String |
|
275
|
+
|
276
|
+
begin
|
277
|
+
# rooms/:name
|
278
|
+
result = api_instance.get_room_config(room_name)
|
279
|
+
p result
|
280
|
+
rescue Daily::ApiError => e
|
281
|
+
puts "Error when calling RoomsApi->get_room_config: #{e}"
|
282
|
+
end
|
283
|
+
```
|
284
|
+
|
285
|
+
#### Using the get_room_config_with_http_info variant
|
286
|
+
|
287
|
+
This returns an Array which contains the response data, status code and headers.
|
288
|
+
|
289
|
+
> <Array(<RoomsRoomNameGetRes>, Integer, Hash)> get_room_config_with_http_info(room_name)
|
290
|
+
|
291
|
+
```ruby
|
292
|
+
begin
|
293
|
+
# rooms/:name
|
294
|
+
data, status_code, headers = api_instance.get_room_config_with_http_info(room_name)
|
295
|
+
p status_code # => 2xx
|
296
|
+
p headers # => { ... }
|
297
|
+
p data # => <RoomsRoomNameGetRes>
|
298
|
+
rescue Daily::ApiError => e
|
299
|
+
puts "Error when calling RoomsApi->get_room_config_with_http_info: #{e}"
|
300
|
+
end
|
301
|
+
```
|
302
|
+
|
303
|
+
### Parameters
|
304
|
+
|
305
|
+
| Name | Type | Description | Notes |
|
306
|
+
| ---- | ---- | ----------- | ----- |
|
307
|
+
| **room_name** | **String** | | |
|
308
|
+
|
309
|
+
### Return type
|
310
|
+
|
311
|
+
[**RoomsRoomNameGetRes**](RoomsRoomNameGetRes.md)
|
312
|
+
|
313
|
+
### Authorization
|
314
|
+
|
315
|
+
[sec0](../README.md#sec0)
|
316
|
+
|
317
|
+
### HTTP request headers
|
318
|
+
|
319
|
+
- **Content-Type**: Not defined
|
320
|
+
- **Accept**: application/json
|
321
|
+
|
322
|
+
|
323
|
+
## get_room_presence
|
324
|
+
|
325
|
+
> <RoomsRoomNamePresenceGetRes> get_room_presence(room_name, opts)
|
326
|
+
|
327
|
+
rooms/:name/presence
|
328
|
+
|
329
|
+
Get a presence snapshot for a room
|
330
|
+
|
331
|
+
### Examples
|
332
|
+
|
333
|
+
```ruby
|
334
|
+
require 'time'
|
335
|
+
require 'daily-ruby'
|
336
|
+
# setup authorization
|
337
|
+
Daily.configure do |config|
|
338
|
+
# Configure API key authorization: sec0
|
339
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
341
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
342
|
+
end
|
343
|
+
|
344
|
+
api_instance = Daily::RoomsApi.new
|
345
|
+
room_name = 'room_name_example' # String | The name of the room
|
346
|
+
opts = {
|
347
|
+
limit: 56, # Integer | Sets the number of participants returned.
|
348
|
+
user_id: 'user_id_example', # String | Returns presence for the user with the given userId, if available. The userId is specified via a [meeting token](/reference/rest-api/meeting-tokens/config#user_id).
|
349
|
+
user_name: 'user_name_example' # String | Returns presence for the user with the given name, if available.
|
350
|
+
}
|
351
|
+
|
352
|
+
begin
|
353
|
+
# rooms/:name/presence
|
354
|
+
result = api_instance.get_room_presence(room_name, opts)
|
355
|
+
p result
|
356
|
+
rescue Daily::ApiError => e
|
357
|
+
puts "Error when calling RoomsApi->get_room_presence: #{e}"
|
358
|
+
end
|
359
|
+
```
|
360
|
+
|
361
|
+
#### Using the get_room_presence_with_http_info variant
|
362
|
+
|
363
|
+
This returns an Array which contains the response data, status code and headers.
|
364
|
+
|
365
|
+
> <Array(<RoomsRoomNamePresenceGetRes>, Integer, Hash)> get_room_presence_with_http_info(room_name, opts)
|
366
|
+
|
367
|
+
```ruby
|
368
|
+
begin
|
369
|
+
# rooms/:name/presence
|
370
|
+
data, status_code, headers = api_instance.get_room_presence_with_http_info(room_name, opts)
|
371
|
+
p status_code # => 2xx
|
372
|
+
p headers # => { ... }
|
373
|
+
p data # => <RoomsRoomNamePresenceGetRes>
|
374
|
+
rescue Daily::ApiError => e
|
375
|
+
puts "Error when calling RoomsApi->get_room_presence_with_http_info: #{e}"
|
376
|
+
end
|
377
|
+
```
|
378
|
+
|
379
|
+
### Parameters
|
380
|
+
|
381
|
+
| Name | Type | Description | Notes |
|
382
|
+
| ---- | ---- | ----------- | ----- |
|
383
|
+
| **room_name** | **String** | The name of the room | |
|
384
|
+
| **limit** | **Integer** | Sets the number of participants returned. | [optional] |
|
385
|
+
| **user_id** | **String** | Returns presence for the user with the given userId, if available. The userId is specified via a [meeting token](/reference/rest-api/meeting-tokens/config#user_id). | [optional] |
|
386
|
+
| **user_name** | **String** | Returns presence for the user with the given name, if available. | [optional] |
|
387
|
+
|
388
|
+
### Return type
|
389
|
+
|
390
|
+
[**RoomsRoomNamePresenceGetRes**](RoomsRoomNamePresenceGetRes.md)
|
391
|
+
|
392
|
+
### Authorization
|
393
|
+
|
394
|
+
[sec0](../README.md#sec0)
|
395
|
+
|
396
|
+
### HTTP request headers
|
397
|
+
|
398
|
+
- **Content-Type**: Not defined
|
399
|
+
- **Accept**: application/json
|
400
|
+
|
401
|
+
|
402
|
+
## get_session_data
|
403
|
+
|
404
|
+
> get_session_data(room_name)
|
405
|
+
|
406
|
+
rooms/:name/get-session-data
|
407
|
+
|
408
|
+
Gets meeting session data
|
409
|
+
|
410
|
+
### Examples
|
411
|
+
|
412
|
+
```ruby
|
413
|
+
require 'time'
|
414
|
+
require 'daily-ruby'
|
415
|
+
# setup authorization
|
416
|
+
Daily.configure do |config|
|
417
|
+
# Configure API key authorization: sec0
|
418
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
419
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
420
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
421
|
+
end
|
422
|
+
|
423
|
+
api_instance = Daily::RoomsApi.new
|
424
|
+
room_name = 'room_name_example' # String |
|
425
|
+
|
426
|
+
begin
|
427
|
+
# rooms/:name/get-session-data
|
428
|
+
api_instance.get_session_data(room_name)
|
429
|
+
rescue Daily::ApiError => e
|
430
|
+
puts "Error when calling RoomsApi->get_session_data: #{e}"
|
431
|
+
end
|
432
|
+
```
|
433
|
+
|
434
|
+
#### Using the get_session_data_with_http_info variant
|
435
|
+
|
436
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
437
|
+
|
438
|
+
> <Array(nil, Integer, Hash)> get_session_data_with_http_info(room_name)
|
439
|
+
|
440
|
+
```ruby
|
441
|
+
begin
|
442
|
+
# rooms/:name/get-session-data
|
443
|
+
data, status_code, headers = api_instance.get_session_data_with_http_info(room_name)
|
444
|
+
p status_code # => 2xx
|
445
|
+
p headers # => { ... }
|
446
|
+
p data # => nil
|
447
|
+
rescue Daily::ApiError => e
|
448
|
+
puts "Error when calling RoomsApi->get_session_data_with_http_info: #{e}"
|
449
|
+
end
|
450
|
+
```
|
451
|
+
|
452
|
+
### Parameters
|
453
|
+
|
454
|
+
| Name | Type | Description | Notes |
|
455
|
+
| ---- | ---- | ----------- | ----- |
|
456
|
+
| **room_name** | **String** | | |
|
457
|
+
|
458
|
+
### Return type
|
459
|
+
|
460
|
+
nil (empty response body)
|
461
|
+
|
462
|
+
### Authorization
|
463
|
+
|
464
|
+
[sec0](../README.md#sec0)
|
465
|
+
|
466
|
+
### HTTP request headers
|
467
|
+
|
468
|
+
- **Content-Type**: Not defined
|
469
|
+
- **Accept**: application/json
|
470
|
+
|
471
|
+
|
472
|
+
## list_rooms
|
473
|
+
|
474
|
+
> <ListRooms200Response> list_rooms(opts)
|
475
|
+
|
476
|
+
/rooms
|
477
|
+
|
478
|
+
List rooms
|
479
|
+
|
480
|
+
### Examples
|
481
|
+
|
482
|
+
```ruby
|
483
|
+
require 'time'
|
484
|
+
require 'daily-ruby'
|
485
|
+
# setup authorization
|
486
|
+
Daily.configure do |config|
|
487
|
+
# Configure API key authorization: sec0
|
488
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
489
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
490
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
491
|
+
end
|
492
|
+
|
493
|
+
api_instance = Daily::RoomsApi.new
|
494
|
+
opts = {
|
495
|
+
limit: 56, # Integer | Sets the number of rooms listed
|
496
|
+
ending_before: 'ending_before_example', # String | Returns room objects created before a provided room id
|
497
|
+
starting_after: 'starting_after_example' # String | Returns room objects created after a provided room id
|
498
|
+
}
|
499
|
+
|
500
|
+
begin
|
501
|
+
# /rooms
|
502
|
+
result = api_instance.list_rooms(opts)
|
503
|
+
p result
|
504
|
+
rescue Daily::ApiError => e
|
505
|
+
puts "Error when calling RoomsApi->list_rooms: #{e}"
|
506
|
+
end
|
507
|
+
```
|
508
|
+
|
509
|
+
#### Using the list_rooms_with_http_info variant
|
510
|
+
|
511
|
+
This returns an Array which contains the response data, status code and headers.
|
512
|
+
|
513
|
+
> <Array(<ListRooms200Response>, Integer, Hash)> list_rooms_with_http_info(opts)
|
514
|
+
|
515
|
+
```ruby
|
516
|
+
begin
|
517
|
+
# /rooms
|
518
|
+
data, status_code, headers = api_instance.list_rooms_with_http_info(opts)
|
519
|
+
p status_code # => 2xx
|
520
|
+
p headers # => { ... }
|
521
|
+
p data # => <ListRooms200Response>
|
522
|
+
rescue Daily::ApiError => e
|
523
|
+
puts "Error when calling RoomsApi->list_rooms_with_http_info: #{e}"
|
524
|
+
end
|
525
|
+
```
|
526
|
+
|
527
|
+
### Parameters
|
528
|
+
|
529
|
+
| Name | Type | Description | Notes |
|
530
|
+
| ---- | ---- | ----------- | ----- |
|
531
|
+
| **limit** | **Integer** | Sets the number of rooms listed | [optional] |
|
532
|
+
| **ending_before** | **String** | Returns room objects created before a provided room id | [optional] |
|
533
|
+
| **starting_after** | **String** | Returns room objects created after a provided room id | [optional] |
|
534
|
+
|
535
|
+
### Return type
|
536
|
+
|
537
|
+
[**ListRooms200Response**](ListRooms200Response.md)
|
538
|
+
|
539
|
+
### Authorization
|
540
|
+
|
541
|
+
[sec0](../README.md#sec0)
|
542
|
+
|
543
|
+
### HTTP request headers
|
544
|
+
|
545
|
+
- **Content-Type**: Not defined
|
546
|
+
- **Accept**: application/json
|
547
|
+
|
548
|
+
|
549
|
+
## room_dial_out_send_dtmf
|
550
|
+
|
551
|
+
> room_dial_out_send_dtmf(room_name, opts)
|
552
|
+
|
553
|
+
rooms/:name/dialOut/sendDTMF
|
554
|
+
|
555
|
+
send DTMF digits on the dialout
|
556
|
+
|
557
|
+
### Examples
|
558
|
+
|
559
|
+
```ruby
|
560
|
+
require 'time'
|
561
|
+
require 'daily-ruby'
|
562
|
+
# setup authorization
|
563
|
+
Daily.configure do |config|
|
564
|
+
# Configure API key authorization: sec0
|
565
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
566
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
567
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
568
|
+
end
|
569
|
+
|
570
|
+
api_instance = Daily::RoomsApi.new
|
571
|
+
room_name = 'room_name_example' # String |
|
572
|
+
opts = {
|
573
|
+
room_dial_out_send_dtmf_request: Daily::RoomDialOutSendDTMFRequest.new # RoomDialOutSendDTMFRequest |
|
574
|
+
}
|
575
|
+
|
576
|
+
begin
|
577
|
+
# rooms/:name/dialOut/sendDTMF
|
578
|
+
api_instance.room_dial_out_send_dtmf(room_name, opts)
|
579
|
+
rescue Daily::ApiError => e
|
580
|
+
puts "Error when calling RoomsApi->room_dial_out_send_dtmf: #{e}"
|
581
|
+
end
|
582
|
+
```
|
583
|
+
|
584
|
+
#### Using the room_dial_out_send_dtmf_with_http_info variant
|
585
|
+
|
586
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
587
|
+
|
588
|
+
> <Array(nil, Integer, Hash)> room_dial_out_send_dtmf_with_http_info(room_name, opts)
|
589
|
+
|
590
|
+
```ruby
|
591
|
+
begin
|
592
|
+
# rooms/:name/dialOut/sendDTMF
|
593
|
+
data, status_code, headers = api_instance.room_dial_out_send_dtmf_with_http_info(room_name, opts)
|
594
|
+
p status_code # => 2xx
|
595
|
+
p headers # => { ... }
|
596
|
+
p data # => nil
|
597
|
+
rescue Daily::ApiError => e
|
598
|
+
puts "Error when calling RoomsApi->room_dial_out_send_dtmf_with_http_info: #{e}"
|
599
|
+
end
|
600
|
+
```
|
601
|
+
|
602
|
+
### Parameters
|
603
|
+
|
604
|
+
| Name | Type | Description | Notes |
|
605
|
+
| ---- | ---- | ----------- | ----- |
|
606
|
+
| **room_name** | **String** | | |
|
607
|
+
| **room_dial_out_send_dtmf_request** | [**RoomDialOutSendDTMFRequest**](RoomDialOutSendDTMFRequest.md) | | [optional] |
|
608
|
+
|
609
|
+
### Return type
|
610
|
+
|
611
|
+
nil (empty response body)
|
612
|
+
|
613
|
+
### Authorization
|
614
|
+
|
615
|
+
[sec0](../README.md#sec0)
|
616
|
+
|
617
|
+
### HTTP request headers
|
618
|
+
|
619
|
+
- **Content-Type**: application/json
|
620
|
+
- **Accept**: application/json
|
621
|
+
|
622
|
+
|
623
|
+
## room_dial_out_start
|
624
|
+
|
625
|
+
> room_dial_out_start(room_name, opts)
|
626
|
+
|
627
|
+
rooms/:name/dialOut/start
|
628
|
+
|
629
|
+
Start a dial-out in a room
|
630
|
+
|
631
|
+
### Examples
|
632
|
+
|
633
|
+
```ruby
|
634
|
+
require 'time'
|
635
|
+
require 'daily-ruby'
|
636
|
+
# setup authorization
|
637
|
+
Daily.configure do |config|
|
638
|
+
# Configure API key authorization: sec0
|
639
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
640
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
641
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
642
|
+
end
|
643
|
+
|
644
|
+
api_instance = Daily::RoomsApi.new
|
645
|
+
room_name = 'room_name_example' # String |
|
646
|
+
opts = {
|
647
|
+
dialout_properties: Daily::DialoutProperties.new # DialoutProperties |
|
648
|
+
}
|
649
|
+
|
650
|
+
begin
|
651
|
+
# rooms/:name/dialOut/start
|
652
|
+
api_instance.room_dial_out_start(room_name, opts)
|
653
|
+
rescue Daily::ApiError => e
|
654
|
+
puts "Error when calling RoomsApi->room_dial_out_start: #{e}"
|
655
|
+
end
|
656
|
+
```
|
657
|
+
|
658
|
+
#### Using the room_dial_out_start_with_http_info variant
|
659
|
+
|
660
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
661
|
+
|
662
|
+
> <Array(nil, Integer, Hash)> room_dial_out_start_with_http_info(room_name, opts)
|
663
|
+
|
664
|
+
```ruby
|
665
|
+
begin
|
666
|
+
# rooms/:name/dialOut/start
|
667
|
+
data, status_code, headers = api_instance.room_dial_out_start_with_http_info(room_name, opts)
|
668
|
+
p status_code # => 2xx
|
669
|
+
p headers # => { ... }
|
670
|
+
p data # => nil
|
671
|
+
rescue Daily::ApiError => e
|
672
|
+
puts "Error when calling RoomsApi->room_dial_out_start_with_http_info: #{e}"
|
673
|
+
end
|
674
|
+
```
|
675
|
+
|
676
|
+
### Parameters
|
677
|
+
|
678
|
+
| Name | Type | Description | Notes |
|
679
|
+
| ---- | ---- | ----------- | ----- |
|
680
|
+
| **room_name** | **String** | | |
|
681
|
+
| **dialout_properties** | [**DialoutProperties**](DialoutProperties.md) | | [optional] |
|
682
|
+
|
683
|
+
### Return type
|
684
|
+
|
685
|
+
nil (empty response body)
|
686
|
+
|
687
|
+
### Authorization
|
688
|
+
|
689
|
+
[sec0](../README.md#sec0)
|
690
|
+
|
691
|
+
### HTTP request headers
|
692
|
+
|
693
|
+
- **Content-Type**: application/json
|
694
|
+
- **Accept**: application/json
|
695
|
+
|
696
|
+
|
697
|
+
## room_dial_out_stop
|
698
|
+
|
699
|
+
> room_dial_out_stop(room_name, opts)
|
700
|
+
|
701
|
+
rooms/:name/dialOut/stop
|
702
|
+
|
703
|
+
Stop a dial out in a room
|
704
|
+
|
705
|
+
### Examples
|
706
|
+
|
707
|
+
```ruby
|
708
|
+
require 'time'
|
709
|
+
require 'daily-ruby'
|
710
|
+
# setup authorization
|
711
|
+
Daily.configure do |config|
|
712
|
+
# Configure API key authorization: sec0
|
713
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
714
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
715
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
716
|
+
end
|
717
|
+
|
718
|
+
api_instance = Daily::RoomsApi.new
|
719
|
+
room_name = 'room_name_example' # String |
|
720
|
+
opts = {
|
721
|
+
room_dial_out_stop_request: Daily::RoomDialOutStopRequest.new # RoomDialOutStopRequest |
|
722
|
+
}
|
723
|
+
|
724
|
+
begin
|
725
|
+
# rooms/:name/dialOut/stop
|
726
|
+
api_instance.room_dial_out_stop(room_name, opts)
|
727
|
+
rescue Daily::ApiError => e
|
728
|
+
puts "Error when calling RoomsApi->room_dial_out_stop: #{e}"
|
729
|
+
end
|
730
|
+
```
|
731
|
+
|
732
|
+
#### Using the room_dial_out_stop_with_http_info variant
|
733
|
+
|
734
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
735
|
+
|
736
|
+
> <Array(nil, Integer, Hash)> room_dial_out_stop_with_http_info(room_name, opts)
|
737
|
+
|
738
|
+
```ruby
|
739
|
+
begin
|
740
|
+
# rooms/:name/dialOut/stop
|
741
|
+
data, status_code, headers = api_instance.room_dial_out_stop_with_http_info(room_name, opts)
|
742
|
+
p status_code # => 2xx
|
743
|
+
p headers # => { ... }
|
744
|
+
p data # => nil
|
745
|
+
rescue Daily::ApiError => e
|
746
|
+
puts "Error when calling RoomsApi->room_dial_out_stop_with_http_info: #{e}"
|
747
|
+
end
|
748
|
+
```
|
749
|
+
|
750
|
+
### Parameters
|
751
|
+
|
752
|
+
| Name | Type | Description | Notes |
|
753
|
+
| ---- | ---- | ----------- | ----- |
|
754
|
+
| **room_name** | **String** | | |
|
755
|
+
| **room_dial_out_stop_request** | [**RoomDialOutStopRequest**](RoomDialOutStopRequest.md) | | [optional] |
|
756
|
+
|
757
|
+
### Return type
|
758
|
+
|
759
|
+
nil (empty response body)
|
760
|
+
|
761
|
+
### Authorization
|
762
|
+
|
763
|
+
[sec0](../README.md#sec0)
|
764
|
+
|
765
|
+
### HTTP request headers
|
766
|
+
|
767
|
+
- **Content-Type**: application/json
|
768
|
+
- **Accept**: application/json
|
769
|
+
|
770
|
+
|
771
|
+
## room_livestreaming_start
|
772
|
+
|
773
|
+
> room_livestreaming_start(room_name, opts)
|
774
|
+
|
775
|
+
rooms/:name/live-streaming/start
|
776
|
+
|
777
|
+
Start a live stream in a room
|
778
|
+
|
779
|
+
### Examples
|
780
|
+
|
781
|
+
```ruby
|
782
|
+
require 'time'
|
783
|
+
require 'daily-ruby'
|
784
|
+
# setup authorization
|
785
|
+
Daily.configure do |config|
|
786
|
+
# Configure API key authorization: sec0
|
787
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
788
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
789
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
790
|
+
end
|
791
|
+
|
792
|
+
api_instance = Daily::RoomsApi.new
|
793
|
+
room_name = 'room_name_example' # String |
|
794
|
+
opts = {
|
795
|
+
daily_live_streaming_options: Daily::DailyLiveStreamingOptions.new # DailyLiveStreamingOptions |
|
796
|
+
}
|
797
|
+
|
798
|
+
begin
|
799
|
+
# rooms/:name/live-streaming/start
|
800
|
+
api_instance.room_livestreaming_start(room_name, opts)
|
801
|
+
rescue Daily::ApiError => e
|
802
|
+
puts "Error when calling RoomsApi->room_livestreaming_start: #{e}"
|
803
|
+
end
|
804
|
+
```
|
805
|
+
|
806
|
+
#### Using the room_livestreaming_start_with_http_info variant
|
807
|
+
|
808
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
809
|
+
|
810
|
+
> <Array(nil, Integer, Hash)> room_livestreaming_start_with_http_info(room_name, opts)
|
811
|
+
|
812
|
+
```ruby
|
813
|
+
begin
|
814
|
+
# rooms/:name/live-streaming/start
|
815
|
+
data, status_code, headers = api_instance.room_livestreaming_start_with_http_info(room_name, opts)
|
816
|
+
p status_code # => 2xx
|
817
|
+
p headers # => { ... }
|
818
|
+
p data # => nil
|
819
|
+
rescue Daily::ApiError => e
|
820
|
+
puts "Error when calling RoomsApi->room_livestreaming_start_with_http_info: #{e}"
|
821
|
+
end
|
822
|
+
```
|
823
|
+
|
824
|
+
### Parameters
|
825
|
+
|
826
|
+
| Name | Type | Description | Notes |
|
827
|
+
| ---- | ---- | ----------- | ----- |
|
828
|
+
| **room_name** | **String** | | |
|
829
|
+
| **daily_live_streaming_options** | [**DailyLiveStreamingOptions**](DailyLiveStreamingOptions.md) | | [optional] |
|
830
|
+
|
831
|
+
### Return type
|
832
|
+
|
833
|
+
nil (empty response body)
|
834
|
+
|
835
|
+
### Authorization
|
836
|
+
|
837
|
+
[sec0](../README.md#sec0)
|
838
|
+
|
839
|
+
### HTTP request headers
|
840
|
+
|
841
|
+
- **Content-Type**: application/json
|
842
|
+
- **Accept**: application/json
|
843
|
+
|
844
|
+
|
845
|
+
## room_livestreaming_stop
|
846
|
+
|
847
|
+
> room_livestreaming_stop(room_name)
|
848
|
+
|
849
|
+
rooms/:name/live-streaming/stop
|
850
|
+
|
851
|
+
Stop a live stream in a room
|
852
|
+
|
853
|
+
### Examples
|
854
|
+
|
855
|
+
```ruby
|
856
|
+
require 'time'
|
857
|
+
require 'daily-ruby'
|
858
|
+
# setup authorization
|
859
|
+
Daily.configure do |config|
|
860
|
+
# Configure API key authorization: sec0
|
861
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
862
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
863
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
864
|
+
end
|
865
|
+
|
866
|
+
api_instance = Daily::RoomsApi.new
|
867
|
+
room_name = 'room_name_example' # String |
|
868
|
+
|
869
|
+
begin
|
870
|
+
# rooms/:name/live-streaming/stop
|
871
|
+
api_instance.room_livestreaming_stop(room_name)
|
872
|
+
rescue Daily::ApiError => e
|
873
|
+
puts "Error when calling RoomsApi->room_livestreaming_stop: #{e}"
|
874
|
+
end
|
875
|
+
```
|
876
|
+
|
877
|
+
#### Using the room_livestreaming_stop_with_http_info variant
|
878
|
+
|
879
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
880
|
+
|
881
|
+
> <Array(nil, Integer, Hash)> room_livestreaming_stop_with_http_info(room_name)
|
882
|
+
|
883
|
+
```ruby
|
884
|
+
begin
|
885
|
+
# rooms/:name/live-streaming/stop
|
886
|
+
data, status_code, headers = api_instance.room_livestreaming_stop_with_http_info(room_name)
|
887
|
+
p status_code # => 2xx
|
888
|
+
p headers # => { ... }
|
889
|
+
p data # => nil
|
890
|
+
rescue Daily::ApiError => e
|
891
|
+
puts "Error when calling RoomsApi->room_livestreaming_stop_with_http_info: #{e}"
|
892
|
+
end
|
893
|
+
```
|
894
|
+
|
895
|
+
### Parameters
|
896
|
+
|
897
|
+
| Name | Type | Description | Notes |
|
898
|
+
| ---- | ---- | ----------- | ----- |
|
899
|
+
| **room_name** | **String** | | |
|
900
|
+
|
901
|
+
### Return type
|
902
|
+
|
903
|
+
nil (empty response body)
|
904
|
+
|
905
|
+
### Authorization
|
906
|
+
|
907
|
+
[sec0](../README.md#sec0)
|
908
|
+
|
909
|
+
### HTTP request headers
|
910
|
+
|
911
|
+
- **Content-Type**: Not defined
|
912
|
+
- **Accept**: application/json
|
913
|
+
|
914
|
+
|
915
|
+
## room_livestreaming_update
|
916
|
+
|
917
|
+
> room_livestreaming_update(room_name, opts)
|
918
|
+
|
919
|
+
rooms/:name/live-streaming/update
|
920
|
+
|
921
|
+
Update a live stream in a room
|
922
|
+
|
923
|
+
### Examples
|
924
|
+
|
925
|
+
```ruby
|
926
|
+
require 'time'
|
927
|
+
require 'daily-ruby'
|
928
|
+
# setup authorization
|
929
|
+
Daily.configure do |config|
|
930
|
+
# Configure API key authorization: sec0
|
931
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
932
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
933
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
934
|
+
end
|
935
|
+
|
936
|
+
api_instance = Daily::RoomsApi.new
|
937
|
+
room_name = 'room_name_example' # String |
|
938
|
+
opts = {
|
939
|
+
daily_live_streaming_options: Daily::DailyLiveStreamingOptions.new # DailyLiveStreamingOptions |
|
940
|
+
}
|
941
|
+
|
942
|
+
begin
|
943
|
+
# rooms/:name/live-streaming/update
|
944
|
+
api_instance.room_livestreaming_update(room_name, opts)
|
945
|
+
rescue Daily::ApiError => e
|
946
|
+
puts "Error when calling RoomsApi->room_livestreaming_update: #{e}"
|
947
|
+
end
|
948
|
+
```
|
949
|
+
|
950
|
+
#### Using the room_livestreaming_update_with_http_info variant
|
951
|
+
|
952
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
953
|
+
|
954
|
+
> <Array(nil, Integer, Hash)> room_livestreaming_update_with_http_info(room_name, opts)
|
955
|
+
|
956
|
+
```ruby
|
957
|
+
begin
|
958
|
+
# rooms/:name/live-streaming/update
|
959
|
+
data, status_code, headers = api_instance.room_livestreaming_update_with_http_info(room_name, opts)
|
960
|
+
p status_code # => 2xx
|
961
|
+
p headers # => { ... }
|
962
|
+
p data # => nil
|
963
|
+
rescue Daily::ApiError => e
|
964
|
+
puts "Error when calling RoomsApi->room_livestreaming_update_with_http_info: #{e}"
|
965
|
+
end
|
966
|
+
```
|
967
|
+
|
968
|
+
### Parameters
|
969
|
+
|
970
|
+
| Name | Type | Description | Notes |
|
971
|
+
| ---- | ---- | ----------- | ----- |
|
972
|
+
| **room_name** | **String** | | |
|
973
|
+
| **daily_live_streaming_options** | [**DailyLiveStreamingOptions**](DailyLiveStreamingOptions.md) | | [optional] |
|
974
|
+
|
975
|
+
### Return type
|
976
|
+
|
977
|
+
nil (empty response body)
|
978
|
+
|
979
|
+
### Authorization
|
980
|
+
|
981
|
+
[sec0](../README.md#sec0)
|
982
|
+
|
983
|
+
### HTTP request headers
|
984
|
+
|
985
|
+
- **Content-Type**: application/json
|
986
|
+
- **Accept**: application/json
|
987
|
+
|
988
|
+
|
989
|
+
## room_recordings_start
|
990
|
+
|
991
|
+
> room_recordings_start(room_name, opts)
|
992
|
+
|
993
|
+
rooms/:name/recordings/start
|
994
|
+
|
995
|
+
Start a recording in a room
|
996
|
+
|
997
|
+
### Examples
|
998
|
+
|
999
|
+
```ruby
|
1000
|
+
require 'time'
|
1001
|
+
require 'daily-ruby'
|
1002
|
+
# setup authorization
|
1003
|
+
Daily.configure do |config|
|
1004
|
+
# Configure API key authorization: sec0
|
1005
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1006
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1007
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
api_instance = Daily::RoomsApi.new
|
1011
|
+
room_name = 'room_name_example' # String |
|
1012
|
+
opts = {
|
1013
|
+
recording_streaming_options: Daily::RecordingStreamingOptions.new # RecordingStreamingOptions |
|
1014
|
+
}
|
1015
|
+
|
1016
|
+
begin
|
1017
|
+
# rooms/:name/recordings/start
|
1018
|
+
api_instance.room_recordings_start(room_name, opts)
|
1019
|
+
rescue Daily::ApiError => e
|
1020
|
+
puts "Error when calling RoomsApi->room_recordings_start: #{e}"
|
1021
|
+
end
|
1022
|
+
```
|
1023
|
+
|
1024
|
+
#### Using the room_recordings_start_with_http_info variant
|
1025
|
+
|
1026
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1027
|
+
|
1028
|
+
> <Array(nil, Integer, Hash)> room_recordings_start_with_http_info(room_name, opts)
|
1029
|
+
|
1030
|
+
```ruby
|
1031
|
+
begin
|
1032
|
+
# rooms/:name/recordings/start
|
1033
|
+
data, status_code, headers = api_instance.room_recordings_start_with_http_info(room_name, opts)
|
1034
|
+
p status_code # => 2xx
|
1035
|
+
p headers # => { ... }
|
1036
|
+
p data # => nil
|
1037
|
+
rescue Daily::ApiError => e
|
1038
|
+
puts "Error when calling RoomsApi->room_recordings_start_with_http_info: #{e}"
|
1039
|
+
end
|
1040
|
+
```
|
1041
|
+
|
1042
|
+
### Parameters
|
1043
|
+
|
1044
|
+
| Name | Type | Description | Notes |
|
1045
|
+
| ---- | ---- | ----------- | ----- |
|
1046
|
+
| **room_name** | **String** | | |
|
1047
|
+
| **recording_streaming_options** | [**RecordingStreamingOptions**](RecordingStreamingOptions.md) | | [optional] |
|
1048
|
+
|
1049
|
+
### Return type
|
1050
|
+
|
1051
|
+
nil (empty response body)
|
1052
|
+
|
1053
|
+
### Authorization
|
1054
|
+
|
1055
|
+
[sec0](../README.md#sec0)
|
1056
|
+
|
1057
|
+
### HTTP request headers
|
1058
|
+
|
1059
|
+
- **Content-Type**: application/json
|
1060
|
+
- **Accept**: application/json
|
1061
|
+
|
1062
|
+
|
1063
|
+
## room_recordings_stop
|
1064
|
+
|
1065
|
+
> room_recordings_stop(room_name)
|
1066
|
+
|
1067
|
+
rooms/:name/recordings/stop
|
1068
|
+
|
1069
|
+
Stop a recording in a room
|
1070
|
+
|
1071
|
+
### Examples
|
1072
|
+
|
1073
|
+
```ruby
|
1074
|
+
require 'time'
|
1075
|
+
require 'daily-ruby'
|
1076
|
+
# setup authorization
|
1077
|
+
Daily.configure do |config|
|
1078
|
+
# Configure API key authorization: sec0
|
1079
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1080
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1081
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
api_instance = Daily::RoomsApi.new
|
1085
|
+
room_name = 'room_name_example' # String |
|
1086
|
+
|
1087
|
+
begin
|
1088
|
+
# rooms/:name/recordings/stop
|
1089
|
+
api_instance.room_recordings_stop(room_name)
|
1090
|
+
rescue Daily::ApiError => e
|
1091
|
+
puts "Error when calling RoomsApi->room_recordings_stop: #{e}"
|
1092
|
+
end
|
1093
|
+
```
|
1094
|
+
|
1095
|
+
#### Using the room_recordings_stop_with_http_info variant
|
1096
|
+
|
1097
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1098
|
+
|
1099
|
+
> <Array(nil, Integer, Hash)> room_recordings_stop_with_http_info(room_name)
|
1100
|
+
|
1101
|
+
```ruby
|
1102
|
+
begin
|
1103
|
+
# rooms/:name/recordings/stop
|
1104
|
+
data, status_code, headers = api_instance.room_recordings_stop_with_http_info(room_name)
|
1105
|
+
p status_code # => 2xx
|
1106
|
+
p headers # => { ... }
|
1107
|
+
p data # => nil
|
1108
|
+
rescue Daily::ApiError => e
|
1109
|
+
puts "Error when calling RoomsApi->room_recordings_stop_with_http_info: #{e}"
|
1110
|
+
end
|
1111
|
+
```
|
1112
|
+
|
1113
|
+
### Parameters
|
1114
|
+
|
1115
|
+
| Name | Type | Description | Notes |
|
1116
|
+
| ---- | ---- | ----------- | ----- |
|
1117
|
+
| **room_name** | **String** | | |
|
1118
|
+
|
1119
|
+
### Return type
|
1120
|
+
|
1121
|
+
nil (empty response body)
|
1122
|
+
|
1123
|
+
### Authorization
|
1124
|
+
|
1125
|
+
[sec0](../README.md#sec0)
|
1126
|
+
|
1127
|
+
### HTTP request headers
|
1128
|
+
|
1129
|
+
- **Content-Type**: Not defined
|
1130
|
+
- **Accept**: application/json
|
1131
|
+
|
1132
|
+
|
1133
|
+
## room_recordings_update
|
1134
|
+
|
1135
|
+
> room_recordings_update(room_name, opts)
|
1136
|
+
|
1137
|
+
rooms/:name/recordings/update
|
1138
|
+
|
1139
|
+
Update a recording in a room
|
1140
|
+
|
1141
|
+
### Examples
|
1142
|
+
|
1143
|
+
```ruby
|
1144
|
+
require 'time'
|
1145
|
+
require 'daily-ruby'
|
1146
|
+
# setup authorization
|
1147
|
+
Daily.configure do |config|
|
1148
|
+
# Configure API key authorization: sec0
|
1149
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1150
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1151
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1152
|
+
end
|
1153
|
+
|
1154
|
+
api_instance = Daily::RoomsApi.new
|
1155
|
+
room_name = 'room_name_example' # String |
|
1156
|
+
opts = {
|
1157
|
+
daily_streaming_options: Daily::DailyStreamingOptions.new # DailyStreamingOptions |
|
1158
|
+
}
|
1159
|
+
|
1160
|
+
begin
|
1161
|
+
# rooms/:name/recordings/update
|
1162
|
+
api_instance.room_recordings_update(room_name, opts)
|
1163
|
+
rescue Daily::ApiError => e
|
1164
|
+
puts "Error when calling RoomsApi->room_recordings_update: #{e}"
|
1165
|
+
end
|
1166
|
+
```
|
1167
|
+
|
1168
|
+
#### Using the room_recordings_update_with_http_info variant
|
1169
|
+
|
1170
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1171
|
+
|
1172
|
+
> <Array(nil, Integer, Hash)> room_recordings_update_with_http_info(room_name, opts)
|
1173
|
+
|
1174
|
+
```ruby
|
1175
|
+
begin
|
1176
|
+
# rooms/:name/recordings/update
|
1177
|
+
data, status_code, headers = api_instance.room_recordings_update_with_http_info(room_name, opts)
|
1178
|
+
p status_code # => 2xx
|
1179
|
+
p headers # => { ... }
|
1180
|
+
p data # => nil
|
1181
|
+
rescue Daily::ApiError => e
|
1182
|
+
puts "Error when calling RoomsApi->room_recordings_update_with_http_info: #{e}"
|
1183
|
+
end
|
1184
|
+
```
|
1185
|
+
|
1186
|
+
### Parameters
|
1187
|
+
|
1188
|
+
| Name | Type | Description | Notes |
|
1189
|
+
| ---- | ---- | ----------- | ----- |
|
1190
|
+
| **room_name** | **String** | | |
|
1191
|
+
| **daily_streaming_options** | [**DailyStreamingOptions**](DailyStreamingOptions.md) | | [optional] |
|
1192
|
+
|
1193
|
+
### Return type
|
1194
|
+
|
1195
|
+
nil (empty response body)
|
1196
|
+
|
1197
|
+
### Authorization
|
1198
|
+
|
1199
|
+
[sec0](../README.md#sec0)
|
1200
|
+
|
1201
|
+
### HTTP request headers
|
1202
|
+
|
1203
|
+
- **Content-Type**: application/json
|
1204
|
+
- **Accept**: application/json
|
1205
|
+
|
1206
|
+
|
1207
|
+
## room_sip_call_transfer
|
1208
|
+
|
1209
|
+
> room_sip_call_transfer(room_name, opts)
|
1210
|
+
|
1211
|
+
rooms/:name/sipCallTransfer
|
1212
|
+
|
1213
|
+
transfer sip/pstn call
|
1214
|
+
|
1215
|
+
### Examples
|
1216
|
+
|
1217
|
+
```ruby
|
1218
|
+
require 'time'
|
1219
|
+
require 'daily-ruby'
|
1220
|
+
# setup authorization
|
1221
|
+
Daily.configure do |config|
|
1222
|
+
# Configure API key authorization: sec0
|
1223
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1224
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1225
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1226
|
+
end
|
1227
|
+
|
1228
|
+
api_instance = Daily::RoomsApi.new
|
1229
|
+
room_name = 'room_name_example' # String |
|
1230
|
+
opts = {
|
1231
|
+
room_sip_call_transfer_request: Daily::RoomSipCallTransferRequest.new # RoomSipCallTransferRequest |
|
1232
|
+
}
|
1233
|
+
|
1234
|
+
begin
|
1235
|
+
# rooms/:name/sipCallTransfer
|
1236
|
+
api_instance.room_sip_call_transfer(room_name, opts)
|
1237
|
+
rescue Daily::ApiError => e
|
1238
|
+
puts "Error when calling RoomsApi->room_sip_call_transfer: #{e}"
|
1239
|
+
end
|
1240
|
+
```
|
1241
|
+
|
1242
|
+
#### Using the room_sip_call_transfer_with_http_info variant
|
1243
|
+
|
1244
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1245
|
+
|
1246
|
+
> <Array(nil, Integer, Hash)> room_sip_call_transfer_with_http_info(room_name, opts)
|
1247
|
+
|
1248
|
+
```ruby
|
1249
|
+
begin
|
1250
|
+
# rooms/:name/sipCallTransfer
|
1251
|
+
data, status_code, headers = api_instance.room_sip_call_transfer_with_http_info(room_name, opts)
|
1252
|
+
p status_code # => 2xx
|
1253
|
+
p headers # => { ... }
|
1254
|
+
p data # => nil
|
1255
|
+
rescue Daily::ApiError => e
|
1256
|
+
puts "Error when calling RoomsApi->room_sip_call_transfer_with_http_info: #{e}"
|
1257
|
+
end
|
1258
|
+
```
|
1259
|
+
|
1260
|
+
### Parameters
|
1261
|
+
|
1262
|
+
| Name | Type | Description | Notes |
|
1263
|
+
| ---- | ---- | ----------- | ----- |
|
1264
|
+
| **room_name** | **String** | | |
|
1265
|
+
| **room_sip_call_transfer_request** | [**RoomSipCallTransferRequest**](RoomSipCallTransferRequest.md) | | [optional] |
|
1266
|
+
|
1267
|
+
### Return type
|
1268
|
+
|
1269
|
+
nil (empty response body)
|
1270
|
+
|
1271
|
+
### Authorization
|
1272
|
+
|
1273
|
+
[sec0](../README.md#sec0)
|
1274
|
+
|
1275
|
+
### HTTP request headers
|
1276
|
+
|
1277
|
+
- **Content-Type**: application/json
|
1278
|
+
- **Accept**: application/json
|
1279
|
+
|
1280
|
+
|
1281
|
+
## room_sip_refer
|
1282
|
+
|
1283
|
+
> Object room_sip_refer(room_name, opts)
|
1284
|
+
|
1285
|
+
rooms/:name/sipRefer
|
1286
|
+
|
1287
|
+
refer a sip call to other sip endpoint
|
1288
|
+
|
1289
|
+
### Examples
|
1290
|
+
|
1291
|
+
```ruby
|
1292
|
+
require 'time'
|
1293
|
+
require 'daily-ruby'
|
1294
|
+
# setup authorization
|
1295
|
+
Daily.configure do |config|
|
1296
|
+
# Configure API key authorization: sec0
|
1297
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1298
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1299
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1300
|
+
end
|
1301
|
+
|
1302
|
+
api_instance = Daily::RoomsApi.new
|
1303
|
+
room_name = 'room_name_example' # String |
|
1304
|
+
opts = {
|
1305
|
+
room_sip_call_transfer_request: Daily::RoomSipCallTransferRequest.new # RoomSipCallTransferRequest |
|
1306
|
+
}
|
1307
|
+
|
1308
|
+
begin
|
1309
|
+
# rooms/:name/sipRefer
|
1310
|
+
result = api_instance.room_sip_refer(room_name, opts)
|
1311
|
+
p result
|
1312
|
+
rescue Daily::ApiError => e
|
1313
|
+
puts "Error when calling RoomsApi->room_sip_refer: #{e}"
|
1314
|
+
end
|
1315
|
+
```
|
1316
|
+
|
1317
|
+
#### Using the room_sip_refer_with_http_info variant
|
1318
|
+
|
1319
|
+
This returns an Array which contains the response data, status code and headers.
|
1320
|
+
|
1321
|
+
> <Array(Object, Integer, Hash)> room_sip_refer_with_http_info(room_name, opts)
|
1322
|
+
|
1323
|
+
```ruby
|
1324
|
+
begin
|
1325
|
+
# rooms/:name/sipRefer
|
1326
|
+
data, status_code, headers = api_instance.room_sip_refer_with_http_info(room_name, opts)
|
1327
|
+
p status_code # => 2xx
|
1328
|
+
p headers # => { ... }
|
1329
|
+
p data # => Object
|
1330
|
+
rescue Daily::ApiError => e
|
1331
|
+
puts "Error when calling RoomsApi->room_sip_refer_with_http_info: #{e}"
|
1332
|
+
end
|
1333
|
+
```
|
1334
|
+
|
1335
|
+
### Parameters
|
1336
|
+
|
1337
|
+
| Name | Type | Description | Notes |
|
1338
|
+
| ---- | ---- | ----------- | ----- |
|
1339
|
+
| **room_name** | **String** | | |
|
1340
|
+
| **room_sip_call_transfer_request** | [**RoomSipCallTransferRequest**](RoomSipCallTransferRequest.md) | | [optional] |
|
1341
|
+
|
1342
|
+
### Return type
|
1343
|
+
|
1344
|
+
**Object**
|
1345
|
+
|
1346
|
+
### Authorization
|
1347
|
+
|
1348
|
+
[sec0](../README.md#sec0)
|
1349
|
+
|
1350
|
+
### HTTP request headers
|
1351
|
+
|
1352
|
+
- **Content-Type**: application/json
|
1353
|
+
- **Accept**: application/json
|
1354
|
+
|
1355
|
+
|
1356
|
+
## room_transcription_start
|
1357
|
+
|
1358
|
+
> room_transcription_start(room_name, opts)
|
1359
|
+
|
1360
|
+
rooms/:name/transcription/start
|
1361
|
+
|
1362
|
+
Start a transcription in a room
|
1363
|
+
|
1364
|
+
### Examples
|
1365
|
+
|
1366
|
+
```ruby
|
1367
|
+
require 'time'
|
1368
|
+
require 'daily-ruby'
|
1369
|
+
# setup authorization
|
1370
|
+
Daily.configure do |config|
|
1371
|
+
# Configure API key authorization: sec0
|
1372
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1373
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1374
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1375
|
+
end
|
1376
|
+
|
1377
|
+
api_instance = Daily::RoomsApi.new
|
1378
|
+
room_name = 'room_name_example' # String |
|
1379
|
+
opts = {
|
1380
|
+
transcription_properties: Daily::TranscriptionProperties.new # TranscriptionProperties |
|
1381
|
+
}
|
1382
|
+
|
1383
|
+
begin
|
1384
|
+
# rooms/:name/transcription/start
|
1385
|
+
api_instance.room_transcription_start(room_name, opts)
|
1386
|
+
rescue Daily::ApiError => e
|
1387
|
+
puts "Error when calling RoomsApi->room_transcription_start: #{e}"
|
1388
|
+
end
|
1389
|
+
```
|
1390
|
+
|
1391
|
+
#### Using the room_transcription_start_with_http_info variant
|
1392
|
+
|
1393
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1394
|
+
|
1395
|
+
> <Array(nil, Integer, Hash)> room_transcription_start_with_http_info(room_name, opts)
|
1396
|
+
|
1397
|
+
```ruby
|
1398
|
+
begin
|
1399
|
+
# rooms/:name/transcription/start
|
1400
|
+
data, status_code, headers = api_instance.room_transcription_start_with_http_info(room_name, opts)
|
1401
|
+
p status_code # => 2xx
|
1402
|
+
p headers # => { ... }
|
1403
|
+
p data # => nil
|
1404
|
+
rescue Daily::ApiError => e
|
1405
|
+
puts "Error when calling RoomsApi->room_transcription_start_with_http_info: #{e}"
|
1406
|
+
end
|
1407
|
+
```
|
1408
|
+
|
1409
|
+
### Parameters
|
1410
|
+
|
1411
|
+
| Name | Type | Description | Notes |
|
1412
|
+
| ---- | ---- | ----------- | ----- |
|
1413
|
+
| **room_name** | **String** | | |
|
1414
|
+
| **transcription_properties** | [**TranscriptionProperties**](TranscriptionProperties.md) | | [optional] |
|
1415
|
+
|
1416
|
+
### Return type
|
1417
|
+
|
1418
|
+
nil (empty response body)
|
1419
|
+
|
1420
|
+
### Authorization
|
1421
|
+
|
1422
|
+
[sec0](../README.md#sec0)
|
1423
|
+
|
1424
|
+
### HTTP request headers
|
1425
|
+
|
1426
|
+
- **Content-Type**: application/json
|
1427
|
+
- **Accept**: application/json
|
1428
|
+
|
1429
|
+
|
1430
|
+
## room_transcription_stop
|
1431
|
+
|
1432
|
+
> room_transcription_stop(room_name)
|
1433
|
+
|
1434
|
+
rooms/:name/transcription/stop
|
1435
|
+
|
1436
|
+
Stop a transcription in a room
|
1437
|
+
|
1438
|
+
### Examples
|
1439
|
+
|
1440
|
+
```ruby
|
1441
|
+
require 'time'
|
1442
|
+
require 'daily-ruby'
|
1443
|
+
# setup authorization
|
1444
|
+
Daily.configure do |config|
|
1445
|
+
# Configure API key authorization: sec0
|
1446
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1447
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1448
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
api_instance = Daily::RoomsApi.new
|
1452
|
+
room_name = 'room_name_example' # String |
|
1453
|
+
|
1454
|
+
begin
|
1455
|
+
# rooms/:name/transcription/stop
|
1456
|
+
api_instance.room_transcription_stop(room_name)
|
1457
|
+
rescue Daily::ApiError => e
|
1458
|
+
puts "Error when calling RoomsApi->room_transcription_stop: #{e}"
|
1459
|
+
end
|
1460
|
+
```
|
1461
|
+
|
1462
|
+
#### Using the room_transcription_stop_with_http_info variant
|
1463
|
+
|
1464
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1465
|
+
|
1466
|
+
> <Array(nil, Integer, Hash)> room_transcription_stop_with_http_info(room_name)
|
1467
|
+
|
1468
|
+
```ruby
|
1469
|
+
begin
|
1470
|
+
# rooms/:name/transcription/stop
|
1471
|
+
data, status_code, headers = api_instance.room_transcription_stop_with_http_info(room_name)
|
1472
|
+
p status_code # => 2xx
|
1473
|
+
p headers # => { ... }
|
1474
|
+
p data # => nil
|
1475
|
+
rescue Daily::ApiError => e
|
1476
|
+
puts "Error when calling RoomsApi->room_transcription_stop_with_http_info: #{e}"
|
1477
|
+
end
|
1478
|
+
```
|
1479
|
+
|
1480
|
+
### Parameters
|
1481
|
+
|
1482
|
+
| Name | Type | Description | Notes |
|
1483
|
+
| ---- | ---- | ----------- | ----- |
|
1484
|
+
| **room_name** | **String** | | |
|
1485
|
+
|
1486
|
+
### Return type
|
1487
|
+
|
1488
|
+
nil (empty response body)
|
1489
|
+
|
1490
|
+
### Authorization
|
1491
|
+
|
1492
|
+
[sec0](../README.md#sec0)
|
1493
|
+
|
1494
|
+
### HTTP request headers
|
1495
|
+
|
1496
|
+
- **Content-Type**: Not defined
|
1497
|
+
- **Accept**: application/json
|
1498
|
+
|
1499
|
+
|
1500
|
+
## send_app_message
|
1501
|
+
|
1502
|
+
> send_app_message(room_name, opts)
|
1503
|
+
|
1504
|
+
rooms/:name/send-app-message
|
1505
|
+
|
1506
|
+
Send a message to participants in a room
|
1507
|
+
|
1508
|
+
### Examples
|
1509
|
+
|
1510
|
+
```ruby
|
1511
|
+
require 'time'
|
1512
|
+
require 'daily-ruby'
|
1513
|
+
# setup authorization
|
1514
|
+
Daily.configure do |config|
|
1515
|
+
# Configure API key authorization: sec0
|
1516
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1517
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1518
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
api_instance = Daily::RoomsApi.new
|
1522
|
+
room_name = 'room_name_example' # String |
|
1523
|
+
opts = {
|
1524
|
+
send_app_message_request: Daily::SendAppMessageRequest.new # SendAppMessageRequest |
|
1525
|
+
}
|
1526
|
+
|
1527
|
+
begin
|
1528
|
+
# rooms/:name/send-app-message
|
1529
|
+
api_instance.send_app_message(room_name, opts)
|
1530
|
+
rescue Daily::ApiError => e
|
1531
|
+
puts "Error when calling RoomsApi->send_app_message: #{e}"
|
1532
|
+
end
|
1533
|
+
```
|
1534
|
+
|
1535
|
+
#### Using the send_app_message_with_http_info variant
|
1536
|
+
|
1537
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1538
|
+
|
1539
|
+
> <Array(nil, Integer, Hash)> send_app_message_with_http_info(room_name, opts)
|
1540
|
+
|
1541
|
+
```ruby
|
1542
|
+
begin
|
1543
|
+
# rooms/:name/send-app-message
|
1544
|
+
data, status_code, headers = api_instance.send_app_message_with_http_info(room_name, opts)
|
1545
|
+
p status_code # => 2xx
|
1546
|
+
p headers # => { ... }
|
1547
|
+
p data # => nil
|
1548
|
+
rescue Daily::ApiError => e
|
1549
|
+
puts "Error when calling RoomsApi->send_app_message_with_http_info: #{e}"
|
1550
|
+
end
|
1551
|
+
```
|
1552
|
+
|
1553
|
+
### Parameters
|
1554
|
+
|
1555
|
+
| Name | Type | Description | Notes |
|
1556
|
+
| ---- | ---- | ----------- | ----- |
|
1557
|
+
| **room_name** | **String** | | |
|
1558
|
+
| **send_app_message_request** | [**SendAppMessageRequest**](SendAppMessageRequest.md) | | [optional] |
|
1559
|
+
|
1560
|
+
### Return type
|
1561
|
+
|
1562
|
+
nil (empty response body)
|
1563
|
+
|
1564
|
+
### Authorization
|
1565
|
+
|
1566
|
+
[sec0](../README.md#sec0)
|
1567
|
+
|
1568
|
+
### HTTP request headers
|
1569
|
+
|
1570
|
+
- **Content-Type**: application/json
|
1571
|
+
- **Accept**: application/json
|
1572
|
+
|
1573
|
+
|
1574
|
+
## set_room_config
|
1575
|
+
|
1576
|
+
> set_room_config(room_name, opts)
|
1577
|
+
|
1578
|
+
rooms/:name
|
1579
|
+
|
1580
|
+
Set a room's privacy and config properties
|
1581
|
+
|
1582
|
+
### Examples
|
1583
|
+
|
1584
|
+
```ruby
|
1585
|
+
require 'time'
|
1586
|
+
require 'daily-ruby'
|
1587
|
+
# setup authorization
|
1588
|
+
Daily.configure do |config|
|
1589
|
+
# Configure API key authorization: sec0
|
1590
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1591
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1592
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1593
|
+
end
|
1594
|
+
|
1595
|
+
api_instance = Daily::RoomsApi.new
|
1596
|
+
room_name = 'room_name_example' # String |
|
1597
|
+
opts = {
|
1598
|
+
set_room_config_request: Daily::SetRoomConfigRequest.new # SetRoomConfigRequest |
|
1599
|
+
}
|
1600
|
+
|
1601
|
+
begin
|
1602
|
+
# rooms/:name
|
1603
|
+
api_instance.set_room_config(room_name, opts)
|
1604
|
+
rescue Daily::ApiError => e
|
1605
|
+
puts "Error when calling RoomsApi->set_room_config: #{e}"
|
1606
|
+
end
|
1607
|
+
```
|
1608
|
+
|
1609
|
+
#### Using the set_room_config_with_http_info variant
|
1610
|
+
|
1611
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1612
|
+
|
1613
|
+
> <Array(nil, Integer, Hash)> set_room_config_with_http_info(room_name, opts)
|
1614
|
+
|
1615
|
+
```ruby
|
1616
|
+
begin
|
1617
|
+
# rooms/:name
|
1618
|
+
data, status_code, headers = api_instance.set_room_config_with_http_info(room_name, opts)
|
1619
|
+
p status_code # => 2xx
|
1620
|
+
p headers # => { ... }
|
1621
|
+
p data # => nil
|
1622
|
+
rescue Daily::ApiError => e
|
1623
|
+
puts "Error when calling RoomsApi->set_room_config_with_http_info: #{e}"
|
1624
|
+
end
|
1625
|
+
```
|
1626
|
+
|
1627
|
+
### Parameters
|
1628
|
+
|
1629
|
+
| Name | Type | Description | Notes |
|
1630
|
+
| ---- | ---- | ----------- | ----- |
|
1631
|
+
| **room_name** | **String** | | |
|
1632
|
+
| **set_room_config_request** | [**SetRoomConfigRequest**](SetRoomConfigRequest.md) | | [optional] |
|
1633
|
+
|
1634
|
+
### Return type
|
1635
|
+
|
1636
|
+
nil (empty response body)
|
1637
|
+
|
1638
|
+
### Authorization
|
1639
|
+
|
1640
|
+
[sec0](../README.md#sec0)
|
1641
|
+
|
1642
|
+
### HTTP request headers
|
1643
|
+
|
1644
|
+
- **Content-Type**: application/json
|
1645
|
+
- **Accept**: application/json
|
1646
|
+
|
1647
|
+
|
1648
|
+
## set_session_data
|
1649
|
+
|
1650
|
+
> set_session_data(room_name, opts)
|
1651
|
+
|
1652
|
+
rooms/:name/set-session-data
|
1653
|
+
|
1654
|
+
Sets meeting session data
|
1655
|
+
|
1656
|
+
### Examples
|
1657
|
+
|
1658
|
+
```ruby
|
1659
|
+
require 'time'
|
1660
|
+
require 'daily-ruby'
|
1661
|
+
# setup authorization
|
1662
|
+
Daily.configure do |config|
|
1663
|
+
# Configure API key authorization: sec0
|
1664
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1665
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1666
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1667
|
+
end
|
1668
|
+
|
1669
|
+
api_instance = Daily::RoomsApi.new
|
1670
|
+
room_name = 'room_name_example' # String |
|
1671
|
+
opts = {
|
1672
|
+
set_session_data_request: Daily::SetSessionDataRequest.new # SetSessionDataRequest |
|
1673
|
+
}
|
1674
|
+
|
1675
|
+
begin
|
1676
|
+
# rooms/:name/set-session-data
|
1677
|
+
api_instance.set_session_data(room_name, opts)
|
1678
|
+
rescue Daily::ApiError => e
|
1679
|
+
puts "Error when calling RoomsApi->set_session_data: #{e}"
|
1680
|
+
end
|
1681
|
+
```
|
1682
|
+
|
1683
|
+
#### Using the set_session_data_with_http_info variant
|
1684
|
+
|
1685
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1686
|
+
|
1687
|
+
> <Array(nil, Integer, Hash)> set_session_data_with_http_info(room_name, opts)
|
1688
|
+
|
1689
|
+
```ruby
|
1690
|
+
begin
|
1691
|
+
# rooms/:name/set-session-data
|
1692
|
+
data, status_code, headers = api_instance.set_session_data_with_http_info(room_name, opts)
|
1693
|
+
p status_code # => 2xx
|
1694
|
+
p headers # => { ... }
|
1695
|
+
p data # => nil
|
1696
|
+
rescue Daily::ApiError => e
|
1697
|
+
puts "Error when calling RoomsApi->set_session_data_with_http_info: #{e}"
|
1698
|
+
end
|
1699
|
+
```
|
1700
|
+
|
1701
|
+
### Parameters
|
1702
|
+
|
1703
|
+
| Name | Type | Description | Notes |
|
1704
|
+
| ---- | ---- | ----------- | ----- |
|
1705
|
+
| **room_name** | **String** | | |
|
1706
|
+
| **set_session_data_request** | [**SetSessionDataRequest**](SetSessionDataRequest.md) | | [optional] |
|
1707
|
+
|
1708
|
+
### Return type
|
1709
|
+
|
1710
|
+
nil (empty response body)
|
1711
|
+
|
1712
|
+
### Authorization
|
1713
|
+
|
1714
|
+
[sec0](../README.md#sec0)
|
1715
|
+
|
1716
|
+
### HTTP request headers
|
1717
|
+
|
1718
|
+
- **Content-Type**: application/json
|
1719
|
+
- **Accept**: application/json
|
1720
|
+
|
1721
|
+
|
1722
|
+
## update_permissions
|
1723
|
+
|
1724
|
+
> update_permissions(room_name, opts)
|
1725
|
+
|
1726
|
+
rooms/:name/update-permissions
|
1727
|
+
|
1728
|
+
Modifies permissions for one or more participants in a room
|
1729
|
+
|
1730
|
+
### Examples
|
1731
|
+
|
1732
|
+
```ruby
|
1733
|
+
require 'time'
|
1734
|
+
require 'daily-ruby'
|
1735
|
+
# setup authorization
|
1736
|
+
Daily.configure do |config|
|
1737
|
+
# Configure API key authorization: sec0
|
1738
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
1739
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1740
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
1741
|
+
end
|
1742
|
+
|
1743
|
+
api_instance = Daily::RoomsApi.new
|
1744
|
+
room_name = 'room_name_example' # String |
|
1745
|
+
opts = {
|
1746
|
+
update_permissions_request: Daily::UpdatePermissionsRequest.new # UpdatePermissionsRequest |
|
1747
|
+
}
|
1748
|
+
|
1749
|
+
begin
|
1750
|
+
# rooms/:name/update-permissions
|
1751
|
+
api_instance.update_permissions(room_name, opts)
|
1752
|
+
rescue Daily::ApiError => e
|
1753
|
+
puts "Error when calling RoomsApi->update_permissions: #{e}"
|
1754
|
+
end
|
1755
|
+
```
|
1756
|
+
|
1757
|
+
#### Using the update_permissions_with_http_info variant
|
1758
|
+
|
1759
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
1760
|
+
|
1761
|
+
> <Array(nil, Integer, Hash)> update_permissions_with_http_info(room_name, opts)
|
1762
|
+
|
1763
|
+
```ruby
|
1764
|
+
begin
|
1765
|
+
# rooms/:name/update-permissions
|
1766
|
+
data, status_code, headers = api_instance.update_permissions_with_http_info(room_name, opts)
|
1767
|
+
p status_code # => 2xx
|
1768
|
+
p headers # => { ... }
|
1769
|
+
p data # => nil
|
1770
|
+
rescue Daily::ApiError => e
|
1771
|
+
puts "Error when calling RoomsApi->update_permissions_with_http_info: #{e}"
|
1772
|
+
end
|
1773
|
+
```
|
1774
|
+
|
1775
|
+
### Parameters
|
1776
|
+
|
1777
|
+
| Name | Type | Description | Notes |
|
1778
|
+
| ---- | ---- | ----------- | ----- |
|
1779
|
+
| **room_name** | **String** | | |
|
1780
|
+
| **update_permissions_request** | [**UpdatePermissionsRequest**](UpdatePermissionsRequest.md) | | [optional] |
|
1781
|
+
|
1782
|
+
### Return type
|
1783
|
+
|
1784
|
+
nil (empty response body)
|
1785
|
+
|
1786
|
+
### Authorization
|
1787
|
+
|
1788
|
+
[sec0](../README.md#sec0)
|
1789
|
+
|
1790
|
+
### HTTP request headers
|
1791
|
+
|
1792
|
+
- **Content-Type**: application/json
|
1793
|
+
- **Accept**: application/json
|
1794
|
+
|