daily-ruby 0.0.2 → 1.0.0

data/docs/CreateMeetingTokenRequest.md

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

data/docs/CreateRoom200Response.md

@@ -0,0 +1,30 @@
+# Daily::CreateRoom200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **api_created** | **Boolean** |  | [optional][default to true] |
+| **privacy** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **created_at** | **String** |  | [optional] |
+| **config** | [**ListRooms200ResponseDataInnerConfig**](ListRooms200ResponseDataInnerConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::CreateRoom200Response.new(
+  id: d61cd7b2-a273-42b4-89bd-be763fd562c1,
+  name: w2pp2cf4kltgFACPKXmX,
+  api_created: true,
+  privacy: public,
+  url: https://api-demo.daily.co/w2pp2cf4kltgFACPKXmX,
+  created_at: 2019-01-26T09:01:22.000Z,
+  config: null
+)
+```
+

data/docs/{RoomRequest.md → CreateRoomRequest.md}

@@ -1,4 +1,4 @@
-# Daily::RoomRequest
+# Daily::CreateRoomRequest
 
 ## Properties
 
@@ -6,14 +6,14 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** |  | [optional] |
 | **privacy** | **String** |  | [optional] |
-| **properties** | [**RoomRequestProperties**](RoomRequestProperties.md) |  | [optional] |
+| **properties** | [**RoomProperties**](RoomProperties.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'daily-ruby'
 
-instance = Daily::RoomRequest.new(
+instance = Daily::CreateRoomRequest.new(
   name: null,
   privacy: null,
   properties: null

data/docs/DailyLiveStreamingOptions.md

@@ -0,0 +1,40 @@
+# 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

@@ -0,0 +1,49 @@
+# 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

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

data/docs/DailyStreamingCustomLayoutConfig.md

@@ -0,0 +1,24 @@
+# Daily::DailyStreamingCustomLayoutConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **preset** | **String** |  |  |
+| **composition_id** | **String** |  |  |
+| **composition_params** | [**Hash<String, DailyStreamingCustomLayoutConfigCompositionParams>**](DailyStreamingCustomLayoutConfigCompositionParams.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

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

data/docs/DailyStreamingDefaultLayoutConfig.md

@@ -0,0 +1,20 @@
+# 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

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

data/docs/DailyStreamingLayoutConfig.md

@@ -0,0 +1,69 @@
+# 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

@@ -0,0 +1,36 @@
+# 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

@@ -0,0 +1,22 @@
+# 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

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

data/docs/DailyStreamingSingleParticipantLayoutConfig.md

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,30 @@
+# 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/Domain.md

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

data/docs/DomainApi.md

@@ -0,0 +1,149 @@
+# Daily::DomainApi
+
+All URIs are relative to *https://api.daily.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_domain_config**](DomainApi.md#get_domain_config) | **GET** / | Get domain configuration |
+| [**set_domain_config**](DomainApi.md#set_domain_config) | **POST** / | Set domain configuration |
+
+
+## get_domain_config
+
+> <GetDomainConfig200Response> get_domain_config
+
+Get domain configuration
+
+Get top-level configuration of your 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::DomainApi.new
+
+begin
+  # Get domain configuration
+  result = api_instance.get_domain_config
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling DomainApi->get_domain_config: #{e}"
+end
+```
+
+#### Using the get_domain_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetDomainConfig200Response>, Integer, Hash)> get_domain_config_with_http_info
+
+```ruby
+begin
+  # Get domain configuration
+  data, status_code, headers = api_instance.get_domain_config_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetDomainConfig200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling DomainApi->get_domain_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetDomainConfig200Response**](GetDomainConfig200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_domain_config
+
+> set_domain_config(opts)
+
+Set domain configuration
+
+Set top-level configuration options for your 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::DomainApi.new
+opts = {
+  domain: Daily::Domain.new # Domain | 
+}
+
+begin
+  # Set domain configuration
+  api_instance.set_domain_config(opts)
+rescue Daily::ApiError => e
+  puts "Error when calling DomainApi->set_domain_config: #{e}"
+end
+```
+
+#### Using the set_domain_config_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)> set_domain_config_with_http_info(opts)
+
+```ruby
+begin
+  # Set domain configuration
+  data, status_code, headers = api_instance.set_domain_config_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Daily::ApiError => e
+  puts "Error when calling DomainApi->set_domain_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | [**Domain**](Domain.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+