daily-ruby 0.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +79 -0
- data/README.md +119 -0
- data/Rakefile +10 -0
- data/daily-ruby.gemspec +40 -0
- data/daily.yaml +422 -0
- data/docs/CreateMeetingToken200Response.md +18 -0
- data/docs/MeetingTokenRequest.md +18 -0
- data/docs/MeetingTokenRequestProperties.md +56 -0
- data/docs/MeetingTokenRequestPropertiesPermissions.md +22 -0
- data/docs/MeetingTokenRequestPropertiesPermissionsCanAdmin.md +49 -0
- data/docs/MeetingTokenRequestPropertiesPermissionsCanSend.md +49 -0
- data/docs/MeetingTokensApi.md +79 -0
- data/docs/RoomApi.md +227 -0
- data/docs/RoomDeletedResponse.md +20 -0
- data/docs/RoomNotFoundResponse.md +20 -0
- data/docs/RoomRequest.md +22 -0
- data/docs/RoomRequestProperties.md +76 -0
- data/docs/RoomResponse.md +28 -0
- data/docs/ServerErrorResponse.md +18 -0
- data/git_push.sh +57 -0
- data/lib/daily-ruby/api/meeting_tokens_api.rb +86 -0
- data/lib/daily-ruby/api/room_api.rb +218 -0
- data/lib/daily-ruby/api_client.rb +431 -0
- data/lib/daily-ruby/api_error.rb +58 -0
- data/lib/daily-ruby/configuration.rb +382 -0
- data/lib/daily-ruby/models/create_meeting_token200_response.rb +214 -0
- data/lib/daily-ruby/models/meeting_token_request.rb +215 -0
- data/lib/daily-ruby/models/meeting_token_request_properties.rb +438 -0
- data/lib/daily-ruby/models/meeting_token_request_properties_permissions.rb +232 -0
- data/lib/daily-ruby/models/meeting_token_request_properties_permissions_can_admin.rb +105 -0
- data/lib/daily-ruby/models/meeting_token_request_properties_permissions_can_send.rb +105 -0
- data/lib/daily-ruby/models/room_deleted_response.rb +224 -0
- data/lib/daily-ruby/models/room_not_found_response.rb +224 -0
- data/lib/daily-ruby/models/room_request.rb +267 -0
- data/lib/daily-ruby/models/room_request_properties.rb +521 -0
- data/lib/daily-ruby/models/room_response.rb +260 -0
- data/lib/daily-ruby/models/server_error_response.rb +215 -0
- data/lib/daily-ruby/version.rb +15 -0
- data/lib/daily-ruby.rb +53 -0
- data/run.sh +16 -0
- data/script.rb +35 -0
- data/spec/api/meeting_tokens_api_spec.rb +47 -0
- data/spec/api/room_api_spec.rb +74 -0
- data/spec/models/create_meeting_token200_response_spec.rb +36 -0
- data/spec/models/meeting_token_request_properties_permissions_can_admin_spec.rb +32 -0
- data/spec/models/meeting_token_request_properties_permissions_can_send_spec.rb +32 -0
- data/spec/models/meeting_token_request_properties_permissions_spec.rb +48 -0
- data/spec/models/meeting_token_request_properties_spec.rb +158 -0
- data/spec/models/meeting_token_request_spec.rb +36 -0
- data/spec/models/room_deleted_response_spec.rb +42 -0
- data/spec/models/room_not_found_response_spec.rb +42 -0
- data/spec/models/room_request_properties_spec.rb +218 -0
- data/spec/models/room_request_spec.rb +52 -0
- data/spec/models/room_response_spec.rb +66 -0
- data/spec/models/server_error_response_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- metadata +169 -0
@@ -0,0 +1,18 @@
|
|
1
|
+
# Daily::MeetingTokenRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **properties** | [**MeetingTokenRequestProperties**](MeetingTokenRequestProperties.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'daily-ruby'
|
13
|
+
|
14
|
+
instance = Daily::MeetingTokenRequest.new(
|
15
|
+
properties: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,56 @@
|
|
1
|
+
# Daily::MeetingTokenRequestProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **room_name** | **String** | | |
|
8
|
+
| **eject_at_token_exp** | **Boolean** | | [optional] |
|
9
|
+
| **nbf** | **Integer** | | [optional] |
|
10
|
+
| **exp** | **Integer** | | [optional] |
|
11
|
+
| **is_owner** | **Boolean** | | [optional] |
|
12
|
+
| **user_name** | **String** | | [optional] |
|
13
|
+
| **user_id** | **String** | | [optional] |
|
14
|
+
| **enable_screenshare** | **Boolean** | | [optional] |
|
15
|
+
| **start_video_off** | **Boolean** | | [optional] |
|
16
|
+
| **start_audio_off** | **Boolean** | | [optional] |
|
17
|
+
| **enable_recording** | **String** | | [optional] |
|
18
|
+
| **enable_prejoin_ui** | **Boolean** | | [optional] |
|
19
|
+
| **enable_live_captions_ui** | **Boolean** | | [optional] |
|
20
|
+
| **enable_recording_ui** | **Boolean** | | [optional] |
|
21
|
+
| **enable_terse_logging** | **Boolean** | | [optional] |
|
22
|
+
| **auto_start_transcription** | **Boolean** | | [optional] |
|
23
|
+
| **close_tab_on_exit** | **Boolean** | | [optional] |
|
24
|
+
| **redirect_on_meeting_exit** | **String** | | [optional] |
|
25
|
+
| **lang** | **String** | | [optional] |
|
26
|
+
| **permissions** | [**MeetingTokenRequestPropertiesPermissions**](MeetingTokenRequestPropertiesPermissions.md) | | [optional] |
|
27
|
+
|
28
|
+
## Example
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'daily-ruby'
|
32
|
+
|
33
|
+
instance = Daily::MeetingTokenRequestProperties.new(
|
34
|
+
room_name: null,
|
35
|
+
eject_at_token_exp: null,
|
36
|
+
nbf: null,
|
37
|
+
exp: null,
|
38
|
+
is_owner: null,
|
39
|
+
user_name: null,
|
40
|
+
user_id: null,
|
41
|
+
enable_screenshare: null,
|
42
|
+
start_video_off: null,
|
43
|
+
start_audio_off: null,
|
44
|
+
enable_recording: null,
|
45
|
+
enable_prejoin_ui: null,
|
46
|
+
enable_live_captions_ui: null,
|
47
|
+
enable_recording_ui: null,
|
48
|
+
enable_terse_logging: null,
|
49
|
+
auto_start_transcription: null,
|
50
|
+
close_tab_on_exit: null,
|
51
|
+
redirect_on_meeting_exit: null,
|
52
|
+
lang: null,
|
53
|
+
permissions: null
|
54
|
+
)
|
55
|
+
```
|
56
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Daily::MeetingTokenRequestPropertiesPermissions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **has_presence** | **Boolean** | | [optional] |
|
8
|
+
| **can_send** | [**MeetingTokenRequestPropertiesPermissionsCanSend**](MeetingTokenRequestPropertiesPermissionsCanSend.md) | | [optional] |
|
9
|
+
| **can_admin** | [**MeetingTokenRequestPropertiesPermissionsCanAdmin**](MeetingTokenRequestPropertiesPermissionsCanAdmin.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'daily-ruby'
|
15
|
+
|
16
|
+
instance = Daily::MeetingTokenRequestPropertiesPermissions.new(
|
17
|
+
has_presence: null,
|
18
|
+
can_send: null,
|
19
|
+
can_admin: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'daily-ruby'
|
13
|
+
|
14
|
+
Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'Array<String>',
|
18
|
+
# :'Boolean'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'daily-ruby'
|
30
|
+
|
31
|
+
Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.build(data)
|
32
|
+
# => #<Array<String>:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `Array<String>`
|
47
|
+
- `Boolean`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# Daily::MeetingTokenRequestPropertiesPermissionsCanSend
|
2
|
+
|
3
|
+
## Class instance methods
|
4
|
+
|
5
|
+
### `openapi_one_of`
|
6
|
+
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'daily-ruby'
|
13
|
+
|
14
|
+
Daily::MeetingTokenRequestPropertiesPermissionsCanSend.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'Array<String>',
|
18
|
+
# :'Boolean'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'daily-ruby'
|
30
|
+
|
31
|
+
Daily::MeetingTokenRequestPropertiesPermissionsCanSend.build(data)
|
32
|
+
# => #<Array<String>:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
Daily::MeetingTokenRequestPropertiesPermissionsCanSend.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `Array<String>`
|
47
|
+
- `Boolean`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# Daily::MeetingTokensApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.daily.co/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_meeting_token**](MeetingTokensApi.md#create_meeting_token) | **POST** /meeting-tokens | Creates a meeting token |
|
8
|
+
|
9
|
+
|
10
|
+
## create_meeting_token
|
11
|
+
|
12
|
+
> <CreateMeetingToken200Response> create_meeting_token(opts)
|
13
|
+
|
14
|
+
Creates a meeting token
|
15
|
+
|
16
|
+
A POST request to /meeting-tokens creates a new meeting token.
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'daily-ruby'
|
23
|
+
# setup authorization
|
24
|
+
Daily.configure do |config|
|
25
|
+
# Configure Bearer authorization: bearerAuth
|
26
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = Daily::MeetingTokensApi.new
|
30
|
+
opts = {
|
31
|
+
meeting_token_request: Daily::MeetingTokenRequest.new # MeetingTokenRequest | A room object
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
# Creates a meeting token
|
36
|
+
result = api_instance.create_meeting_token(opts)
|
37
|
+
p result
|
38
|
+
rescue Daily::ApiError => e
|
39
|
+
puts "Error when calling MeetingTokensApi->create_meeting_token: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
#### Using the create_meeting_token_with_http_info variant
|
44
|
+
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
46
|
+
|
47
|
+
> <Array(<CreateMeetingToken200Response>, Integer, Hash)> create_meeting_token_with_http_info(opts)
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
begin
|
51
|
+
# Creates a meeting token
|
52
|
+
data, status_code, headers = api_instance.create_meeting_token_with_http_info(opts)
|
53
|
+
p status_code # => 2xx
|
54
|
+
p headers # => { ... }
|
55
|
+
p data # => <CreateMeetingToken200Response>
|
56
|
+
rescue Daily::ApiError => e
|
57
|
+
puts "Error when calling MeetingTokensApi->create_meeting_token_with_http_info: #{e}"
|
58
|
+
end
|
59
|
+
```
|
60
|
+
|
61
|
+
### Parameters
|
62
|
+
|
63
|
+
| Name | Type | Description | Notes |
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
65
|
+
| **meeting_token_request** | [**MeetingTokenRequest**](MeetingTokenRequest.md) | A room object | [optional] |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**CreateMeetingToken200Response**](CreateMeetingToken200Response.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[bearerAuth](../README.md#bearerAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: application/json
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
data/docs/RoomApi.md
ADDED
@@ -0,0 +1,227 @@
|
|
1
|
+
# Daily::RoomApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.daily.co/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_room**](RoomApi.md#create_room) | **POST** /rooms | Create a new room |
|
8
|
+
| [**delete_room**](RoomApi.md#delete_room) | **DELETE** /rooms/{name} | Delete room |
|
9
|
+
| [**get_rooms**](RoomApi.md#get_rooms) | **GET** /rooms | Get a list rooms |
|
10
|
+
|
11
|
+
|
12
|
+
## create_room
|
13
|
+
|
14
|
+
> <RoomResponse> create_room(opts)
|
15
|
+
|
16
|
+
Create a new room
|
17
|
+
|
18
|
+
A POST request to /rooms creates a new room.
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'daily-ruby'
|
25
|
+
# setup authorization
|
26
|
+
Daily.configure do |config|
|
27
|
+
# Configure Bearer authorization: bearerAuth
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = Daily::RoomApi.new
|
32
|
+
opts = {
|
33
|
+
room_request: Daily::RoomRequest.new # RoomRequest | A room object
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
# Create a new room
|
38
|
+
result = api_instance.create_room(opts)
|
39
|
+
p result
|
40
|
+
rescue Daily::ApiError => e
|
41
|
+
puts "Error when calling RoomApi->create_room: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the create_room_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<RoomResponse>, Integer, Hash)> create_room_with_http_info(opts)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# Create a new room
|
54
|
+
data, status_code, headers = api_instance.create_room_with_http_info(opts)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <RoomResponse>
|
58
|
+
rescue Daily::ApiError => e
|
59
|
+
puts "Error when calling RoomApi->create_room_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **room_request** | [**RoomRequest**](RoomRequest.md) | A room object | [optional] |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**RoomResponse**](RoomResponse.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[bearerAuth](../README.md#bearerAuth)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: application/json
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## delete_room
|
84
|
+
|
85
|
+
> <RoomDeletedResponse> delete_room(name)
|
86
|
+
|
87
|
+
Delete room
|
88
|
+
|
89
|
+
Delete a Daily room.
|
90
|
+
|
91
|
+
### Examples
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
require 'time'
|
95
|
+
require 'daily-ruby'
|
96
|
+
# setup authorization
|
97
|
+
Daily.configure do |config|
|
98
|
+
# Configure Bearer authorization: bearerAuth
|
99
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
100
|
+
end
|
101
|
+
|
102
|
+
api_instance = Daily::RoomApi.new
|
103
|
+
name = 'name_example' # String | The room name that needs to be deleted
|
104
|
+
|
105
|
+
begin
|
106
|
+
# Delete room
|
107
|
+
result = api_instance.delete_room(name)
|
108
|
+
p result
|
109
|
+
rescue Daily::ApiError => e
|
110
|
+
puts "Error when calling RoomApi->delete_room: #{e}"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
#### Using the delete_room_with_http_info variant
|
115
|
+
|
116
|
+
This returns an Array which contains the response data, status code and headers.
|
117
|
+
|
118
|
+
> <Array(<RoomDeletedResponse>, Integer, Hash)> delete_room_with_http_info(name)
|
119
|
+
|
120
|
+
```ruby
|
121
|
+
begin
|
122
|
+
# Delete room
|
123
|
+
data, status_code, headers = api_instance.delete_room_with_http_info(name)
|
124
|
+
p status_code # => 2xx
|
125
|
+
p headers # => { ... }
|
126
|
+
p data # => <RoomDeletedResponse>
|
127
|
+
rescue Daily::ApiError => e
|
128
|
+
puts "Error when calling RoomApi->delete_room_with_http_info: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
| Name | Type | Description | Notes |
|
135
|
+
| ---- | ---- | ----------- | ----- |
|
136
|
+
| **name** | **String** | The room name that needs to be deleted | |
|
137
|
+
|
138
|
+
### Return type
|
139
|
+
|
140
|
+
[**RoomDeletedResponse**](RoomDeletedResponse.md)
|
141
|
+
|
142
|
+
### Authorization
|
143
|
+
|
144
|
+
[bearerAuth](../README.md#bearerAuth)
|
145
|
+
|
146
|
+
### HTTP request headers
|
147
|
+
|
148
|
+
- **Content-Type**: Not defined
|
149
|
+
- **Accept**: application/json
|
150
|
+
|
151
|
+
|
152
|
+
## get_rooms
|
153
|
+
|
154
|
+
> <Array<RoomResponse>> get_rooms(opts)
|
155
|
+
|
156
|
+
Get a list rooms
|
157
|
+
|
158
|
+
A GET request to /rooms returns a list of rooms.
|
159
|
+
|
160
|
+
### Examples
|
161
|
+
|
162
|
+
```ruby
|
163
|
+
require 'time'
|
164
|
+
require 'daily-ruby'
|
165
|
+
# setup authorization
|
166
|
+
Daily.configure do |config|
|
167
|
+
# Configure Bearer authorization: bearerAuth
|
168
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
169
|
+
end
|
170
|
+
|
171
|
+
api_instance = Daily::RoomApi.new
|
172
|
+
opts = {
|
173
|
+
offset: 56, # Integer | The number of items to skip before starting to collect the result set.
|
174
|
+
limit: 56, # Integer | The numbers of items to return.
|
175
|
+
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.
|
176
|
+
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.
|
177
|
+
}
|
178
|
+
|
179
|
+
begin
|
180
|
+
# Get a list rooms
|
181
|
+
result = api_instance.get_rooms(opts)
|
182
|
+
p result
|
183
|
+
rescue Daily::ApiError => e
|
184
|
+
puts "Error when calling RoomApi->get_rooms: #{e}"
|
185
|
+
end
|
186
|
+
```
|
187
|
+
|
188
|
+
#### Using the get_rooms_with_http_info variant
|
189
|
+
|
190
|
+
This returns an Array which contains the response data, status code and headers.
|
191
|
+
|
192
|
+
> <Array(<Array<RoomResponse>>, Integer, Hash)> get_rooms_with_http_info(opts)
|
193
|
+
|
194
|
+
```ruby
|
195
|
+
begin
|
196
|
+
# Get a list rooms
|
197
|
+
data, status_code, headers = api_instance.get_rooms_with_http_info(opts)
|
198
|
+
p status_code # => 2xx
|
199
|
+
p headers # => { ... }
|
200
|
+
p data # => <Array<RoomResponse>>
|
201
|
+
rescue Daily::ApiError => e
|
202
|
+
puts "Error when calling RoomApi->get_rooms_with_http_info: #{e}"
|
203
|
+
end
|
204
|
+
```
|
205
|
+
|
206
|
+
### Parameters
|
207
|
+
|
208
|
+
| Name | Type | Description | Notes |
|
209
|
+
| ---- | ---- | ----------- | ----- |
|
210
|
+
| **offset** | **Integer** | The number of items to skip before starting to collect the result set. | [optional] |
|
211
|
+
| **limit** | **Integer** | The numbers of items to return. | [optional] |
|
212
|
+
| **ending_before** | **String** | A cursor for use in pagination. ending_before is an object ID that defines your place in the list. | [optional] |
|
213
|
+
| **starting_after** | **String** | A cursor for use in pagination. starting_after is an object ID that defines your place in the list. | [optional] |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**Array<RoomResponse>**](RoomResponse.md)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
[bearerAuth](../README.md#bearerAuth)
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: Not defined
|
226
|
+
- **Accept**: application/json
|
227
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Daily::RoomDeletedResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **deleted** | **Boolean** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'daily-ruby'
|
14
|
+
|
15
|
+
instance = Daily::RoomDeletedResponse.new(
|
16
|
+
name: null,
|
17
|
+
deleted: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Daily::RoomNotFoundResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | **String** | | [optional] |
|
8
|
+
| **info** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'daily-ruby'
|
14
|
+
|
15
|
+
instance = Daily::RoomNotFoundResponse.new(
|
16
|
+
error: null,
|
17
|
+
info: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/RoomRequest.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# Daily::RoomRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **privacy** | **String** | | [optional] |
|
9
|
+
| **properties** | [**RoomRequestProperties**](RoomRequestProperties.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'daily-ruby'
|
15
|
+
|
16
|
+
instance = Daily::RoomRequest.new(
|
17
|
+
name: null,
|
18
|
+
privacy: null,
|
19
|
+
properties: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# Daily::RoomRequestProperties
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **nbf** | **Integer** | | [optional] |
|
8
|
+
| **exp** | **Integer** | | [optional] |
|
9
|
+
| **max_participants** | **Integer** | | [optional] |
|
10
|
+
| **enable_people_ui** | **Boolean** | | [optional] |
|
11
|
+
| **enable_pip_ui** | **Boolean** | | [optional] |
|
12
|
+
| **enable_emoji_reactions** | **Boolean** | | [optional] |
|
13
|
+
| **enable_hand_raising** | **Boolean** | | [optional] |
|
14
|
+
| **enable_prejoin_ui** | **Boolean** | | [optional] |
|
15
|
+
| **enable_live_captions_ui** | **Boolean** | | [optional] |
|
16
|
+
| **enable_network_ui** | **Boolean** | | [optional] |
|
17
|
+
| **enable_noise_cancellation_ui** | **Boolean** | | [optional] |
|
18
|
+
| **enable_breakout_rooms** | **Boolean** | | [optional] |
|
19
|
+
| **enable_knocking** | **Boolean** | | [optional] |
|
20
|
+
| **enable_screenshare** | **Boolean** | | [optional] |
|
21
|
+
| **enable_video_processing_ui** | **Boolean** | | [optional] |
|
22
|
+
| **enable_chat** | **Boolean** | | [optional] |
|
23
|
+
| **start_video_off** | **Boolean** | | [optional] |
|
24
|
+
| **start_audio_off** | **Boolean** | | [optional] |
|
25
|
+
| **owner_only_broadcast** | **Boolean** | | [optional] |
|
26
|
+
| **enable_recording** | **String** | | [optional] |
|
27
|
+
| **eject_at_room_exp** | **Boolean** | | [optional] |
|
28
|
+
| **eject_after_elapsed** | **Boolean** | | [optional] |
|
29
|
+
| **enable_advanced_chat** | **Boolean** | | [optional] |
|
30
|
+
| **enable_hidden_participants** | **Boolean** | | [optional] |
|
31
|
+
| **enable_mesh_sfu** | **Boolean** | | [optional] |
|
32
|
+
| **sfu_switchover** | **Float** | | [optional] |
|
33
|
+
| **experimental_optimize_large_calls** | **Boolean** | | [optional] |
|
34
|
+
| **lang** | **String** | | [optional] |
|
35
|
+
| **meeting_join_hook** | **String** | | [optional] |
|
36
|
+
| **geo** | **String** | | [optional] |
|
37
|
+
|
38
|
+
## Example
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
require 'daily-ruby'
|
42
|
+
|
43
|
+
instance = Daily::RoomRequestProperties.new(
|
44
|
+
nbf: null,
|
45
|
+
exp: null,
|
46
|
+
max_participants: null,
|
47
|
+
enable_people_ui: null,
|
48
|
+
enable_pip_ui: null,
|
49
|
+
enable_emoji_reactions: null,
|
50
|
+
enable_hand_raising: null,
|
51
|
+
enable_prejoin_ui: null,
|
52
|
+
enable_live_captions_ui: null,
|
53
|
+
enable_network_ui: null,
|
54
|
+
enable_noise_cancellation_ui: null,
|
55
|
+
enable_breakout_rooms: null,
|
56
|
+
enable_knocking: null,
|
57
|
+
enable_screenshare: null,
|
58
|
+
enable_video_processing_ui: null,
|
59
|
+
enable_chat: null,
|
60
|
+
start_video_off: null,
|
61
|
+
start_audio_off: null,
|
62
|
+
owner_only_broadcast: null,
|
63
|
+
enable_recording: null,
|
64
|
+
eject_at_room_exp: null,
|
65
|
+
eject_after_elapsed: null,
|
66
|
+
enable_advanced_chat: null,
|
67
|
+
enable_hidden_participants: null,
|
68
|
+
enable_mesh_sfu: null,
|
69
|
+
sfu_switchover: null,
|
70
|
+
experimental_optimize_large_calls: null,
|
71
|
+
lang: null,
|
72
|
+
meeting_join_hook: null,
|
73
|
+
geo: null
|
74
|
+
)
|
75
|
+
```
|
76
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# Daily::RoomResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | [optional] |
|
8
|
+
| **name** | **String** | | [optional] |
|
9
|
+
| **api_created** | **Boolean** | | [optional] |
|
10
|
+
| **privacy** | **String** | | [optional] |
|
11
|
+
| **url** | **String** | | [optional] |
|
12
|
+
| **created_at** | **Time** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'daily-ruby'
|
18
|
+
|
19
|
+
instance = Daily::RoomResponse.new(
|
20
|
+
id: null,
|
21
|
+
name: null,
|
22
|
+
api_created: null,
|
23
|
+
privacy: null,
|
24
|
+
url: null,
|
25
|
+
created_at: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Daily::ServerErrorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'daily-ruby'
|
13
|
+
|
14
|
+
instance = Daily::ServerErrorResponse.new(
|
15
|
+
error: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|