daily-ruby 0.0.0 → 1.0.0

data/docs/RoomsRoomNameGetRes.md

@@ -0,0 +1,30 @@
+# Daily::RoomsRoomNameGetRes
+
+## 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::RoomsRoomNameGetRes.new(
+  id: d61cd7b2-a273-42b4-89bd-be763fd562c1,
+  name: w2pp2cf4kltgFACPKXmX,
+  api_created: false,
+  privacy: public,
+  url: https://api-demo.daily.co/w2pp2cf4kltgFACPKXmX,
+  created_at: 2019-01-26T09:01:22.000Z,
+  config: null
+)
+```
+

data/docs/RoomsRoomNamePresenceGetRes.md

@@ -0,0 +1,20 @@
+# Daily::RoomsRoomNamePresenceGetRes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_count** | **Integer** |  | [optional] |
+| **data** | [**Array<RoomsRoomNamePresenceGetResDataInner>**](RoomsRoomNamePresenceGetResDataInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RoomsRoomNamePresenceGetRes.new(
+  total_count: 192,
+  data: null
+)
+```
+

data/docs/RoomsRoomNamePresenceGetResDataInner.md

@@ -0,0 +1,28 @@
+# Daily::RoomsRoomNamePresenceGetResDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **room** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **user_name** | **String** |  | [optional] |
+| **join_time** | **String** |  | [optional] |
+| **duration** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::RoomsRoomNamePresenceGetResDataInner.new(
+  id: d61cd7b2-a273-42b4-89bd-be763fd562c1,
+  room: w2pp2cf4kltgFACPKXmX,
+  user_id: pbZ+ismP7dk=,
+  user_name: Moishe,
+  join_time: 2023-01-01T20:53:19.000Z,
+  duration: 2312
+)
+```
+

data/docs/SendAppMessageRequest.md

@@ -0,0 +1,20 @@
+# Daily::SendAppMessageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Object** | A javascript object that can be serialized into JSON. Data sent must be within the 4kb size limit. | [optional] |
+| **recipient** | **String** | Determines who will recieve the message. It can be either a participant session_id, or `*`. The `*` value is the default, and means that the message is a \"broadcast\" message intended for all participants. | [optional][default to '*'] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::SendAppMessageRequest.new(
+  data: null,
+  recipient: null
+)
+```
+

data/docs/SetRoomConfigRequest.md

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

data/docs/SetSessionDataRequest.md

@@ -0,0 +1,22 @@
+# Daily::SetSessionDataRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Object** | A javascript object that can be serialized into JSON. Defaults to `{}`. | [optional] |
+| **merge_strategy** | **String** | `replace` to replace the existing meeting session data object or `shallow-merge` to merge with it. | [optional][default to 'replace'] |
+| **keys_to_delete** | **Array<String>** | Optional list of keys to delete from the existing meeting session data object when using `shallow-merge`. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::SetSessionDataRequest.new(
+  data: null,
+  merge_strategy: null,
+  keys_to_delete: null
+)
+```
+

data/docs/StreamingEnded.md

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

data/docs/StreamingEndedPayload.md

@@ -0,0 +1,22 @@
+# Daily::StreamingEndedPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** | The Unix epoch time in seconds representing when streaming was ended. | [optional] |
+| **instance_id** | **String** | The streaming instance ID. | [optional] |
+| **domain_id** | **String** | ID of the domain for which streaming was ended. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::StreamingEndedPayload.new(
+  timestamp: null,
+  instance_id: null,
+  domain_id: null
+)
+```
+

data/docs/StreamingError.md

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

data/docs/StreamingErrorPayload.md

@@ -0,0 +1,26 @@
+# Daily::StreamingErrorPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** | The Unix epoch time in seconds representing when streaming error occurred. | [optional] |
+| **instance_id** | **String** | The streaming instance ID. | [optional] |
+| **error_message** | **String** | The error message returned. | [optional] |
+| **room_name** | **String** | The name of the room where streaming error occurred. | [optional] |
+| **domain_id** | **String** | ID of the domain for which streaming error occurred. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::StreamingErrorPayload.new(
+  timestamp: null,
+  instance_id: null,
+  error_message: null,
+  room_name: null,
+  domain_id: null
+)
+```
+

data/docs/StreamingStarted.md

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

data/docs/StreamingStartedPayload.md

@@ -0,0 +1,24 @@
+# Daily::StreamingStartedPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** | The Unix epoch time in seconds representing when streaming was started. | [optional] |
+| **instance_id** | **String** | The streaming instance ID. | [optional] |
+| **domain_id** | **String** | ID of the domain for which streaming was started. | [optional] |
+| **layout** | [**DailyStreamingLayoutConfig**](.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::StreamingStartedPayload.new(
+  timestamp: null,
+  instance_id: null,
+  domain_id: null,
+  layout: null
+)
+```
+

data/docs/StreamingUpdated.md

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

data/docs/StreamingUpdatedPayload.md

@@ -0,0 +1,24 @@
+# Daily::StreamingUpdatedPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | **Integer** | The Unix epoch time in seconds representing when streaming was updated. | [optional] |
+| **instance_id** | **String** | The streaming instance ID. | [optional] |
+| **domain_id** | **String** | ID of the domain for which streaming was updated. | [optional] |
+| **layout** | [**DailyStreamingLayoutConfig**](.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::StreamingUpdatedPayload.new(
+  timestamp: null,
+  instance_id: null,
+  domain_id: null,
+  layout: null
+)
+```
+

data/docs/TranscriptApi.md

@@ -0,0 +1,305 @@
+# Daily::TranscriptApi
+
+All URIs are relative to *https://api.daily.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_transcript**](TranscriptApi.md#delete_transcript) | **DELETE** /transcript/{transcriptId} | transcript/:id |
+| [**get_transcript_info**](TranscriptApi.md#get_transcript_info) | **GET** /transcript/{transcriptId} | transcript/:transcriptId |
+| [**get_transcript_link**](TranscriptApi.md#get_transcript_link) | **GET** /transcript/{transcriptId}/access-link | transcript/:id/access-link |
+| [**list_transcript**](TranscriptApi.md#list_transcript) | **GET** /transcript | /transcript |
+
+
+## delete_transcript
+
+> <DeleteTranscript200Response> delete_transcript(transcript_id)
+
+transcript/:id
+
+Delete a transcript
+
+### 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::TranscriptApi.new
+transcript_id = 'transcript_id_example' # String | 
+
+begin
+  # transcript/:id
+  result = api_instance.delete_transcript(transcript_id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->delete_transcript: #{e}"
+end
+```
+
+#### Using the delete_transcript_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeleteTranscript200Response>, Integer, Hash)> delete_transcript_with_http_info(transcript_id)
+
+```ruby
+begin
+  # transcript/:id
+  data, status_code, headers = api_instance.delete_transcript_with_http_info(transcript_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeleteTranscript200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->delete_transcript_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transcript_id** | **String** |  |  |
+
+### Return type
+
+[**DeleteTranscript200Response**](DeleteTranscript200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_transcript_info
+
+> <GetTranscriptInfo200Response> get_transcript_info(transcript_id)
+
+transcript/:transcriptId
+
+Get info about a Transcript
+
+### 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::TranscriptApi.new
+transcript_id = 'transcript_id_example' # String | 
+
+begin
+  # transcript/:transcriptId
+  result = api_instance.get_transcript_info(transcript_id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->get_transcript_info: #{e}"
+end
+```
+
+#### Using the get_transcript_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTranscriptInfo200Response>, Integer, Hash)> get_transcript_info_with_http_info(transcript_id)
+
+```ruby
+begin
+  # transcript/:transcriptId
+  data, status_code, headers = api_instance.get_transcript_info_with_http_info(transcript_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTranscriptInfo200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->get_transcript_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transcript_id** | **String** |  |  |
+
+### Return type
+
+[**GetTranscriptInfo200Response**](GetTranscriptInfo200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_transcript_link
+
+> <GetTranscriptLink200Response> get_transcript_link(transcript_id)
+
+transcript/:id/access-link
+
+Generate an access link for a transcript
+
+### 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::TranscriptApi.new
+transcript_id = 'transcript_id_example' # String | 
+
+begin
+  # transcript/:id/access-link
+  result = api_instance.get_transcript_link(transcript_id)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->get_transcript_link: #{e}"
+end
+```
+
+#### Using the get_transcript_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetTranscriptLink200Response>, Integer, Hash)> get_transcript_link_with_http_info(transcript_id)
+
+```ruby
+begin
+  # transcript/:id/access-link
+  data, status_code, headers = api_instance.get_transcript_link_with_http_info(transcript_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetTranscriptLink200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->get_transcript_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transcript_id** | **String** |  |  |
+
+### Return type
+
+[**GetTranscriptLink200Response**](GetTranscriptLink200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_transcript
+
+> <ListTranscript200Response> list_transcript(opts)
+
+/transcript
+
+List transcripts
+
+### 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::TranscriptApi.new
+opts = {
+  limit: 56, # Integer | 
+  ending_before: 'ending_before_example', # String | 
+  starting_after: 'starting_after_example', # String | 
+  room_id: 'room_id_example', # String | 
+  mtg_session_id: 'mtg_session_id_example' # String | 
+}
+
+begin
+  # /transcript
+  result = api_instance.list_transcript(opts)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->list_transcript: #{e}"
+end
+```
+
+#### Using the list_transcript_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTranscript200Response>, Integer, Hash)> list_transcript_with_http_info(opts)
+
+```ruby
+begin
+  # /transcript
+  data, status_code, headers = api_instance.list_transcript_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTranscript200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling TranscriptApi->list_transcript_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **ending_before** | **String** |  | [optional] |
+| **starting_after** | **String** |  | [optional] |
+| **room_id** | **String** |  | [optional] |
+| **mtg_session_id** | **String** |  | [optional] |
+
+### Return type
+
+[**ListTranscript200Response**](ListTranscript200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/TranscriptionBucket.md

@@ -0,0 +1,24 @@
+# Daily::TranscriptionBucket
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bucket_name** | **String** | The name of the Amazon S3 bucket to use for transcription storage. | [optional] |
+| **bucket_region** | **String** | The region which the specified S3 bucket is located in. | [optional] |
+| **assume_role_arn** | **String** | The Amazon Resource Name (ARN) of the role Daily should assume when storing the transcription in the specified bucket. | [optional] |
+| **allow_api_access** | **Boolean** | Whether the transcription should be accessible using Daily's API. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::TranscriptionBucket.new(
+  bucket_name: my-daily-recording,
+  bucket_region: ap-south-1,
+  assume_role_arn: arn:aws:iam::555555555555:role/DailyS3AccessRole,
+  allow_api_access: null
+)
+```
+