daily-ruby 1.0.0 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +0 -1
- data/Gemfile.lock +9 -28
- data/README.md +62 -52
- data/daily-ruby.gemspec +4 -3
- 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/BuyPhoneNumberRequest.md +18 -0
- data/docs/DailyStreamingCustomLayoutConfig.md +1 -1
- data/docs/DailyStreamingCustomLayoutConfigCompositionParamsValue.md +15 -0
- data/docs/DialinApi.md +80 -0
- data/docs/DialoutProperties.md +26 -0
- data/docs/DialoutPropertiesCodecs.md +20 -0
- data/docs/DomainProperties.md +14 -4
- data/docs/EjectRequest.md +6 -2
- data/docs/GetDomainConfig200ResponseConfig.md +2 -0
- data/docs/GetTranscriptInfo200Response.md +1 -1
- data/docs/ListAPILogs200Response.md +1 -1
- data/docs/MeetingEnded.md +24 -0
- data/docs/MeetingEndedPayload.md +24 -0
- data/docs/MeetingParticipantsGetRes.md +0 -2
- data/docs/MeetingStarted.md +24 -0
- data/docs/MeetingStartedPayload.md +22 -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/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 +5 -1
- data/docs/Properties.md +3 -1
- data/docs/RecordingError.md +1 -1
- data/docs/RecordingReadyToDownload.md +1 -1
- data/docs/RecordingStarted.md +1 -1
- data/docs/RoomDialOutSendDTMFRequest.md +20 -0
- data/docs/RoomDialOutStopRequest.md +18 -0
- data/docs/RoomProperties.md +12 -2
- data/docs/RoomSipCallTransferRequest.md +20 -0
- data/docs/RoomsApi.md +376 -0
- data/docs/StreamingEnded.md +1 -1
- data/docs/StreamingError.md +1 -1
- data/docs/StreamingStarted.md +1 -1
- data/docs/StreamingUpdated.md +1 -1
- data/docs/TranscriptionProperties.md +4 -2
- data/docs/UpdateWebhook.md +5 -1
- 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 +6 -4
- data/example.rb +12 -4
- data/lib/daily-ruby/api/batch_rooms_api.rb +3 -3
- data/lib/daily-ruby/api/dialin_api.rb +86 -0
- data/lib/daily-ruby/api/domain_api.rb +3 -3
- data/lib/daily-ruby/api/logs_api.rb +4 -4
- data/lib/daily-ruby/api/meeting_tokens_api.rb +3 -3
- data/lib/daily-ruby/api/meetings_api.rb +4 -4
- data/lib/daily-ruby/api/phone_numbers_api.rb +281 -0
- data/lib/daily-ruby/api/presence_api.rb +2 -2
- data/lib/daily-ruby/api/recordings_api.rb +5 -5
- data/lib/daily-ruby/api/rooms_api.rb +370 -20
- data/lib/daily-ruby/api/transcript_api.rb +6 -6
- data/lib/daily-ruby/api/webhooks_api.rb +6 -6
- data/lib/daily-ruby/api_client.rb +34 -28
- data/lib/daily-ruby/api_error.rb +1 -1
- data/lib/daily-ruby/configuration.rb +11 -1
- 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 +1 -1
- data/lib/daily-ruby/models/batch_room_create_request_rooms_inner.rb +1 -1
- data/lib/daily-ruby/models/batch_room_delete200_response.rb +1 -1
- data/lib/daily-ruby/models/buy_phone_number_request.rb +215 -0
- data/lib/daily-ruby/models/create_meeting_token200_response.rb +1 -1
- data/lib/daily-ruby/models/create_meeting_token_request.rb +1 -1
- data/lib/daily-ruby/models/create_room200_response.rb +1 -1
- data/lib/daily-ruby/models/create_room_request.rb +1 -1
- data/lib/daily-ruby/models/daily_live_streaming_options.rb +1 -1
- data/lib/daily-ruby/models/daily_live_streaming_options_rtmp_url.rb +1 -1
- data/lib/daily-ruby/models/daily_streaming_active_participant_layout_config.rb +3 -3
- data/lib/daily-ruby/models/daily_streaming_custom_layout_config.rb +4 -4
- data/lib/daily-ruby/models/daily_streaming_custom_layout_config_composition_params.rb +1 -1
- 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 +3 -3
- data/lib/daily-ruby/models/daily_streaming_endpoint.rb +1 -1
- data/lib/daily-ruby/models/daily_streaming_layout_config.rb +1 -1
- data/lib/daily-ruby/models/daily_streaming_options.rb +1 -1
- data/lib/daily-ruby/models/daily_streaming_portrait_layout_config.rb +3 -3
- data/lib/daily-ruby/models/daily_streaming_portrait_layout_variant.rb +3 -2
- data/lib/daily-ruby/models/daily_streaming_single_participant_layout_config.rb +3 -3
- data/lib/daily-ruby/models/delete_transcript200_response.rb +3 -3
- 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/domain.rb +1 -1
- data/lib/daily-ruby/models/domain_properties.rb +74 -16
- data/lib/daily-ruby/models/eject200_response.rb +1 -1
- data/lib/daily-ruby/models/eject_request.rb +30 -6
- data/lib/daily-ruby/models/get_domain_config200_response.rb +1 -1
- data/lib/daily-ruby/models/get_domain_config200_response_config.rb +11 -2
- data/lib/daily-ruby/models/get_domain_config200_response_config_recordings_bucket.rb +1 -1
- data/lib/daily-ruby/models/get_meeting_info200_response.rb +1 -1
- data/lib/daily-ruby/models/get_meeting_info200_response_data_inner.rb +1 -1
- data/lib/daily-ruby/models/get_meeting_info200_response_data_inner_participants_inner.rb +1 -1
- data/lib/daily-ruby/models/get_presence200_response.rb +1 -1
- data/lib/daily-ruby/models/get_presence200_response_aivw_whz_hl_lhr_sd_hdw7_ew_inner.rb +1 -1
- data/lib/daily-ruby/models/get_recording_info200_response.rb +3 -3
- data/lib/daily-ruby/models/get_recording_info200_response_tracks_inner.rb +3 -3
- data/lib/daily-ruby/models/get_recording_link200_response.rb +1 -1
- data/lib/daily-ruby/models/get_transcript_info200_response.rb +4 -4
- data/lib/daily-ruby/models/get_transcript_info200_response_out_params.rb +2 -1
- data/lib/daily-ruby/models/get_transcript_link200_response.rb +1 -1
- data/lib/daily-ruby/models/list_api_logs200_response.rb +2 -2
- data/lib/daily-ruby/models/list_recordings200_response.rb +1 -1
- data/lib/daily-ruby/models/list_recordings200_response_data_inner.rb +1 -1
- data/lib/daily-ruby/models/list_rooms200_response.rb +1 -1
- data/lib/daily-ruby/models/list_rooms200_response_data_inner.rb +1 -1
- data/lib/daily-ruby/models/list_rooms200_response_data_inner_config.rb +1 -1
- data/lib/daily-ruby/models/list_transcript200_response.rb +1 -1
- data/lib/daily-ruby/models/list_transcript200_response_data_inner.rb +3 -3
- data/lib/daily-ruby/models/meeting_ended.rb +278 -0
- data/lib/daily-ruby/models/meeting_ended_payload.rb +246 -0
- data/lib/daily-ruby/models/meeting_participants_get_res.rb +2 -11
- data/lib/daily-ruby/models/meeting_participants_get_res_data_inner.rb +1 -1
- 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 +1 -1
- 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 +1 -1
- data/lib/daily-ruby/models/permissions_can_admin.rb +1 -1
- data/lib/daily-ruby/models/permissions_can_send.rb +1 -1
- 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 +37 -5
- data/lib/daily-ruby/models/properties.rb +17 -7
- data/lib/daily-ruby/models/recording_error.rb +4 -4
- data/lib/daily-ruby/models/recording_error_payload.rb +3 -3
- data/lib/daily-ruby/models/recording_ready_to_download.rb +4 -4
- data/lib/daily-ruby/models/recording_ready_to_download_payload.rb +5 -5
- data/lib/daily-ruby/models/recording_started.rb +4 -4
- data/lib/daily-ruby/models/recording_started_payload.rb +3 -3
- data/lib/daily-ruby/models/recording_streaming_options.rb +3 -3
- data/lib/daily-ruby/models/recordings_bucket.rb +1 -1
- data/lib/daily-ruby/models/room_dial_out_send_dtmf_request.rb +224 -0
- data/lib/daily-ruby/models/room_dial_out_stop_request.rb +215 -0
- data/lib/daily-ruby/models/room_properties.rb +67 -9
- data/lib/daily-ruby/models/room_properties_streaming_endpoints_inner.rb +267 -267
- data/lib/daily-ruby/models/room_properties_streaming_endpoints_inner_hls_config_variants_inner.rb +1 -1
- data/lib/daily-ruby/models/room_sip_call_transfer_request.rb +224 -0
- data/lib/daily-ruby/models/rooms_room_name_get_res.rb +1 -1
- data/lib/daily-ruby/models/rooms_room_name_presence_get_res.rb +1 -1
- data/lib/daily-ruby/models/rooms_room_name_presence_get_res_data_inner.rb +1 -1
- data/lib/daily-ruby/models/send_app_message_request.rb +1 -1
- data/lib/daily-ruby/models/set_room_config_request.rb +1 -1
- data/lib/daily-ruby/models/set_session_data_request.rb +3 -3
- data/lib/daily-ruby/models/streaming_ended.rb +4 -4
- data/lib/daily-ruby/models/streaming_ended_payload.rb +1 -1
- data/lib/daily-ruby/models/streaming_error.rb +4 -4
- data/lib/daily-ruby/models/streaming_error_payload.rb +1 -1
- data/lib/daily-ruby/models/streaming_started.rb +4 -4
- data/lib/daily-ruby/models/streaming_started_payload.rb +1 -1
- data/lib/daily-ruby/models/streaming_updated.rb +4 -4
- data/lib/daily-ruby/models/streaming_updated_payload.rb +1 -1
- data/lib/daily-ruby/models/transcription_bucket.rb +1 -1
- data/lib/daily-ruby/models/transcription_properties.rb +16 -6
- data/lib/daily-ruby/models/transcription_properties_endpointing.rb +1 -1
- data/lib/daily-ruby/models/transcription_properties_redact.rb +1 -1
- data/lib/daily-ruby/models/update_permissions_request.rb +1 -1
- data/lib/daily-ruby/models/update_permissions_request_data_value.rb +1 -1
- data/lib/daily-ruby/models/update_permissions_request_data_value_can_send.rb +1 -1
- data/lib/daily-ruby/models/update_webhook.rb +37 -5
- data/lib/daily-ruby/models/validate_meeting_token200_response.rb +1 -1
- 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 +32 -10
- data/lib/daily-ruby/version.rb +2 -2
- data/lib/daily-ruby.rb +39 -2
- data/pkg/daily-ruby-1.0.2.gem +0 -0
- data/run.sh +3 -3
- data/spec/api/dialin_api_spec.rb +47 -0
- data/spec/api/phone_numbers_api_spec.rb +87 -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/buy_phone_number_request_spec.rb +36 -0
- data/spec/models/{daily_streaming_custom_layout_config_composition_params_spec.rb → daily_streaming_custom_layout_config_composition_params_value_spec.rb} +3 -3
- data/spec/models/dialout_properties_codecs_spec.rb +42 -0
- data/spec/models/dialout_properties_spec.rb +60 -0
- data/spec/models/meeting_ended_payload_spec.rb +54 -0
- data/spec/models/meeting_ended_spec.rb +58 -0
- data/spec/models/meeting_started_payload_spec.rb +48 -0
- data/spec/models/meeting_started_spec.rb +58 -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/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/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_sip_call_transfer_request_spec.rb +42 -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/spec_helper.rb +1 -1
- metadata +171 -6
@@ -0,0 +1,304 @@
|
|
1
|
+
# Daily::PhoneNumbersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.daily.co/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**buy_phone_number**](PhoneNumbersApi.md#buy_phone_number) | **POST** /buy-phone-number | /buy-phone-number |
|
8
|
+
| [**list_available_numbers**](PhoneNumbersApi.md#list_available_numbers) | **GET** /list-available-numbers | /list-available-numbers |
|
9
|
+
| [**purchased_phone_nunbers**](PhoneNumbersApi.md#purchased_phone_nunbers) | **GET** /purchased-phone-numbers | /purchased-phone-numbers |
|
10
|
+
| [**release_phone_number**](PhoneNumbersApi.md#release_phone_number) | **DELETE** /release-phone-number/{id} | release-phone-number/:id |
|
11
|
+
|
12
|
+
|
13
|
+
## buy_phone_number
|
14
|
+
|
15
|
+
> Object buy_phone_number(opts)
|
16
|
+
|
17
|
+
/buy-phone-number
|
18
|
+
|
19
|
+
This will buy a phone number. In the POST request you can either provide the phone number you want to buy, or leave it empty. If the specified `number` is still available, it will be bought or the API will return a failure. Alternatively, if you skipped the `number` field, a random phone number from California (CA) will be bought.
|
20
|
+
|
21
|
+
### Examples
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'time'
|
25
|
+
require 'daily-ruby'
|
26
|
+
# setup authorization
|
27
|
+
Daily.configure do |config|
|
28
|
+
# Configure API key authorization: sec0
|
29
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = Daily::PhoneNumbersApi.new
|
35
|
+
opts = {
|
36
|
+
buy_phone_number_request: Daily::BuyPhoneNumberRequest.new # BuyPhoneNumberRequest |
|
37
|
+
}
|
38
|
+
|
39
|
+
begin
|
40
|
+
# /buy-phone-number
|
41
|
+
result = api_instance.buy_phone_number(opts)
|
42
|
+
p result
|
43
|
+
rescue Daily::ApiError => e
|
44
|
+
puts "Error when calling PhoneNumbersApi->buy_phone_number: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
#### Using the buy_phone_number_with_http_info variant
|
49
|
+
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
51
|
+
|
52
|
+
> <Array(Object, Integer, Hash)> buy_phone_number_with_http_info(opts)
|
53
|
+
|
54
|
+
```ruby
|
55
|
+
begin
|
56
|
+
# /buy-phone-number
|
57
|
+
data, status_code, headers = api_instance.buy_phone_number_with_http_info(opts)
|
58
|
+
p status_code # => 2xx
|
59
|
+
p headers # => { ... }
|
60
|
+
p data # => Object
|
61
|
+
rescue Daily::ApiError => e
|
62
|
+
puts "Error when calling PhoneNumbersApi->buy_phone_number_with_http_info: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
|
68
|
+
| Name | Type | Description | Notes |
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
70
|
+
| **buy_phone_number_request** | [**BuyPhoneNumberRequest**](BuyPhoneNumberRequest.md) | | [optional] |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
**Object**
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[sec0](../README.md#sec0)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: application/json
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## list_available_numbers
|
87
|
+
|
88
|
+
> list_available_numbers(opts)
|
89
|
+
|
90
|
+
/list-available-numbers
|
91
|
+
|
92
|
+
Search for available phone numbers to purchase
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'daily-ruby'
|
99
|
+
# setup authorization
|
100
|
+
Daily.configure do |config|
|
101
|
+
# Configure API key authorization: sec0
|
102
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
103
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
104
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
105
|
+
end
|
106
|
+
|
107
|
+
api_instance = Daily::PhoneNumbersApi.new
|
108
|
+
opts = {
|
109
|
+
areacode: 'areacode_example', # String | An areacode to search within.
|
110
|
+
region: 'region_example', # String | A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. CA for California. Cannot be used in combination with areacode.
|
111
|
+
city: 'city_example', # String | A specific City to search within. Example, New York. The string must be url encoded because it is a url parameter. Must be used in combination with region. Cannot be used in combination with areacode, starts_with, contains, or ends_with.
|
112
|
+
contains: 'contains_example', # String | A string of 3 to 7 digits that should appear somewhere in the number.
|
113
|
+
starts_with: 'starts_with_example', # String | A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with.
|
114
|
+
ends_with: 'ends_with_example' # String | A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains.
|
115
|
+
}
|
116
|
+
|
117
|
+
begin
|
118
|
+
# /list-available-numbers
|
119
|
+
api_instance.list_available_numbers(opts)
|
120
|
+
rescue Daily::ApiError => e
|
121
|
+
puts "Error when calling PhoneNumbersApi->list_available_numbers: #{e}"
|
122
|
+
end
|
123
|
+
```
|
124
|
+
|
125
|
+
#### Using the list_available_numbers_with_http_info variant
|
126
|
+
|
127
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
128
|
+
|
129
|
+
> <Array(nil, Integer, Hash)> list_available_numbers_with_http_info(opts)
|
130
|
+
|
131
|
+
```ruby
|
132
|
+
begin
|
133
|
+
# /list-available-numbers
|
134
|
+
data, status_code, headers = api_instance.list_available_numbers_with_http_info(opts)
|
135
|
+
p status_code # => 2xx
|
136
|
+
p headers # => { ... }
|
137
|
+
p data # => nil
|
138
|
+
rescue Daily::ApiError => e
|
139
|
+
puts "Error when calling PhoneNumbersApi->list_available_numbers_with_http_info: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Parameters
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **areacode** | **String** | An areacode to search within. | [optional] |
|
148
|
+
| **region** | **String** | A region or state to search within. Must be an ISO 3166-2 alpha-2 code, i.e. CA for California. Cannot be used in combination with areacode. | [optional] |
|
149
|
+
| **city** | **String** | A specific City to search within. Example, New York. The string must be url encoded because it is a url parameter. Must be used in combination with region. Cannot be used in combination with areacode, starts_with, contains, or ends_with. | [optional] |
|
150
|
+
| **contains** | **String** | A string of 3 to 7 digits that should appear somewhere in the number. | [optional] |
|
151
|
+
| **starts_with** | **String** | A string of 3 to 7 digits that should be used as the start of a number. Cannot be used in combination with contains or ends_with. | [optional] |
|
152
|
+
| **ends_with** | **String** | A string of 3 to 7 digits that should be used as the end of a number. Cannot be used in combination with starts_with or contains. | [optional] |
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
nil (empty response body)
|
157
|
+
|
158
|
+
### Authorization
|
159
|
+
|
160
|
+
[sec0](../README.md#sec0)
|
161
|
+
|
162
|
+
### HTTP request headers
|
163
|
+
|
164
|
+
- **Content-Type**: Not defined
|
165
|
+
- **Accept**: application/json
|
166
|
+
|
167
|
+
|
168
|
+
## purchased_phone_nunbers
|
169
|
+
|
170
|
+
> purchased_phone_nunbers
|
171
|
+
|
172
|
+
/purchased-phone-numbers
|
173
|
+
|
174
|
+
List the purchased phone numbers for this domain
|
175
|
+
|
176
|
+
### Examples
|
177
|
+
|
178
|
+
```ruby
|
179
|
+
require 'time'
|
180
|
+
require 'daily-ruby'
|
181
|
+
# setup authorization
|
182
|
+
Daily.configure do |config|
|
183
|
+
# Configure API key authorization: sec0
|
184
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
185
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
186
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
187
|
+
end
|
188
|
+
|
189
|
+
api_instance = Daily::PhoneNumbersApi.new
|
190
|
+
|
191
|
+
begin
|
192
|
+
# /purchased-phone-numbers
|
193
|
+
api_instance.purchased_phone_nunbers
|
194
|
+
rescue Daily::ApiError => e
|
195
|
+
puts "Error when calling PhoneNumbersApi->purchased_phone_nunbers: #{e}"
|
196
|
+
end
|
197
|
+
```
|
198
|
+
|
199
|
+
#### Using the purchased_phone_nunbers_with_http_info variant
|
200
|
+
|
201
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
202
|
+
|
203
|
+
> <Array(nil, Integer, Hash)> purchased_phone_nunbers_with_http_info
|
204
|
+
|
205
|
+
```ruby
|
206
|
+
begin
|
207
|
+
# /purchased-phone-numbers
|
208
|
+
data, status_code, headers = api_instance.purchased_phone_nunbers_with_http_info
|
209
|
+
p status_code # => 2xx
|
210
|
+
p headers # => { ... }
|
211
|
+
p data # => nil
|
212
|
+
rescue Daily::ApiError => e
|
213
|
+
puts "Error when calling PhoneNumbersApi->purchased_phone_nunbers_with_http_info: #{e}"
|
214
|
+
end
|
215
|
+
```
|
216
|
+
|
217
|
+
### Parameters
|
218
|
+
|
219
|
+
This endpoint does not need any parameter.
|
220
|
+
|
221
|
+
### Return type
|
222
|
+
|
223
|
+
nil (empty response body)
|
224
|
+
|
225
|
+
### Authorization
|
226
|
+
|
227
|
+
[sec0](../README.md#sec0)
|
228
|
+
|
229
|
+
### HTTP request headers
|
230
|
+
|
231
|
+
- **Content-Type**: Not defined
|
232
|
+
- **Accept**: application/json
|
233
|
+
|
234
|
+
|
235
|
+
## release_phone_number
|
236
|
+
|
237
|
+
> Object release_phone_number(id)
|
238
|
+
|
239
|
+
release-phone-number/:id
|
240
|
+
|
241
|
+
Release a purchased number. The number is referenced by its id. A number cannot be deleted within the 14 days of purchase. Calling this API before this period expires results in an error.
|
242
|
+
|
243
|
+
### Examples
|
244
|
+
|
245
|
+
```ruby
|
246
|
+
require 'time'
|
247
|
+
require 'daily-ruby'
|
248
|
+
# setup authorization
|
249
|
+
Daily.configure do |config|
|
250
|
+
# Configure API key authorization: sec0
|
251
|
+
config.api_key['sec0'] = 'YOUR API KEY'
|
252
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
253
|
+
# config.api_key_prefix['sec0'] = 'Bearer'
|
254
|
+
end
|
255
|
+
|
256
|
+
api_instance = Daily::PhoneNumbersApi.new
|
257
|
+
id = 'id_example' # String |
|
258
|
+
|
259
|
+
begin
|
260
|
+
# release-phone-number/:id
|
261
|
+
result = api_instance.release_phone_number(id)
|
262
|
+
p result
|
263
|
+
rescue Daily::ApiError => e
|
264
|
+
puts "Error when calling PhoneNumbersApi->release_phone_number: #{e}"
|
265
|
+
end
|
266
|
+
```
|
267
|
+
|
268
|
+
#### Using the release_phone_number_with_http_info variant
|
269
|
+
|
270
|
+
This returns an Array which contains the response data, status code and headers.
|
271
|
+
|
272
|
+
> <Array(Object, Integer, Hash)> release_phone_number_with_http_info(id)
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
begin
|
276
|
+
# release-phone-number/:id
|
277
|
+
data, status_code, headers = api_instance.release_phone_number_with_http_info(id)
|
278
|
+
p status_code # => 2xx
|
279
|
+
p headers # => { ... }
|
280
|
+
p data # => Object
|
281
|
+
rescue Daily::ApiError => e
|
282
|
+
puts "Error when calling PhoneNumbersApi->release_phone_number_with_http_info: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
| Name | Type | Description | Notes |
|
289
|
+
| ---- | ---- | ----------- | ----- |
|
290
|
+
| **id** | **String** | | |
|
291
|
+
|
292
|
+
### Return type
|
293
|
+
|
294
|
+
**Object**
|
295
|
+
|
296
|
+
### Authorization
|
297
|
+
|
298
|
+
[sec0](../README.md#sec0)
|
299
|
+
|
300
|
+
### HTTP request headers
|
301
|
+
|
302
|
+
- **Content-Type**: Not defined
|
303
|
+
- **Accept**: application/json
|
304
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Daily::PinDialinInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **phone_number** | **String** | Associate a purchased phone number to the dialin with PIN workflow. | [optional] |
|
8
|
+
| **name_prefix** | **String** | An identifier or name to associate to the workflow. | [optional] |
|
9
|
+
| **ivr_greeting** | [**PinDialinInnerIvrGreeting**](PinDialinInnerIvrGreeting.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'daily-ruby'
|
15
|
+
|
16
|
+
instance = Daily::PinDialinInner.new(
|
17
|
+
phone_number: null,
|
18
|
+
name_prefix: null,
|
19
|
+
ivr_greeting: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Daily::PinDialinInnerIvrGreeting
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **message** | **String** | message to \"Say\" when user call the phone_number. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'daily-ruby'
|
13
|
+
|
14
|
+
instance = Daily::PinDialinInnerIvrGreeting.new(
|
15
|
+
message: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Daily::PinlessCallUpdateRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_id** | **String** | CallId is represented by UUID and represents the sessionId in the SIP Network. | [optional] |
|
8
|
+
| **call_domain** | **String** | Call Domain is represented by UUID and represents your Daily Domain on the SIP Network. | [optional] |
|
9
|
+
| **sip_uri** | **String** | This SIP URI is associated to the Daily Room that you want to forward the SIP Interconnect call to. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'daily-ruby'
|
15
|
+
|
16
|
+
instance = Daily::PinlessCallUpdateRequest.new(
|
17
|
+
call_id: null,
|
18
|
+
call_domain: null,
|
19
|
+
sip_uri: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# Daily::PinlessDialinInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **phone_number** | **String** | Associate a purchased phone number to the Pinless dialin workflow. | [optional] |
|
8
|
+
| **room_creation_api** | **String** | The webhook URL to trigger when an incoming call arrives. Typically, you will need to spin-up a Daily meeting room and patch the incoming call to the room. Read more in the [pinless/sip interconnect guide](/guides/products/dial-in-dial-out/dialin-pinless#incoming-call-triggers-the-webhook). | [optional] |
|
9
|
+
| **name_prefix** | **String** | An identifier or name to associate to the workflow. | [optional] |
|
10
|
+
| **sip_uri** | **String** | This is not a settable value, Daily returns the `sip_uri` in cases where you want to directly send the call to the SIP URI instead of the phone_number. If you dial in to the `phone_number` or this `sip_uri`, the [webhook will be triggered](/guides/products/dial-in-dial-out/dialin-pinless#incoming-call-triggers-the-webhook). | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'daily-ruby'
|
16
|
+
|
17
|
+
instance = Daily::PinlessDialinInner.new(
|
18
|
+
phone_number: null,
|
19
|
+
room_creation_api: null,
|
20
|
+
name_prefix: null,
|
21
|
+
sip_uri: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/PostWebhook.md
CHANGED
@@ -6,7 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **url** | **String** | The webhook server endpoint that was provided. | [optional] |
|
8
8
|
| **basic_auth** | **String** | The basic auth credentials that will be used to POST to the webhook URL. | [optional] |
|
9
|
+
| **retry_type** | **String** | The retry configuration for this webhook endpoint to use. The default is circuit-breaker. | [optional] |
|
9
10
|
| **event_types** | **Array<String>** | The set of event types this webhook is subscribed to. | [optional] |
|
11
|
+
| **hmac** | **String** | A secret that can be used to verify the signature of the webhook. If not provided, an hmac will be provisioned for you and returned. | [optional] |
|
10
12
|
|
11
13
|
## Example
|
12
14
|
|
@@ -16,7 +18,9 @@ require 'daily-ruby'
|
|
16
18
|
instance = Daily::PostWebhook.new(
|
17
19
|
url: null,
|
18
20
|
basic_auth: null,
|
19
|
-
|
21
|
+
retry_type: null,
|
22
|
+
event_types: null,
|
23
|
+
hmac: null
|
20
24
|
)
|
21
25
|
```
|
22
26
|
|
data/docs/Properties.md
CHANGED
@@ -11,12 +11,13 @@
|
|
11
11
|
| **exp** | **Integer** | \"Expires\". This is a unix timestamp (seconds since the epoch.) Users cannot join a meeting with this token after this time. Daily strongly recommends adding an `exp` value to all meeting tokens. Learn more in our Daily blog post: [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/) | [optional] |
|
12
12
|
| **is_owner** | **Boolean** | The user has [meeting owner privileges](https://docs.daily.co/docs/controlling-who-joins-a-meeting#meeting-owner-privileges). For example, if the room is configured for `owner_only_broadcast` and used in a Daily Prebuilt call, this user can send video, and audio, and can screenshare. | [optional][default to false] |
|
13
13
|
| **user_name** | **String** | The user's name in this meeting. The name displays in the user interface when the user is muted or has turned off the camera, and in the chat window. This username is also saved in the meeting events log (meeting events are retrievable using the [analytics](/reference/rest-api/meetings) API methods.) | [optional] |
|
14
|
-
| **user_id** | **String** | The user's ID for this meeting session.
|
14
|
+
| **user_id** | **String** | The user's ID for this meeting session. During a session, this ID is retrievable in the [`participants()`](/reference/daily-js/instance-methods/participants) method and [related participant events](/reference/daily-js/events/participant-events). Either during or after a session concludes, this ID is retrievable using the [/meetings](/reference/rest-api/meetings) REST API endpoint. You can use `user_id` to map between your user database and meeting events/attendance. For domains configured for [HIPAA compliance](/guides/privacy-and-security/hipaa), if the `user_id` value is a [UUID](https://www.ietf.org/rfc/rfc4122.txt) (for example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`), then the UUID will be returned for the participant in the [`/meetings`](/reference/rest-api/meetings) REST API endpoint. Otherwise, the string `hipaa` will be returned in order to remove potential PHI. During a session, the provided `user_id` will always be returned through the `participants()` method and related events, regardless of the `user_id` value. The `user_id` has a limit of 36 characters. | [optional] |
|
15
15
|
| **enable_screenshare** | **Boolean** | Sets whether or not the user is allowed to screen share. This setting applies for the duration of the meeting. If you're looking to dynamically control whether a user can screen share during a meeting, then use the [`permissions`](/reference/rest-api/meeting-tokens/config#permissions) token property. | [optional][default to true] |
|
16
16
|
| **start_video_off** | **Boolean** | Disable the default behavior of automatically turning on a participant's camera on a direct `join()` (i.e. without `startCamera()` first). | [optional][default to false] |
|
17
17
|
| **start_audio_off** | **Boolean** | Disable the default behavior of automatically turning on a participant's microphone on a direct `join()` (i.e. without `startCamera()` first). | [optional][default to false] |
|
18
18
|
| **enable_recording** | **String** | Jump to [recording docs](/reference/rest-api/recordings). | [optional] |
|
19
19
|
| **enable_prejoin_ui** | **Boolean** | Determines whether the participant using the meeting token enters a waiting room with a camera, mic, and browser check before joining a call. If this property is also set in the room or domain's configuration, the meeting token's configuration will take priority. ⚠️ You must be using [Daily Prebuilt](https://daily.co/prebuilt) to use `enable_prejoin_ui`. | [optional] |
|
20
|
+
| **enable_live_captions_ui** | **Boolean** | Sets whether the participant sees a closed captions button in their Daily Prebuilt call tray. When the closed caption button is clicked, closed captions are displayed locally. When set to `true`, a closed captions button appears in the call tray. When set to `false`, the closed captions button is hidden from the call tray. Note: Transcription must be enabled for the room or users must have permission to start transcription for this feature to be enabled. View the [transcription guide](/guides/products/transcription) for more details. ⚠️ You must be using [Daily Prebuilt](https://daily.co/blog/daily-prebuilt-video-chat) to use `enable_live_captions_ui`. | [optional] |
|
20
21
|
| **enable_recording_ui** | **Boolean** | Determines whether the participant using the meeting token can see the Recording button in Daily Prebuilt's UI, which can be found in the video call tray. If this value is `false`, the button will not be included in the tray. If it's `true`, the Recording button will be displayed. This option is useful when only specific call participants should have recording permissions. ⚠️ You must be using [Daily Prebuilt](https://daily.co/prebuilt) to use `enable_recording_ui`. | [optional] |
|
21
22
|
| **enable_terse_logging** | **Boolean** | 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. | [optional][default to false] |
|
22
23
|
| **start_cloud_recording** | **Boolean** | Start cloud recording when the user joins the room. This can be used to always record and archive meetings, for example in a customer support context. Note: This requires the `enable_recording` property of the room or token to be set to `cloud`. If you want to automatically record calls with other recording modes, use `callObject.startRecording()` after `await callObject.join()` in your code. | [optional][default to false] |
|
@@ -46,6 +47,7 @@ instance = Daily::Properties.new(
|
|
46
47
|
start_audio_off: null,
|
47
48
|
enable_recording: null,
|
48
49
|
enable_prejoin_ui: null,
|
50
|
+
enable_live_captions_ui: null,
|
49
51
|
enable_recording_ui: null,
|
50
52
|
enable_terse_logging: null,
|
51
53
|
start_cloud_recording: null,
|
data/docs/RecordingError.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **version** | **String** | The semantic version of the current message. | [optional] |
|
8
8
|
| **type** | **String** | The type of event that is being provided. | [optional] |
|
9
|
-
| **event_ts** | **
|
9
|
+
| **event_ts** | **Float** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
|
10
10
|
| **payload** | [**RecordingErrorPayload**](RecordingErrorPayload.md) | | [optional] |
|
11
11
|
|
12
12
|
## Example
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **version** | **String** | The semantic version of the current message. | [optional] |
|
8
8
|
| **type** | **String** | The type of event that is being provided. | [optional] |
|
9
|
-
| **event_ts** | **
|
9
|
+
| **event_ts** | **Float** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
|
10
10
|
| **payload** | [**RecordingReadyToDownloadPayload**](RecordingReadyToDownloadPayload.md) | | [optional] |
|
11
11
|
|
12
12
|
## Example
|
data/docs/RecordingStarted.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **version** | **String** | The semantic version of the current message. | [optional] |
|
8
8
|
| **type** | **String** | The type of event that is being provided. | [optional] |
|
9
|
-
| **event_ts** | **
|
9
|
+
| **event_ts** | **Float** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
|
10
10
|
| **payload** | [**RecordingStartedPayload**](RecordingStartedPayload.md) | | [optional] |
|
11
11
|
|
12
12
|
## Example
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Daily::RoomDialOutSendDTMFRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **session_id** | **String** | | [optional] |
|
8
|
+
| **tones** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'daily-ruby'
|
14
|
+
|
15
|
+
instance = Daily::RoomDialOutSendDTMFRequest.new(
|
16
|
+
session_id: null,
|
17
|
+
tones: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Daily::RoomDialOutStopRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **session_id** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'daily-ruby'
|
13
|
+
|
14
|
+
instance = Daily::RoomDialOutStopRequest.new(
|
15
|
+
session_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/RoomProperties.md
CHANGED
@@ -12,6 +12,7 @@
|
|
12
12
|
| **enable_emoji_reactions** | **Boolean** | 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. | [optional] |
|
13
13
|
| **enable_hand_raising** | **Boolean** | 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. | [optional] |
|
14
14
|
| **enable_prejoin_ui** | **Boolean** | 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`. | [optional] |
|
15
|
+
| **enable_live_captions_ui** | **Boolean** | Sets whether participants in a room see a closed captions button in their Daily Prebuilt call tray. When the closed caption button is clicked, closed captions are displayed locally. When set to `true`, a closed captions button appears in the call tray. When set to `false`, the closed captions button is hidden from the call tray. Note: Transcription must be enabled for the room or users must have permission to start transcription for this feature to be enabled. View the [transcription guide](/guides/products/transcription) for more details. ⚠️ You must be using [Daily Prebuilt](https://daily.co/blog/daily-prebuilt-video-chat) to use `enable_live_captions_ui`. | [optional] |
|
15
16
|
| **enable_network_ui** | **Boolean** | 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`. | [optional] |
|
16
17
|
| **enable_noise_cancellation_ui** | **Boolean** | 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). | [optional] |
|
17
18
|
| **enable_breakout_rooms** | **Boolean** | 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. | [optional] |
|
@@ -19,6 +20,7 @@
|
|
19
20
|
| **enable_screenshare** | **Boolean** | 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. | [optional][default to true] |
|
20
21
|
| **enable_video_processing_ui** | **Boolean** | 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. | [optional][default to true] |
|
21
22
|
| **enable_chat** | **Boolean** | 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/). | [optional][default to false] |
|
23
|
+
| **enable_shared_chat_history** | **Boolean** | When enabled, newly joined participants in Prebuilt calls will request chat history from remote peers, in order to view chat messages from before they joined. | [optional][default to true] |
|
22
24
|
| **start_video_off** | **Boolean** | Disable the default behavior of automatically turning on a participant's camera on a direct `join()` (i.e. without `startCamera()` first). | [optional][default to false] |
|
23
25
|
| **start_audio_off** | **Boolean** | Disable the default behavior of automatically turning on a participant's microphone on a direct `join()` (i.e. without `startCamera()` first). | [optional][default to false] |
|
24
26
|
| **owner_only_broadcast** | **Boolean** | 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). | [optional][default to false] |
|
@@ -28,10 +30,13 @@
|
|
28
30
|
| **enable_advanced_chat** | **Boolean** | 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. | [optional][default to false] |
|
29
31
|
| **enable_hidden_participants** | **Boolean** | 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. | [optional][default to false] |
|
30
32
|
| **enable_mesh_sfu** | **Boolean** | 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. | [optional] |
|
31
|
-
| **sfu_switchover** | **Float** | 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 `
|
33
|
+
| **sfu_switchover** | **Float** | Dictates the participant count after which room topology automatically switches from Peer-to-Peer (P2P) to Selective Forwarding Unit (SFU) mode, or vice versa. For example, if `sfu_switchover` is set to `2` and the current network topology is P2P, the topology will switch to SFU mode when the _third_ participant joins the call. If the current topology is SFU, it will switch to P2P mode when the participant count decreases from `2` to `1`. We recommend specifying an integer value for this property except for cases where you would like the room to switch to SFU mode as soon as the first participant joins. In this case, set `sfu_switchover` to `0.5`. See our [guide about video call architecture](/guides/architecture-and-monitoring/intro-to-video-arch#the-architecture-of-a-room-p2p-vs-sfu-calls) for additional information. | [optional][default to 0.5] |
|
34
|
+
| **enable_adaptive_simulcast** | **Boolean** | Configures a domain or room to use [Daily Adaptive Bitrate](/guides/building-additional-features/daily-adaptive-bitrate). When enabled, along with configuring the client to [`allowAdaptiveLayers`](/reference/daily-js/instance-methods/update-send-settings#sendsettings), the Daily client will continually adapt send settings to the current network conditions. `allowAdaptiveLayers` is `true` by default; if you haven't modified that setting, then setting `enable_adaptive_simulcast` to `true` will enable Daily Adaptive Bitrate for 1:1 calls. | [optional][default to true] |
|
35
|
+
| **enable_multiparty_adaptive_simulcast** | **Boolean** | Configures a domain or room to use [Daily Adaptive Bitrate](/guides/building-additional-features/daily-adaptive-bitrate). When enabled, along with configuring the client to [`allowAdaptiveLayers`](/reference/daily-js/instance-methods/update-send-settings#sendsettings), the Daily client will continually adapt send settings to the current network conditions. `allowAdaptiveLayers` is `true` by default; if you haven't modified that setting, then setting `enable_multiparty_adaptive_simulcast` to `true` will enable Daily Adaptive Bitrate for multi-party calls. To use this feature, `enable_adaptive_simulcast` must also be set to `true`. | [optional][default to false] |
|
36
|
+
| **enforce_unique_user_ids** | **Boolean** | Configures a domain or room to disallow multiple participants from having the same `user_id`. This feature can be enabled to prevent users from \"sharing\" meeting tokens. When enabled, a participant joining or reconnecting to a meeting will cause existing participants with the same user_id to be ejected. | [optional][default to false] |
|
32
37
|
| **experimental_optimize_large_calls** | **Boolean** | 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. | [optional] |
|
33
38
|
| **lang** | **String** | 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. | [optional][default to 'en'] |
|
34
|
-
| **meeting_join_hook** | **String** | Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255.
|
39
|
+
| **meeting_join_hook** | **String** | Sets a URL that will receive a webhook when a user joins a room. Default is NULL. Character limit for webhook URL is 255. ⚠️ In place of the `meeting_join_hook`, we recommend setting up a [webhook](/reference/rest-api/webhooks) and listening for the [`participant.joined`](/reference/rest-api/webhooks/events/participant-joined) event. | [optional] |
|
35
40
|
| **geo** | **String** | 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) | [optional][default to 'NULL'] |
|
36
41
|
| **rtmp_geo** | **String** | 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\"` | [optional][default to 'The closest available region to the SFU region used by the meeting.'] |
|
37
42
|
| **disable_rtmp_geo_fallback** | **Boolean** | 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. | [optional][default to false] |
|
@@ -58,6 +63,7 @@ instance = Daily::RoomProperties.new(
|
|
58
63
|
enable_emoji_reactions: null,
|
59
64
|
enable_hand_raising: null,
|
60
65
|
enable_prejoin_ui: null,
|
66
|
+
enable_live_captions_ui: null,
|
61
67
|
enable_network_ui: null,
|
62
68
|
enable_noise_cancellation_ui: null,
|
63
69
|
enable_breakout_rooms: null,
|
@@ -65,6 +71,7 @@ instance = Daily::RoomProperties.new(
|
|
65
71
|
enable_screenshare: null,
|
66
72
|
enable_video_processing_ui: null,
|
67
73
|
enable_chat: null,
|
74
|
+
enable_shared_chat_history: null,
|
68
75
|
start_video_off: null,
|
69
76
|
start_audio_off: null,
|
70
77
|
owner_only_broadcast: null,
|
@@ -75,6 +82,9 @@ instance = Daily::RoomProperties.new(
|
|
75
82
|
enable_hidden_participants: null,
|
76
83
|
enable_mesh_sfu: null,
|
77
84
|
sfu_switchover: null,
|
85
|
+
enable_adaptive_simulcast: null,
|
86
|
+
enable_multiparty_adaptive_simulcast: null,
|
87
|
+
enforce_unique_user_ids: null,
|
78
88
|
experimental_optimize_large_calls: null,
|
79
89
|
lang: null,
|
80
90
|
meeting_join_hook: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Daily::RoomSipCallTransferRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **session_id** | **String** | | [optional] |
|
8
|
+
| **to_end_point** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'daily-ruby'
|
14
|
+
|
15
|
+
instance = Daily::RoomSipCallTransferRequest.new(
|
16
|
+
session_id: null,
|
17
|
+
to_end_point: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|