daily-ruby 0.0.2 → 1.0.1

data/docs/TranscriptionProperties.md

@@ -0,0 +1,34 @@
+# Daily::TranscriptionProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | See Deepgram's documentation for [`language`](https://developers.deepgram.com/docs/language) | [optional] |
+| **model** | **String** | See Deepgram's documentation for [`model`](https://developers.deepgram.com/docs/model) | [optional] |
+| **tier** | **String** | See Deepgram's documentation for [`tier`](https://developers.deepgram.com/docs/tier) | [optional] |
+| **profanity_filter** | **Boolean** | See Deepgram's documentation for [`profanity filter`](https://developers.deepgram.com/docs/profanity-filter) | [optional] |
+| **punctuate** | **Boolean** | See Deepgram's documentation for [`punctuate`](https://developers.deepgram.com/docs/punctuation) | [optional] |
+| **endpointing** | [**TranscriptionPropertiesEndpointing**](TranscriptionPropertiesEndpointing.md) |  | [optional] |
+| **redact** | [**TranscriptionPropertiesRedact**](TranscriptionPropertiesRedact.md) |  | [optional] |
+| **extra** | **Object** | Specify any Deepgram parameters. See Deepgram's documentation for [available streaming options](https://developers.deepgram.com/docs/features-overview) | [optional] |
+| **include_raw_response** | **Boolean** | Whether Deepgram's raw response should be included in all transcription messages | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::TranscriptionProperties.new(
+  language: null,
+  model: null,
+  tier: null,
+  profanity_filter: null,
+  punctuate: null,
+  endpointing: null,
+  redact: null,
+  extra: null,
+  include_raw_response: null
+)
+```
+

data/docs/TranscriptionPropertiesEndpointing.md

@@ -0,0 +1,49 @@
+# Daily::TranscriptionPropertiesEndpointing
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'daily-ruby'
+
+Daily::TranscriptionPropertiesEndpointing.openapi_one_of
+# =>
+# [
+#   :'Boolean',
+#   :'Float'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'daily-ruby'
+
+Daily::TranscriptionPropertiesEndpointing.build(data)
+# => #<Boolean:0x00007fdd4aab02a0>
+
+Daily::TranscriptionPropertiesEndpointing.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Boolean`
+- `Float`
+- `nil` (if no type matches)
+

data/docs/TranscriptionPropertiesRedact.md

@@ -0,0 +1,51 @@
+# Daily::TranscriptionPropertiesRedact
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'daily-ruby'
+
+Daily::TranscriptionPropertiesRedact.openapi_one_of
+# =>
+# [
+#   :'Array<Boolean>',
+#   :'Array<String>',
+#   :'Boolean'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'daily-ruby'
+
+Daily::TranscriptionPropertiesRedact.build(data)
+# => #<Array<Boolean>:0x00007fdd4aab02a0>
+
+Daily::TranscriptionPropertiesRedact.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<Boolean>`
+- `Array<String>`
+- `Boolean`
+- `nil` (if no type matches)
+

data/docs/UpdatePermissionsRequest.md

@@ -0,0 +1,18 @@
+# Daily::UpdatePermissionsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Hash<String, UpdatePermissionsRequestDataValue>**](UpdatePermissionsRequestDataValue.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::UpdatePermissionsRequest.new(
+  data: null
+)
+```
+

data/docs/UpdatePermissionsRequestDataValue.md

@@ -0,0 +1,22 @@
+# Daily::UpdatePermissionsRequestDataValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_presence** | **Boolean** |  | [optional] |
+| **can_send** | [**UpdatePermissionsRequestDataValueCanSend**](UpdatePermissionsRequestDataValueCanSend.md) |  | [optional] |
+| **can_admin** | [**UpdatePermissionsRequestDataValueCanSend**](UpdatePermissionsRequestDataValueCanSend.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::UpdatePermissionsRequestDataValue.new(
+  has_presence: null,
+  can_send: null,
+  can_admin: null
+)
+```
+

data/docs/UpdatePermissionsRequestDataValueCanSend.md

@@ -0,0 +1,49 @@
+# Daily::UpdatePermissionsRequestDataValueCanSend
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'daily-ruby'
+
+Daily::UpdatePermissionsRequestDataValueCanSend.openapi_one_of
+# =>
+# [
+#   :'Array<String>',
+#   :'Boolean'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'daily-ruby'
+
+Daily::UpdatePermissionsRequestDataValueCanSend.build(data)
+# => #<Array<String>:0x00007fdd4aab02a0>
+
+Daily::UpdatePermissionsRequestDataValueCanSend.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<String>`
+- `Boolean`
+- `nil` (if no type matches)
+

data/docs/UpdateWebhook.md

@@ -0,0 +1,26 @@
+# Daily::UpdateWebhook
+
+## 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. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::UpdateWebhook.new(
+  url: null,
+  basic_auth: null,
+  retry_type: null,
+  event_types: null,
+  hmac: null
+)
+```
+

data/docs/ValidateMeetingToken200Response.md

@@ -0,0 +1,28 @@
+# Daily::ValidateMeetingToken200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **room_name** | **String** |  | [optional] |
+| **is_owner** | **Boolean** |  | [optional][default to true] |
+| **user_name** | **String** |  | [optional] |
+| **start_video_off** | **Boolean** |  | [optional][default to true] |
+| **start_audio_off** | **Boolean** |  | [optional][default to true] |
+| **lang** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::ValidateMeetingToken200Response.new(
+  room_name: EevVrrxee4JBxKzmKkjC,
+  is_owner: true,
+  user_name: host,
+  start_video_off: false,
+  start_audio_off: true,
+  lang: en
+)
+```
+

data/docs/WaitingParticipantJoined.md

@@ -0,0 +1,24 @@
+# Daily::WaitingParticipantJoined
+
+## 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** | [**WaitingParticipantJoinedPayload**](WaitingParticipantJoinedPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::WaitingParticipantJoined.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/WaitingParticipantJoinedPayload.md

@@ -0,0 +1,32 @@
+# Daily::WaitingParticipantJoinedPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **joined_at** | **Float** | The Unix epoch time in seconds representing when the waiting participant joined. | [optional] |
+| **session_id** | **String** | The user session ID, or participant id. | [optional] |
+| **room** | **String** | The name of the room. | [optional] |
+| **user_id** | **String** | The ID of the user, set by the meeting token. | [optional] |
+| **user_name** | **String** | The name of the user, set by the meeting token. | [optional] |
+| **owner** | **Boolean** | A flag determining if this user is considered the owner. | [optional] |
+| **will_eject_at** | **Integer** | The Unix epoch time in seconds representing when the participant will be ejected. | [optional] |
+| **permissions** | [**ParticipantJoinedPayloadPermissions**](ParticipantJoinedPayloadPermissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::WaitingParticipantJoinedPayload.new(
+  joined_at: null,
+  session_id: null,
+  room: null,
+  user_id: null,
+  user_name: null,
+  owner: null,
+  will_eject_at: null,
+  permissions: null
+)
+```
+

data/docs/WaitingParticipantLeft.md

@@ -0,0 +1,24 @@
+# Daily::WaitingParticipantLeft
+
+## 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** | [**WaitingParticipantLeftPayload**](WaitingParticipantLeftPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::WaitingParticipantLeft.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/WaitingParticipantLeftPayload.md

@@ -0,0 +1,34 @@
+# Daily::WaitingParticipantLeftPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **joined_at** | **Float** | The Unix epoch time in seconds representing when the waiting participant joined. | [optional] |
+| **duration** | **Float** | The time in seconds representing how long the participant was in the call. | [optional] |
+| **session_id** | **String** | The user session ID, or participant id. | [optional] |
+| **room** | **String** | The name of the room. | [optional] |
+| **user_id** | **String** | The ID of the user, set by the meeting token. | [optional] |
+| **user_name** | **String** | The name of the user, set by the meeting token. | [optional] |
+| **owner** | **Boolean** | A flag determining if this user is considered the owner. | [optional] |
+| **will_eject_at** | **Integer** | The Unix epoch time in seconds representing when the participant will be ejected. | [optional] |
+| **permissions** | [**ParticipantJoinedPayloadPermissions**](ParticipantJoinedPayloadPermissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::WaitingParticipantLeftPayload.new(
+  joined_at: null,
+  duration: null,
+  session_id: null,
+  room: null,
+  user_id: null,
+  user_name: null,
+  owner: null,
+  will_eject_at: null,
+  permissions: null
+)
+```
+

data/docs/Webhook.md

@@ -0,0 +1,40 @@
+# Daily::Webhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uuid** | **String** | The unique identifier for this webhook. | [optional] |
+| **url** | **String** | The webhook server endpoint that was provided. | [optional] |
+| **hmac** | **String** | A secret that can be used to verify the signature of the webhook. | [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] |
+| **state** | **String** | The current state of the webhook. \"FAILED\" | \"INACTIVE\" | [optional] |
+| **failed_count** | **Float** | The number of consecutive failures this webhook has made. | [optional] |
+| **last_moment_pushed** | **String** | The ISO 8601 time of the last moment an event was pushed to the webhook server. | [optional] |
+| **domain_id** | **String** | The domain ID this webhook is associated with. | [optional] |
+| **created_at** | **String** | The ISO 8601 time of when this webhook was created. | [optional] |
+| **updated_at** | **String** | The ISO 8601 time of when this webhook was last updated. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::Webhook.new(
+  uuid: null,
+  url: null,
+  hmac: null,
+  basic_auth: null,
+  retry_type: null,
+  event_types: null,
+  state: null,
+  failed_count: null,
+  last_moment_pushed: null,
+  domain_id: null,
+  created_at: null,
+  updated_at: null
+)
+```
+