daily-ruby 0.0.2 → 1.0.0

data/docs/RoomApi.md

@@ -1,297 +0,0 @@
-# Daily::RoomApi
-
-All URIs are relative to *https://api.daily.co/v1*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_room**](RoomApi.md#create_room) | **POST** /rooms | Create a new room |
-| [**delete_room**](RoomApi.md#delete_room) | **DELETE** /rooms/{name} | Delete room |
-| [**get_room**](RoomApi.md#get_room) | **GET** /rooms/{name} | Get room |
-| [**get_rooms**](RoomApi.md#get_rooms) | **GET** /rooms | Get a list rooms |
-
-
-## create_room
-
-> <RoomResponse> create_room(opts)
-
-Create a new room
-
-Creates a new meeting room. The name of the room, privacy settings, and other properties can be specified in the request body. 
-
-### Examples
-
-```ruby
-require 'time'
-require 'daily-ruby'
-# setup authorization
-Daily.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Daily::RoomApi.new
-opts = {
-  room_request: Daily::RoomRequest.new # RoomRequest | A room object
-}
-
-begin
-  # Create a new room
-  result = api_instance.create_room(opts)
-  p result
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->create_room: #{e}"
-end
-```
-
-#### Using the create_room_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<RoomResponse>, Integer, Hash)> create_room_with_http_info(opts)
-
-```ruby
-begin
-  # Create a new room
-  data, status_code, headers = api_instance.create_room_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <RoomResponse>
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->create_room_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **room_request** | [**RoomRequest**](RoomRequest.md) | A room object | [optional] |
-
-### Return type
-
-[**RoomResponse**](RoomResponse.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
-
-
-## delete_room
-
-> <RoomDeletedResponse> delete_room(name)
-
-Delete room
-
-Delete a Daily room.
-
-### Examples
-
-```ruby
-require 'time'
-require 'daily-ruby'
-# setup authorization
-Daily.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Daily::RoomApi.new
-name = 'name_example' # String | The room name that needs to be deleted
-
-begin
-  # Delete room
-  result = api_instance.delete_room(name)
-  p result
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->delete_room: #{e}"
-end
-```
-
-#### Using the delete_room_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<RoomDeletedResponse>, Integer, Hash)> delete_room_with_http_info(name)
-
-```ruby
-begin
-  # Delete room
-  data, status_code, headers = api_instance.delete_room_with_http_info(name)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <RoomDeletedResponse>
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->delete_room_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | The room name that needs to be deleted |  |
-
-### Return type
-
-[**RoomDeletedResponse**](RoomDeletedResponse.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_room
-
-> <RoomResponse> get_room(name)
-
-Get room
-
-Get a Daily room.
-
-### Examples
-
-```ruby
-require 'time'
-require 'daily-ruby'
-# setup authorization
-Daily.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Daily::RoomApi.new
-name = 'name_example' # String | The room name that needs to be fetched
-
-begin
-  # Get room
-  result = api_instance.get_room(name)
-  p result
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->get_room: #{e}"
-end
-```
-
-#### Using the get_room_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<RoomResponse>, Integer, Hash)> get_room_with_http_info(name)
-
-```ruby
-begin
-  # Get room
-  data, status_code, headers = api_instance.get_room_with_http_info(name)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <RoomResponse>
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->get_room_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | The room name that needs to be fetched |  |
-
-### Return type
-
-[**RoomResponse**](RoomResponse.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## get_rooms
-
-> <Array<RoomResponse>> get_rooms(opts)
-
-Get a list rooms
-
-A GET request to /rooms returns a list of rooms.
-
-### Examples
-
-```ruby
-require 'time'
-require 'daily-ruby'
-# setup authorization
-Daily.configure do |config|
-  # Configure Bearer authorization: bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
-end
-
-api_instance = Daily::RoomApi.new
-opts = {
-  offset: 56, # Integer | The number of items to skip before starting to collect the result set.
-  limit: 56, # Integer | The numbers of items to return.
-  ending_before: 'ending_before_example', # String | A cursor for use in pagination. ending_before is an object ID that defines your place in the list.
-  starting_after: 'starting_after_example' # String | A cursor for use in pagination. starting_after is an object ID that defines your place in the list.
-}
-
-begin
-  # Get a list rooms
-  result = api_instance.get_rooms(opts)
-  p result
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->get_rooms: #{e}"
-end
-```
-
-#### Using the get_rooms_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<Array<RoomResponse>>, Integer, Hash)> get_rooms_with_http_info(opts)
-
-```ruby
-begin
-  # Get a list rooms
-  data, status_code, headers = api_instance.get_rooms_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <Array<RoomResponse>>
-rescue Daily::ApiError => e
-  puts "Error when calling RoomApi->get_rooms_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **offset** | **Integer** | The number of items to skip before starting to collect the result set. | [optional] |
-| **limit** | **Integer** | The numbers of items to return. | [optional] |
-| **ending_before** | **String** | A cursor for use in pagination. ending_before is an object ID that defines your place in the list. | [optional] |
-| **starting_after** | **String** | A cursor for use in pagination. starting_after is an object ID that defines your place in the list. | [optional] |
-
-### Return type
-
-[**Array&lt;RoomResponse&gt;**](RoomResponse.md)
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/RoomDeletedResponse.md

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

data/docs/RoomNotFoundResponse.md

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

data/docs/RoomRequestProperties.md

@@ -1,76 +0,0 @@
-# Daily::RoomRequestProperties
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **nbf** | **Integer** |  | [optional] |
-| **exp** | **Integer** |  | [optional] |
-| **max_participants** | **Integer** |  | [optional] |
-| **enable_people_ui** | **Boolean** |  | [optional] |
-| **enable_pip_ui** | **Boolean** |  | [optional] |
-| **enable_emoji_reactions** | **Boolean** |  | [optional] |
-| **enable_hand_raising** | **Boolean** |  | [optional] |
-| **enable_prejoin_ui** | **Boolean** |  | [optional] |
-| **enable_live_captions_ui** | **Boolean** |  | [optional] |
-| **enable_network_ui** | **Boolean** |  | [optional] |
-| **enable_noise_cancellation_ui** | **Boolean** |  | [optional] |
-| **enable_breakout_rooms** | **Boolean** |  | [optional] |
-| **enable_knocking** | **Boolean** |  | [optional] |
-| **enable_screenshare** | **Boolean** |  | [optional] |
-| **enable_video_processing_ui** | **Boolean** |  | [optional] |
-| **enable_chat** | **Boolean** |  | [optional] |
-| **start_video_off** | **Boolean** |  | [optional] |
-| **start_audio_off** | **Boolean** |  | [optional] |
-| **owner_only_broadcast** | **Boolean** |  | [optional] |
-| **enable_recording** | **String** |  | [optional] |
-| **eject_at_room_exp** | **Boolean** |  | [optional] |
-| **eject_after_elapsed** | **Boolean** |  | [optional] |
-| **enable_advanced_chat** | **Boolean** |  | [optional] |
-| **enable_hidden_participants** | **Boolean** |  | [optional] |
-| **enable_mesh_sfu** | **Boolean** |  | [optional] |
-| **sfu_switchover** | **Float** |  | [optional] |
-| **experimental_optimize_large_calls** | **Boolean** |  | [optional] |
-| **lang** | **String** |  | [optional] |
-| **meeting_join_hook** | **String** |  | [optional] |
-| **geo** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::RoomRequestProperties.new(
-  nbf: null,
-  exp: null,
-  max_participants: null,
-  enable_people_ui: null,
-  enable_pip_ui: null,
-  enable_emoji_reactions: null,
-  enable_hand_raising: null,
-  enable_prejoin_ui: null,
-  enable_live_captions_ui: null,
-  enable_network_ui: null,
-  enable_noise_cancellation_ui: null,
-  enable_breakout_rooms: null,
-  enable_knocking: null,
-  enable_screenshare: null,
-  enable_video_processing_ui: null,
-  enable_chat: null,
-  start_video_off: null,
-  start_audio_off: null,
-  owner_only_broadcast: null,
-  enable_recording: null,
-  eject_at_room_exp: null,
-  eject_after_elapsed: null,
-  enable_advanced_chat: null,
-  enable_hidden_participants: null,
-  enable_mesh_sfu: null,
-  sfu_switchover: null,
-  experimental_optimize_large_calls: null,
-  lang: null,
-  meeting_join_hook: null,
-  geo: null
-)
-```
-

data/docs/RoomResponse.md

@@ -1,28 +0,0 @@
-# Daily::RoomResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
-| **name** | **String** |  | [optional] |
-| **api_created** | **Boolean** |  | [optional] |
-| **privacy** | **String** |  | [optional] |
-| **url** | **String** |  | [optional] |
-| **created_at** | **Time** |  | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::RoomResponse.new(
-  id: null,
-  name: null,
-  api_created: null,
-  privacy: null,
-  url: null,
-  created_at: null
-)
-```
-

data/docs/ServerErrorResponse.md

@@ -1,18 +0,0 @@
-# Daily::ServerErrorResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **error** | **String** | A message describing the server error. | [optional] |
-
-## Example
-
-```ruby
-require 'daily-ruby'
-
-instance = Daily::ServerErrorResponse.new(
-  error: null
-)
-```
-