daily-ruby 0.0.2 → 1.0.1

data/docs/PhoneNumbersApi.md

@@ -0,0 +1,304 @@
+# Daily::PhoneNumbersApi
+
+All URIs are relative to *https://api.daily.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**buy_phone_number**](PhoneNumbersApi.md#buy_phone_number) | **POST** /buy-phone-number | /buy-phone-number |
+| [**list_available_numbers**](PhoneNumbersApi.md#list_available_numbers) | **GET** /list-available-numbers | /list-available-numbers |
+| [**purchased_phone_nunbers**](PhoneNumbersApi.md#purchased_phone_nunbers) | **GET** /purchased-phone-numbers | /purchased-phone-numbers |
+| [**release_phone_number**](PhoneNumbersApi.md#release_phone_number) | **DELETE** /release-phone-number/{id} | release-phone-number/:id |
+
+
+## buy_phone_number
+
+> Object buy_phone_number(opts)
+
+/buy-phone-number
+
+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.
+
+### 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::PhoneNumbersApi.new
+opts = {
+  buy_phone_number_request: Daily::BuyPhoneNumberRequest.new # BuyPhoneNumberRequest | 
+}
+
+begin
+  # /buy-phone-number
+  result = api_instance.buy_phone_number(opts)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->buy_phone_number: #{e}"
+end
+```
+
+#### Using the buy_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> buy_phone_number_with_http_info(opts)
+
+```ruby
+begin
+  # /buy-phone-number
+  data, status_code, headers = api_instance.buy_phone_number_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->buy_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buy_phone_number_request** | [**BuyPhoneNumberRequest**](BuyPhoneNumberRequest.md) |  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_available_numbers
+
+> list_available_numbers(opts)
+
+/list-available-numbers
+
+Search for available phone numbers to purchase
+
+### 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::PhoneNumbersApi.new
+opts = {
+  areacode: 'areacode_example', # String | An areacode to search within.
+  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.
+  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.
+  contains: 'contains_example', # String | A string of 3 to 7 digits that should appear somewhere in the number.
+  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.
+  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.
+}
+
+begin
+  # /list-available-numbers
+  api_instance.list_available_numbers(opts)
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->list_available_numbers: #{e}"
+end
+```
+
+#### Using the list_available_numbers_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> list_available_numbers_with_http_info(opts)
+
+```ruby
+begin
+  # /list-available-numbers
+  data, status_code, headers = api_instance.list_available_numbers_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->list_available_numbers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **areacode** | **String** | An areacode to search within. | [optional] |
+| **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] |
+| **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] |
+| **contains** | **String** | A string of 3 to 7 digits that should appear somewhere in the number. | [optional] |
+| **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] |
+| **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] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## purchased_phone_nunbers
+
+> purchased_phone_nunbers
+
+/purchased-phone-numbers
+
+List the purchased phone numbers for this domain
+
+### 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::PhoneNumbersApi.new
+
+begin
+  # /purchased-phone-numbers
+  api_instance.purchased_phone_nunbers
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->purchased_phone_nunbers: #{e}"
+end
+```
+
+#### Using the purchased_phone_nunbers_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> purchased_phone_nunbers_with_http_info
+
+```ruby
+begin
+  # /purchased-phone-numbers
+  data, status_code, headers = api_instance.purchased_phone_nunbers_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->purchased_phone_nunbers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## release_phone_number
+
+> Object release_phone_number(id)
+
+release-phone-number/:id
+
+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.
+
+### 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::PhoneNumbersApi.new
+id = 'id_example' # String | 
+
+begin
+  # release-phone-number/:id
+  result = api_instance.release_phone_number(id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->release_phone_number: #{e}"
+end
+```
+
+#### Using the release_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> release_phone_number_with_http_info(id)
+
+```ruby
+begin
+  # release-phone-number/:id
+  data, status_code, headers = api_instance.release_phone_number_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Daily::ApiError => e
+  puts "Error when calling PhoneNumbersApi->release_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PinDialinInner.md

@@ -0,0 +1,22 @@
+# Daily::PinDialinInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Associate a purchased phone number to the dialin with PIN workflow.   | [optional] |
+| **name_prefix** | **String** | An identifier or name to associate to the workflow. | [optional] |
+| **ivr_greeting** | [**PinDialinInnerIvrGreeting**](PinDialinInnerIvrGreeting.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::PinDialinInner.new(
+  phone_number: null,
+  name_prefix: null,
+  ivr_greeting: null
+)
+```
+

data/docs/PinDialinInnerIvrGreeting.md

@@ -0,0 +1,18 @@
+# Daily::PinDialinInnerIvrGreeting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | message to \"Say\" when user call the phone_number. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::PinDialinInnerIvrGreeting.new(
+  message: null
+)
+```
+

data/docs/PinlessCallUpdateRequest.md

@@ -0,0 +1,22 @@
+# Daily::PinlessCallUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **call_id** | **String** | CallId is represented by UUID and represents the sessionId in the SIP Network. | [optional] |
+| **call_domain** | **String** | Call Domain is represented by UUID and represents your Daily Domain on the SIP Network. | [optional] |
+| **sip_uri** | **String** | This SIP URI is associated to the Daily Room that you want to forward the SIP Interconnect call to. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::PinlessCallUpdateRequest.new(
+  call_id: null,
+  call_domain: null,
+  sip_uri: null
+)
+```
+

data/docs/PinlessDialinInner.md

@@ -0,0 +1,24 @@
+# Daily::PinlessDialinInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Associate a purchased phone number to the Pinless dialin workflow. | [optional] |
+| **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] |
+| **name_prefix** | **String** | An identifier or name to associate to the workflow. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::PinlessDialinInner.new(
+  phone_number: null,
+  room_creation_api: null,
+  name_prefix: null,
+  sip_uri: null
+)
+```
+

data/docs/PostWebhook.md

@@ -0,0 +1,26 @@
+# 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] |
+| **retry_type** | **String** | The retry configuration for this webhook endpoint to use. The default is circuit-breaker. | [optional] |
+| **event_types** | **Array<String>** | The set of event types this webhook is subscribed to. | [optional] |
+| **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] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::PostWebhook.new(
+  url: null,
+  basic_auth: null,
+  retry_type: null,
+  event_types: null,
+  hmac: 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,62 @@
+# 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. 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] |
+| **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_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] |
+| **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_live_captions_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** | **Float** | 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** | **Float** | 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
+)
+```
+