daily-ruby 1.0.3 → 1.0.5

data/docs/DailyLiveStreamingOptions.md

@@ -1,40 +0,0 @@
-# Daily::DailyLiveStreamingOptions
-
-## 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] |
-| **layout** | [**DailyStreamingLayoutConfig**](DailyStreamingLayoutConfig.md) |  | [optional] |
-| **rtmp_url** | [**DailyLiveStreamingOptionsRtmpUrl**](DailyLiveStreamingOptionsRtmpUrl.md) |  | [optional] |
-| **endpoints** | [**Array<DailyStreamingEndpoint>**](DailyStreamingEndpoint.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyLiveStreamingOptions.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,
-  layout: null,
-  rtmp_url: null,
-  endpoints: null
-)
-```
-

data/docs/DailyLiveStreamingOptionsRtmpUrl.md

@@ -1,49 +0,0 @@
-# Daily::DailyLiveStreamingOptionsRtmpUrl
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'daily-ruby'
-
-Daily::DailyLiveStreamingOptionsRtmpUrl.openapi_one_of
-# =>
-# [
-#   :'Array<String>',
-#   :'String'
-# ]
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'daily-ruby'
-
-Daily::DailyLiveStreamingOptionsRtmpUrl.build(data)
-# => #<Array<String>:0x00007fdd4aab02a0>
-
-Daily::DailyLiveStreamingOptionsRtmpUrl.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>`
-- `String`
-- `nil` (if no type matches)
-

data/docs/DailyStreamingActiveParticipantLayoutConfig.md

@@ -1,18 +0,0 @@
-# Daily::DailyStreamingActiveParticipantLayoutConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **preset** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingActiveParticipantLayoutConfig.new(
-  preset: null
-)
-```
-

data/docs/DailyStreamingCustomLayoutConfig.md

@@ -1,24 +0,0 @@
-# Daily::DailyStreamingCustomLayoutConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **preset** | **String** |  |  |
-| **composition_id** | **String** |  |  |
-| **composition_params** | [**Hash<String, DailyStreamingCustomLayoutConfigCompositionParamsValue>**](DailyStreamingCustomLayoutConfigCompositionParamsValue.md) |  | [optional] |
-| **session_assets** | **Hash<String, String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingCustomLayoutConfig.new(
-  preset: null,
-  composition_id: null,
-  composition_params: null,
-  session_assets: null
-)
-```
-

data/docs/DailyStreamingCustomLayoutConfigCompositionParams.md

@@ -1,15 +0,0 @@
-# Daily::DailyStreamingCustomLayoutConfigCompositionParams
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingCustomLayoutConfigCompositionParams.new()
-```
-

data/docs/DailyStreamingCustomLayoutConfigCompositionParamsValue.md

@@ -1,15 +0,0 @@
-# Daily::DailyStreamingCustomLayoutConfigCompositionParamsValue
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingCustomLayoutConfigCompositionParamsValue.new()
-```
-

data/docs/DailyStreamingDefaultLayoutConfig.md

@@ -1,20 +0,0 @@
-# Daily::DailyStreamingDefaultLayoutConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **preset** | **String** |  |  |
-| **max_cam_streams** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingDefaultLayoutConfig.new(
-  preset: null,
-  max_cam_streams: null
-)
-```
-

data/docs/DailyStreamingEndpoint.md

@@ -1,18 +0,0 @@
-# Daily::DailyStreamingEndpoint
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **endpoint** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingEndpoint.new(
-  endpoint: null
-)
-```
-

data/docs/DailyStreamingLayoutConfig.md

@@ -1,69 +0,0 @@
-# Daily::DailyStreamingLayoutConfig
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'daily-ruby'
-
-Daily::DailyStreamingLayoutConfig.openapi_one_of
-# =>
-# [
-#   :'DailyStreamingActiveParticipantLayoutConfig',
-#   :'DailyStreamingCustomLayoutConfig',
-#   :'DailyStreamingDefaultLayoutConfig',
-#   :'DailyStreamingPortraitLayoutConfig',
-#   :'DailyStreamingSingleParticipantLayoutConfig'
-# ]
-```
-
-### `openapi_discriminator_name`
-
-Returns the discriminator's property name.
-
-#### Example
-
-```ruby
-require 'daily-ruby'
-
-Daily::DailyStreamingLayoutConfig.openapi_discriminator_name
-# => :'preset'
-```
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'daily-ruby'
-
-Daily::DailyStreamingLayoutConfig.build(data)
-# => #<DailyStreamingActiveParticipantLayoutConfig:0x00007fdd4aab02a0>
-
-Daily::DailyStreamingLayoutConfig.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `DailyStreamingActiveParticipantLayoutConfig`
-- `DailyStreamingCustomLayoutConfig`
-- `DailyStreamingDefaultLayoutConfig`
-- `DailyStreamingPortraitLayoutConfig`
-- `DailyStreamingSingleParticipantLayoutConfig`
-- `nil` (if no type matches)
-

data/docs/DailyStreamingOptions.md

@@ -1,36 +0,0 @@
-# Daily::DailyStreamingOptions
-
-## 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] |
-| **layout** | [**DailyStreamingLayoutConfig**](DailyStreamingLayoutConfig.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingOptions.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,
-  layout: null
-)
-```
-

data/docs/DailyStreamingPortraitLayoutConfig.md

@@ -1,22 +0,0 @@
-# Daily::DailyStreamingPortraitLayoutConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **preset** | **String** |  |  |
-| **variant** | [**DailyStreamingPortraitLayoutVariant**](DailyStreamingPortraitLayoutVariant.md) |  | [optional] |
-| **max_cam_streams** | **Float** |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingPortraitLayoutConfig.new(
-  preset: null,
-  variant: null,
-  max_cam_streams: null
-)
-```
-

data/docs/DailyStreamingPortraitLayoutVariant.md

@@ -1,15 +0,0 @@
-# Daily::DailyStreamingPortraitLayoutVariant
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingPortraitLayoutVariant.new()
-```
-

data/docs/DailyStreamingSingleParticipantLayoutConfig.md

@@ -1,20 +0,0 @@
-# Daily::DailyStreamingSingleParticipantLayoutConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **preset** | **String** |  |  |
-| **session_id** | **String** |  |  |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DailyStreamingSingleParticipantLayoutConfig.new(
-  preset: null,
-  session_id: null
-)
-```
-

data/docs/DeleteTranscript200Response.md

@@ -1,30 +0,0 @@
-# Daily::DeleteTranscript200Response
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **transcript_id** | **String** | A unique, opaque ID for this object. You can use this ID in API calls, and in paginated list operations. | [optional] |
-| **domain_id** | **String** | The ID of the domain [domain](https://docs.daily.co/reference/rest-api/your-domain). | [optional] |
-| **room_id** | **String** | The ID of the room [room](https://docs.daily.co/reference/rest-api/rooms). | [optional] |
-| **mtg_session_id** | **String** | The meeting session ID for this transcription.[mtgSessionId](https://docs.daily.co/reference/rest-api/logs/config#mtgSessionId). | [optional] |
-| **status** | **String** |  | [optional] |
-| **duration** | **Integer** | Transcription length in seconds | [optional] |
-| **out_params** | [**GetTranscriptInfo200ResponseOutParams**](GetTranscriptInfo200ResponseOutParams.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DeleteTranscript200Response.new(
-  transcript_id: 0cb313e1-211f-4be0-833d-8c7305b19902,
-  domain_id: null,
-  room_id: 1a5afbf4-211f-4be0-833d-8c7305b19902,
-  mtg_session_id: 257764e6-c74e-4c30-944a-a887a03173a3,
-  status: t_finished,
-  duration: 277,
-  out_params: null
-)
-```
-

data/docs/DialinApi.md

@@ -1,80 +0,0 @@
-# Daily::DialinApi
-
-All URIs are relative to *https://api.daily.co/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**pinless_call_update**](DialinApi.md#pinless_call_update) | **POST** /dialin/pinlessCallUpdate | /dialin/pinlessCallUpdate |
-
-
-## pinless_call_update
-
-> pinless_call_update(opts)
-
-/dialin/pinlessCallUpdate
-
-Direct a SIP or PSTN call on hold to a specified SIP URI associated to a Daily Room.
-
-### 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::DialinApi.new
-opts = {
-  pinless_call_update_request: Daily::PinlessCallUpdateRequest.new # PinlessCallUpdateRequest | 
-}
-
-begin
-  # /dialin/pinlessCallUpdate
-  api_instance.pinless_call_update(opts)
-rescue Daily::ApiError => e
-  puts "Error when calling DialinApi->pinless_call_update: #{e}"
-end
-```
-
-#### Using the pinless_call_update_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)> pinless_call_update_with_http_info(opts)
-
-```ruby
-begin
-  # /dialin/pinlessCallUpdate
-  data, status_code, headers = api_instance.pinless_call_update_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Daily::ApiError => e
-  puts "Error when calling DialinApi->pinless_call_update_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **pinless_call_update_request** | [**PinlessCallUpdateRequest**](PinlessCallUpdateRequest.md) |  | [optional] |
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[sec0](../README.md#sec0)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-

data/docs/DialoutProperties.md

@@ -1,26 +0,0 @@
-# Daily::DialoutProperties
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **sip_uri** | **String** | sipUri to call. uri should start with `sip:`.  | [optional] |
-| **phone_number** | **String** | phone number to call. number must start with country code e.g `+1` | [optional] |
-| **display_name** | **String** | The sipUri or The phone participant is shown with this name in the web UI. | [optional] |
-| **video** | **Boolean** | Enable SIP video in the room, only availble for sipUri. | [optional] |
-| **codecs** | [**DialoutPropertiesCodecs**](DialoutPropertiesCodecs.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DialoutProperties.new(
-  sip_uri: null,
-  phone_number: null,
-  display_name: null,
-  video: null,
-  codecs: null
-)
-```
-

data/docs/DialoutPropertiesCodecs.md

@@ -1,20 +0,0 @@
-# Daily::DialoutPropertiesCodecs
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **audio** | **Array<String>** |  | [optional] |
-| **video** | **Array<String>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::DialoutPropertiesCodecs.new(
-  audio: null,
-  video: null
-)
-```
-

data/docs/Domain.md

@@ -1,18 +0,0 @@
-# Daily::Domain
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **properties** | [**DomainProperties**](DomainProperties.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::Domain.new(
-  properties: null
-)
-```
-