daily-ruby 0.0.0 → 1.0.0

data/docs/MeetingsMeetingGetRes.md

@@ -0,0 +1,28 @@
+# Daily::MeetingsMeetingGetRes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **room** | **String** |  | [optional] |
+| **start_time** | **Integer** |  | [optional] |
+| **duration** | **Integer** |  | [optional] |
+| **ongoing** | **Boolean** |  | [optional] |
+| **max_participants** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::MeetingsMeetingGetRes.new(
+  id: d61cd7b2-a273-42b4-89bd-be763fd562c1,
+  room: room-name,
+  start_time: 1672606399,
+  duration: 2055,
+  ongoing: false,
+  max_participants: 4
+)
+```
+

data/docs/Permissions.md

@@ -0,0 +1,22 @@
+# Daily::Permissions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_presence** | **Boolean** | Whether the participant appears as \"present\" in the call, i.e. whether they appear in [`participants()`](/reference/daily-js/instance-methods/participants#main). | [optional] |
+| **can_send** | [**PermissionsCanSend**](PermissionsCanSend.md) |  | [optional] |
+| **can_admin** | [**PermissionsCanAdmin**](PermissionsCanAdmin.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::Permissions.new(
+  has_presence: null,
+  can_send: null,
+  can_admin: null
+)
+```
+

data/docs/{MeetingTokenRequestPropertiesPermissionsCanSend.md → PermissionsCanAdmin.md}

@@ -1,4 +1,4 @@
-# Daily::MeetingTokenRequestPropertiesPermissionsCanSend
+# Daily::PermissionsCanAdmin
 
 ## Class instance methods
 
@@ -11,7 +11,7 @@ Returns the list of classes defined in oneOf.
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanSend.openapi_one_of
+Daily::PermissionsCanAdmin.openapi_one_of
 # =>
 # [
 #   :'Array<String>',
@@ -28,10 +28,10 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanSend.build(data)
+Daily::PermissionsCanAdmin.build(data)
 # => #<Array<String>:0x00007fdd4aab02a0>
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanSend.build(data_that_doesnt_match)
+Daily::PermissionsCanAdmin.build(data_that_doesnt_match)
 # => nil
 ```
 

data/docs/{MeetingTokenRequestPropertiesPermissionsCanAdmin.md → PermissionsCanSend.md}

@@ -1,4 +1,4 @@
-# Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin
+# Daily::PermissionsCanSend
 
 ## Class instance methods
 
@@ -11,7 +11,7 @@ Returns the list of classes defined in oneOf.
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.openapi_one_of
+Daily::PermissionsCanSend.openapi_one_of
 # =>
 # [
 #   :'Array<String>',
@@ -28,10 +28,10 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.build(data)
+Daily::PermissionsCanSend.build(data)
 # => #<Array<String>:0x00007fdd4aab02a0>
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.build(data_that_doesnt_match)
+Daily::PermissionsCanSend.build(data_that_doesnt_match)
 # => nil
 ```
 

data/docs/PostWebhook.md

@@ -0,0 +1,22 @@
+# Daily::PostWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The webhook server endpoint that was provided. | [optional] |
+| **basic_auth** | **String** | The basic auth credentials that will be used to POST to the webhook URL. | [optional] |
+| **event_types** | **Array<String>** | The set of event types this webhook is subscribed to. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::PostWebhook.new(
+  url: null,
+  basic_auth: null,
+  event_types: null
+)
+```
+

data/docs/PresenceApi.md

@@ -0,0 +1,74 @@
+# Daily::PresenceApi
+
+All URIs are relative to *https://api.daily.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_presence**](PresenceApi.md#get_presence) | **GET** /presence | /presence |
+
+
+## get_presence
+
+> <GetPresence200Response> get_presence
+
+/presence
+
+### Examples
+
+```ruby
+require 'time'
+require 'daily-ruby'
+# setup authorization
+Daily.configure do |config|
+  # Configure API key authorization: sec0
+  config.api_key['sec0'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['sec0'] = 'Bearer'
+end
+
+api_instance = Daily::PresenceApi.new
+
+begin
+  # /presence
+  result = api_instance.get_presence
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling PresenceApi->get_presence: #{e}"
+end
+```
+
+#### Using the get_presence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPresence200Response>, Integer, Hash)> get_presence_with_http_info
+
+```ruby
+begin
+  # /presence
+  data, status_code, headers = api_instance.get_presence_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPresence200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling PresenceApi->get_presence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetPresence200Response**](GetPresence200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Properties.md

@@ -0,0 +1,60 @@
+# Daily::Properties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **room_name** | **String** | The room for which this token is valid. If `room_name` isn't set, the token is valid for all rooms in your domain. *You should always set `room_name` if you are using this token to control access to a meeting. | [optional] |
+| **eject_at_token_exp** | **Boolean** | Kick this user out of the meeting at the time this meeting token expires. If either this property or `eject_after_elapsed` are set for the token, the room's `eject` properties are overridden.  _See an example in our [advanced security tutorial](https://www.daily.co/blog/add-advanced-security-features-to-video-chats-with-the-daily-api/)_. | [optional][default to false] |
+| **eject_after_elapsed** | **Integer** | Kick this user out of the meeting this many seconds after they join the meeting. If either this property or `eject_at_token_exp` are set for the token, the room's `eject` properties are overridden.  _See an example in our [advanced security tutorial](https://www.daily.co/blog/add-advanced-security-features-to-video-chats-with-the-daily-api/)_. | [optional] |
+| **nbf** | **Integer** | \"Not before\". This is a [unix timestamp](https://stackoverflow.com/questions/20822821/what-is-a-unix-timestamp-and-why-use-it) (seconds since the epoch.) Users cannot join a meeting in with this token before this time. | [optional] |
+| **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] |
+| **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] |
+| **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] |
+| **user_id** | **String** | The user's ID for this meeting session. This ID is retrievable using the [meetings](/reference/rest-api/meetings) API. You can use `user_id` to map between your user database and meeting events/attendance. *The ID does not display in our standard in-call UI during the call.  _max length 36 chars_ | [optional] |
+| **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] |
+| **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] |
+| **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] |
+| **enable_recording** | **String** | Jump to [recording docs](/reference/rest-api/recordings). | [optional] |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **start_cloud_recording_opts** | **Object** | Options for use when `start_cloud_recording` is `true`. See [`startRecording`](/reference/daily-js/instance-methods/start-recording) for available options.  ⚠️ Specifying too many options may cause the token size to be very large. It is recommended to use token less than 2048 characters. For complex usecases, use the daily-js API. | [optional] |
+| **auto_start_transcription** | **Boolean** | Start transcription when an owner joins the room. This property can be used to always transcribe meetings once an owner joins. | [optional][default to false] |
+| **close_tab_on_exit** | **Boolean** | (For meetings that open in a separate browser tab.) When a user leaves a meeting using the button in the in-call menu bar, the browser tab closes. This can be a good way, especially on mobile, for users to be returned to a previous website flow after a call. | [optional][default to false] |
+| **redirect_on_meeting_exit** | **String** | (For meetings that open in a separate browser tab.) When a user leaves a meeting using the button in the in-call menu bar, the browser loads this URL. A query string that includes a parameter of the form `recent-call=<domain>/<room>` is appended to the URL. On mobile, you can redirect to a deep link to bring a user back into your app. | [optional] |
+| **lang** | **String** | The default language of the [Daily prebuilt video call UI](https://docs.daily.co/docs/embed-the-daily-prebuilt-ui#daily-prebuilt-ui), for this room.   Setting the language at the token level will override any room or 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'] |
+| **permissions** | [**Permissions**](Permissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::Properties.new(
+  room_name: null,
+  eject_at_token_exp: null,
+  eject_after_elapsed: null,
+  nbf: null,
+  exp: null,
+  is_owner: null,
+  user_name: null,
+  user_id: null,
+  enable_screenshare: null,
+  start_video_off: null,
+  start_audio_off: null,
+  enable_recording: null,
+  enable_prejoin_ui: null,
+  enable_recording_ui: null,
+  enable_terse_logging: null,
+  start_cloud_recording: null,
+  start_cloud_recording_opts: null,
+  auto_start_transcription: null,
+  close_tab_on_exit: null,
+  redirect_on_meeting_exit: null,
+  lang: null,
+  permissions: null
+)
+```
+

data/docs/RecordingError.md

@@ -0,0 +1,24 @@
+# Daily::RecordingError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | The semantic version of the current message. | [optional] |
+| **type** | **String** | The type of event that is being provided. | [optional] |
+| **event_ts** | **Integer** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
+| **payload** | [**RecordingErrorPayload**](RecordingErrorPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingError.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/RecordingErrorPayload.md

@@ -0,0 +1,26 @@
+# Daily::RecordingErrorPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | A string describing the event that was emitted. | [optional] |
+| **error_msg** | **String** | The error message returned. | [optional] |
+| **instance_id** | **String** | The recording instance ID that was passed into the start recording command. | [optional] |
+| **room_name** | **String** | The name of the room where the recording was made. | [optional] |
+| **timestamp** | **Integer** | The Unix epoch time in seconds representing when the error was emitted. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingErrorPayload.new(
+  action: null,
+  error_msg: null,
+  instance_id: null,
+  room_name: null,
+  timestamp: null
+)
+```
+

data/docs/RecordingReadyToDownload.md

@@ -0,0 +1,24 @@
+# Daily::RecordingReadyToDownload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | The semantic version of the current message. | [optional] |
+| **type** | **String** | The type of event that is being provided. | [optional] |
+| **event_ts** | **Integer** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
+| **payload** | [**RecordingReadyToDownloadPayload**](RecordingReadyToDownloadPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingReadyToDownload.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/RecordingReadyToDownloadPayload.md

@@ -0,0 +1,34 @@
+# Daily::RecordingReadyToDownloadPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | The type of recording that was generated. | [optional] |
+| **recording_id** | **String** | An ID identifying the recording that was generated. | [optional] |
+| **room_name** | **String** | The name of the room where the recording was made. | [optional] |
+| **start_ts** | **Integer** | The Unix epoch time in seconds representing when the recording started. | [optional] |
+| **status** | **String** | The status of the given recording. | [optional] |
+| **max_participants** | **Integer** | The number of participants on the call that were recorded. | [optional] |
+| **duration** | **Integer** | The duration in seconds of the call. | [optional] |
+| **s3_key** | **String** | The location of the recording in the provided S3 bucket. | [optional] |
+| **tracks** | [**Array<GetRecordingInfo200ResponseTracksInner>**](GetRecordingInfo200ResponseTracksInner.md) | If the recording is a raw-tracks recording, a tracks field will be provided. If role permissions have been removed, the tracks field may be null. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingReadyToDownloadPayload.new(
+  type: null,
+  recording_id: null,
+  room_name: null,
+  start_ts: null,
+  status: null,
+  max_participants: null,
+  duration: null,
+  s3_key: null,
+  tracks: null
+)
+```
+

data/docs/RecordingStarted.md

@@ -0,0 +1,24 @@
+# Daily::RecordingStarted
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | The semantic version of the current message. | [optional] |
+| **type** | **String** | The type of event that is being provided. | [optional] |
+| **event_ts** | **Integer** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
+| **payload** | [**RecordingStartedPayload**](RecordingStartedPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingStarted.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/RecordingStartedPayload.md

@@ -0,0 +1,28 @@
+# Daily::RecordingStartedPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recording_id** | **String** | An ID identifying the recording that was generated. | [optional] |
+| **action** | **String** | A string describing the event that was emitted. | [optional] |
+| **layout** | [**DailyStreamingLayoutConfig**](.md) |  | [optional] |
+| **started_by** | **String** | The participant ID of the user who started the recording. | [optional] |
+| **instance_id** | **String** | The recording instance ID that was passed into the start recording command. | [optional] |
+| **start_ts** | **Integer** | The Unix epoch time in seconds representing when the recording started. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingStartedPayload.new(
+  recording_id: null,
+  action: null,
+  layout: null,
+  started_by: null,
+  instance_id: null,
+  start_ts: null
+)
+```
+

data/docs/RecordingStreamingOptions.md

@@ -0,0 +1,38 @@
+# Daily::RecordingStreamingOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **width** | **Float** | Property that specifies the output width of the given stream. | [optional] |
+| **height** | **Float** | Property that specifies the output height of the given stream. | [optional] |
+| **fps** | **Float** | Property that specifies the video frame rate per second. | [optional] |
+| **video_bitrate** | **Float** | Property that specifies the video bitrate for the output video in kilobits per second (kbps). | [optional] |
+| **audio_bitrate** | **Float** | Property that specifies the audio bitrate for the output audio in kilobits per second (kbps). | [optional] |
+| **min_idle_time_out** | **Float** | Amount of time in seconds to wait before ending a recording or live stream when the room is idle (e.g. when all users have muted video and audio). Default: 300 (seconds). Note: Once the timeout has been reached, it typically takes an additional 1-3 minutes for the recording or live stream to be shut down. | [optional] |
+| **max_duration** | **Float** | Maximum duration in seconds after which recording/streaming is forcefully stopped. Default: \\`15000\\` seconds (3 hours). This is a preventive circuit breaker to prevent billing surprises in case a user starts recording/streaming and leaves the room. | [optional] |
+| **background_color** | **String** | Specifies the background color of the stream, formatted as \\#rrggbb or \\#aarrggbb string. | [optional] |
+| **instance_id** | **String** | UUID for a streaming or recording session. Used when multiple streaming or recording sessions are running for single room. | [optional] |
+| **type** | **String** | The type of recording that will be started. | [optional][default to 'cloud'] |
+| **layout** | [**DailyStreamingLayoutConfig**](DailyStreamingLayoutConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RecordingStreamingOptions.new(
+  width: null,
+  height: null,
+  fps: null,
+  video_bitrate: null,
+  audio_bitrate: null,
+  min_idle_time_out: null,
+  max_duration: null,
+  background_color: null,
+  instance_id: null,
+  type: null,
+  layout: null
+)
+```
+