daily-ruby 0.0.0 → 0.0.2

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.
Files changed (46) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +74 -67
  4. data/daily-ruby.gemspec +1 -1
  5. data/daily.yaml +72 -34
  6. data/docs/{CreateMeetingToken200Response.md → MeetingTokenResponse.md} +3 -3
  7. data/docs/MeetingTokensApi.md +5 -5
  8. data/docs/RoomApi.md +71 -1
  9. data/docs/ServerErrorResponse.md +1 -1
  10. data/lib/daily-ruby/api/meeting_tokens_api.rb +6 -6
  11. data/lib/daily-ruby/api/room_api.rb +66 -3
  12. data/lib/daily-ruby/api_client.rb +1 -1
  13. data/lib/daily-ruby/api_error.rb +1 -1
  14. data/lib/daily-ruby/configuration.rb +1 -1
  15. data/lib/daily-ruby/models/meeting_token_request.rb +1 -1
  16. data/lib/daily-ruby/models/meeting_token_request_properties.rb +1 -1
  17. data/lib/daily-ruby/models/meeting_token_request_properties_permissions.rb +1 -1
  18. data/lib/daily-ruby/models/meeting_token_request_properties_permissions_can_admin.rb +1 -1
  19. data/lib/daily-ruby/models/meeting_token_request_properties_permissions_can_send.rb +1 -1
  20. data/lib/daily-ruby/models/{create_meeting_token200_response.rb → meeting_token_response.rb} +6 -4
  21. data/lib/daily-ruby/models/room_deleted_response.rb +1 -1
  22. data/lib/daily-ruby/models/room_not_found_response.rb +1 -1
  23. data/lib/daily-ruby/models/room_request.rb +1 -1
  24. data/lib/daily-ruby/models/room_request_properties.rb +1 -1
  25. data/lib/daily-ruby/models/room_response.rb +1 -1
  26. data/lib/daily-ruby/models/server_error_response.rb +3 -2
  27. data/lib/daily-ruby/version.rb +2 -2
  28. data/lib/daily-ruby.rb +2 -2
  29. data/run.sh +1 -1
  30. data/spec/api/meeting_tokens_api_spec.rb +3 -3
  31. data/spec/api/room_api_spec.rb +14 -2
  32. data/spec/models/meeting_token_request_properties_permissions_can_admin_spec.rb +1 -1
  33. data/spec/models/meeting_token_request_properties_permissions_can_send_spec.rb +1 -1
  34. data/spec/models/meeting_token_request_properties_permissions_spec.rb +1 -1
  35. data/spec/models/meeting_token_request_properties_spec.rb +1 -1
  36. data/spec/models/meeting_token_request_spec.rb +1 -1
  37. data/spec/models/{create_meeting_token200_response_spec.rb → meeting_token_response_spec.rb} +7 -7
  38. data/spec/models/room_deleted_response_spec.rb +1 -1
  39. data/spec/models/room_not_found_response_spec.rb +1 -1
  40. data/spec/models/room_request_properties_spec.rb +1 -1
  41. data/spec/models/room_request_spec.rb +1 -1
  42. data/spec/models/room_response_spec.rb +1 -1
  43. data/spec/models/server_error_response_spec.rb +1 -1
  44. data/spec/spec_helper.rb +1 -1
  45. metadata +6 -7
  46. data/script.rb +0 -35
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 30036a3624f0289448341cf3a930b890d59d766d2d303835d84a632b2bfb101f
4
- data.tar.gz: 80857b3b53296d8b74ff56d927341e30a45db4d32211e94b7370df9df9989d87
3
+ metadata.gz: 29c72a3902b2c291c7c130661e81b264619909e39f8d7393d2f84acd5058a8f1
4
+ data.tar.gz: c0682657729c142eb661d192214ec0e49370a83f413cbd17e8fffa1218d23579
5
5
  SHA512:
6
- metadata.gz: e9b12da014cc46e6679eed93fc8d7551c3a7f9b24e485df1475070664f5f8e16d44c338a4970bfeacb60e7988df093d0cf42f3c69675d082cc580018e080c40a
7
- data.tar.gz: 64c2f0fbc381cf0ca39919e39bc301830a2c0378593e166bcd329b9488babcf01c680ec0baed6fbaa734bf3f2245ae35fe27aa574c3e3b3756324b7779bf466c
6
+ metadata.gz: 494fd114835d1ad8d7263cb0f70a8a73a5518e64af6c2ba9c67735e9d18e6fc2a888454071ac8c66585ee1e5744eb486f62769724bb41a22aadd3d8501b36174
7
+ data.tar.gz: f776039f61198d7bfa72f0f479905e12862792aff51977f560125acf1bd92b376b01da30850c50d3d3083168eecf44b290b3e3286879511754d68066f6cb1461
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- daily-ruby (0.0.0)
4
+ daily-ruby (0.0.1)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
7
 
data/README.md CHANGED
@@ -6,51 +6,24 @@ The official library for communicating with the Daily REST API.
6
6
 
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
- - API version: 0.0.0
10
- - Package version: 0.0.0
9
+ - API version: 0.0.2
10
+ - Package version: 0.0.2
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
14
14
 
15
- ### Build a gem
15
+ Add this line to your Gemfile:
16
16
 
17
- To build the Ruby code into a gem:
17
+ gem 'daily-ruby', '~> 0.0.2'
18
18
 
19
- ```shell
20
- gem build daily-ruby.gemspec
21
- ```
22
-
23
- Then either install the gem locally:
24
-
25
- ```shell
26
- gem install ./daily-ruby-0.0.0.gem
27
- ```
28
-
29
- (for development, run `gem install --dev ./daily-ruby-0.0.0.gem` to install the development dependencies)
30
-
31
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
-
33
- Finally add this to the Gemfile:
34
-
35
- gem 'daily-ruby', '~> 0.0.0'
36
-
37
- ### Install from Git
38
-
39
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
40
-
41
- gem 'daily-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
42
-
43
- ### Include the Ruby code directly
44
-
45
- Include the Ruby code directly using `-I` as follows:
46
-
47
- ```shell
48
- ruby -Ilib script.rb
49
- ```
19
+ Then run `bundle install`.
50
20
 
51
21
  ## Getting Started
52
22
 
53
- Please follow the [installation](#installation) procedure and then run the following code:
23
+ The following example:
24
+
25
+ 1. Creates a Daily room.
26
+ 2. Creates a meeting token for the Daily room and associates it with the room
54
27
 
55
28
  ```ruby
56
29
  # Load the gem
@@ -59,61 +32,95 @@ require 'daily-ruby'
59
32
  # Setup authorization
60
33
  Daily.configure do |config|
61
34
  # Configure Bearer authorization: bearerAuth
62
- config.access_token = 'YOUR_BEARER_TOKEN'
35
+ config.access_token = ENV['DAILY_API_KEY']
63
36
  # Configure a proc to get access tokens in lieu of the static access_token configuration
64
- config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
37
+ # config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
65
38
  # Configure faraday connection
66
- config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
39
+ # config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
40
+ end
41
+
42
+ room_api_instance = Daily::RoomApi.new
43
+ opts = {
44
+ room_request: Daily::RoomRequest.new(
45
+ privacy: 'private',
46
+ properties: Daily::RoomRequestProperties.new({
47
+ exp: (Time.now + (3600 * 2)).to_i, # Delete the room after two hours
48
+ enable_mesh_sfu: true,
49
+ sfu_switchover: 0.5
50
+ })
51
+ )
52
+ }
53
+
54
+ begin
55
+ # Create a new room
56
+ room = room_api_instance.create_room(opts)
57
+ p room
58
+ rescue Daily::ApiError => e
59
+ puts "Error when calling RoomApi->create_room: #{e}"
67
60
  end
68
61
 
69
- api_instance = Daily::MeetingTokensApi.new
62
+ meeting_token_api_instance = Daily::MeetingTokensApi.new
63
+
64
+ # Create an owner meeting_token for the room with privacy set to private and
65
+ # the expiration set to 2 hours from now.
66
+
70
67
  opts = {
71
- meeting_token_request: Daily::MeetingTokenRequest.new # MeetingTokenRequest | A room object
68
+ meeting_token_request: Daily::MeetingTokenRequest.new({
69
+ properties: Daily::MeetingTokenRequestProperties.new({
70
+ is_owner: true,
71
+ room_name: room.name,
72
+ exp: (Time.now + (3600 * 2)).to_i # Expire the token after two hours
73
+ })
74
+ })
72
75
  }
73
76
 
77
+
74
78
  begin
75
- #Creates a meeting token
76
- result = api_instance.create_meeting_token(opts)
77
- p result
79
+ # Create a new meeting token
80
+ meeting_token = meeting_token_api_instance.create_meeting_token(opts)
81
+ p meeting_token
78
82
  rescue Daily::ApiError => e
79
- puts "Exception when calling MeetingTokensApi->create_meeting_token: #{e}"
83
+ puts "Error when calling MeetingTokensApi->create_meeting_token: #{e}"
80
84
  end
81
85
 
86
+
87
+ p "Room url: " + room.url
88
+ p "Meeting token: " + meeting_token.token
89
+
90
+
82
91
  ```
83
92
 
84
93
  ## Documentation for API Endpoints
85
94
 
86
95
  All URIs are relative to *https://api.daily.co/v1*
87
96
 
88
- Class | Method | HTTP request | Description
89
- ------------ | ------------- | ------------- | -------------
90
- *Daily::MeetingTokensApi* | [**create_meeting_token**](docs/MeetingTokensApi.md#create_meeting_token) | **POST** /meeting-tokens | Creates a meeting token
91
- *Daily::RoomApi* | [**create_room**](docs/RoomApi.md#create_room) | **POST** /rooms | Create a new room
92
- *Daily::RoomApi* | [**delete_room**](docs/RoomApi.md#delete_room) | **DELETE** /rooms/{name} | Delete room
93
- *Daily::RoomApi* | [**get_rooms**](docs/RoomApi.md#get_rooms) | **GET** /rooms | Get a list rooms
94
-
97
+ | Class | Method | HTTP request | Description |
98
+ | ------------------------- | ------------------------------------------------------------------------- | ------------------------ | ----------------------- |
99
+ | _Daily::MeetingTokensApi_ | [**create_meeting_token**](docs/MeetingTokensApi.md#create_meeting_token) | **POST** /meeting-tokens | Creates a meeting token |
100
+ | _Daily::RoomApi_ | [**create_room**](docs/RoomApi.md#create_room) | **POST** /rooms | Create a new room |
101
+ | _Daily::RoomApi_ | [**delete_room**](docs/RoomApi.md#delete_room) | **DELETE** /rooms/{name} | Delete room |
102
+ | _Daily::RoomApi_ | [**get_room**](docs/RoomApi.md#get_room) | **GET** /rooms/{name} | Get room |
103
+ | _Daily::RoomApi_ | [**get_rooms**](docs/RoomApi.md#get_rooms) | **GET** /rooms | Get a list rooms |
95
104
 
96
105
  ## Documentation for Models
97
106
 
98
- - [Daily::CreateMeetingToken200Response](docs/CreateMeetingToken200Response.md)
99
- - [Daily::MeetingTokenRequest](docs/MeetingTokenRequest.md)
100
- - [Daily::MeetingTokenRequestProperties](docs/MeetingTokenRequestProperties.md)
101
- - [Daily::MeetingTokenRequestPropertiesPermissions](docs/MeetingTokenRequestPropertiesPermissions.md)
102
- - [Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin](docs/MeetingTokenRequestPropertiesPermissionsCanAdmin.md)
103
- - [Daily::MeetingTokenRequestPropertiesPermissionsCanSend](docs/MeetingTokenRequestPropertiesPermissionsCanSend.md)
104
- - [Daily::RoomDeletedResponse](docs/RoomDeletedResponse.md)
105
- - [Daily::RoomNotFoundResponse](docs/RoomNotFoundResponse.md)
106
- - [Daily::RoomRequest](docs/RoomRequest.md)
107
- - [Daily::RoomRequestProperties](docs/RoomRequestProperties.md)
108
- - [Daily::RoomResponse](docs/RoomResponse.md)
109
- - [Daily::ServerErrorResponse](docs/ServerErrorResponse.md)
110
-
107
+ - [Daily::MeetingTokenRequest](docs/MeetingTokenRequest.md)
108
+ - [Daily::MeetingTokenRequestProperties](docs/MeetingTokenRequestProperties.md)
109
+ - [Daily::MeetingTokenRequestPropertiesPermissions](docs/MeetingTokenRequestPropertiesPermissions.md)
110
+ - [Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin](docs/MeetingTokenRequestPropertiesPermissionsCanAdmin.md)
111
+ - [Daily::MeetingTokenRequestPropertiesPermissionsCanSend](docs/MeetingTokenRequestPropertiesPermissionsCanSend.md)
112
+ - [Daily::MeetingTokenResponse](docs/MeetingTokenResponse.md)
113
+ - [Daily::RoomDeletedResponse](docs/RoomDeletedResponse.md)
114
+ - [Daily::RoomNotFoundResponse](docs/RoomNotFoundResponse.md)
115
+ - [Daily::RoomRequest](docs/RoomRequest.md)
116
+ - [Daily::RoomRequestProperties](docs/RoomRequestProperties.md)
117
+ - [Daily::RoomResponse](docs/RoomResponse.md)
118
+ - [Daily::ServerErrorResponse](docs/ServerErrorResponse.md)
111
119
 
112
120
  ## Documentation for Authorization
113
121
 
114
-
115
122
  Authentication schemes defined for the API:
123
+
116
124
  ### bearerAuth
117
125
 
118
126
  - **Type**: Bearer authentication
119
-
data/daily-ruby.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  #The official library for communicating with the Daily REST API.
7
7
 
8
- The version of the OpenAPI document: 0.0.0
8
+ The version of the OpenAPI document: 0.0.2
9
9
 
10
10
  Generated by: https://openapi-generator.tech
11
11
  OpenAPI Generator version: 7.3.0
data/daily.yaml CHANGED
@@ -4,7 +4,7 @@ servers:
4
4
  info:
5
5
  description: >-
6
6
  The official library for communicating with the Daily REST API.
7
- version: 0.0.0
7
+ version: 0.0.2
8
8
  title: Daily
9
9
  license:
10
10
  name: Apache-2.0
@@ -18,11 +18,12 @@ paths:
18
18
  tags:
19
19
  - room
20
20
  summary: Create a new room
21
- description: "A POST request to /rooms creates a new room."
21
+ description: >
22
+ Creates a new meeting room. The name of the room, privacy settings, and other properties can be specified in the request body.
22
23
  operationId: createRoom
23
24
  responses:
24
25
  "200":
25
- description: successful operation
26
+ description: Room created successfully. The response includes the details of the created room.
26
27
  content:
27
28
  application/json:
28
29
  schema:
@@ -32,7 +33,7 @@ paths:
32
33
  "401":
33
34
  $ref: "#/components/responses/UnauthorizedError"
34
35
  "405":
35
- description: Invalid input
36
+ description: Invalid input. This usually means that the request body is missing or malformed.
36
37
  "429":
37
38
  $ref: "#/components/responses/TooManyRequestsError"
38
39
  security:
@@ -86,6 +87,45 @@ paths:
86
87
  security:
87
88
  - bearerAuth: []
88
89
  "/rooms/{name}":
90
+ get:
91
+ tags:
92
+ - room
93
+ summary: Get room
94
+ description: Get a Daily room.
95
+ operationId: getRoom
96
+ parameters:
97
+ - name: name
98
+ in: path
99
+ description: The room name that needs to be fetched
100
+ required: true
101
+ schema:
102
+ type: string
103
+ responses:
104
+ "200":
105
+ description: Room fetched successfully
106
+ content:
107
+ application/json:
108
+ schema:
109
+ $ref: "#/components/schemas/RoomResponse"
110
+ "404":
111
+ description: Room not found
112
+ content:
113
+ application/json:
114
+ schema:
115
+ title: Room not found response
116
+ description: Room not found response
117
+ type: object
118
+ properties:
119
+ error:
120
+ type: string
121
+ info:
122
+ type: string
123
+ "429":
124
+ $ref: "#/components/responses/TooManyRequestsError"
125
+ "500":
126
+ $ref: "#/components/responses/ServerError"
127
+ security:
128
+ - bearerAuth: []
89
129
  delete:
90
130
  tags:
91
131
  - room
@@ -129,17 +169,7 @@ paths:
129
169
  "429":
130
170
  $ref: "#/components/responses/TooManyRequestsError"
131
171
  "500":
132
- description: Server error
133
- content:
134
- application/json:
135
- schema:
136
- title: Server error response
137
- description: Server error response
138
- type: object
139
- properties:
140
- error:
141
- type: string
142
-
172
+ $ref: "#/components/responses/ServerError"
143
173
  security:
144
174
  - bearerAuth: []
145
175
  /meeting-tokens:
@@ -147,43 +177,30 @@ paths:
147
177
  tags:
148
178
  - meeting-tokens
149
179
  summary: Creates a meeting token
150
- description: "A POST request to /meeting-tokens creates a new meeting token."
180
+ description: >
181
+ A POST request to /meeting-tokens creates a new meeting token. This token can be used to authenticate a user for a specific meeting.
151
182
  operationId: createMeetingToken
152
183
  responses:
153
184
  "200":
154
- description: successful operation
185
+ description: Meeting token created successfully. The response includes the JWT token.
155
186
  content:
156
187
  application/json:
157
188
  schema:
158
- type: object
159
- properties:
160
- token:
161
- type: string
162
- format: jwt
189
+ $ref: "#/components/schemas/MeetingTokenResponse"
163
190
  "400":
164
191
  $ref: "#/components/responses/InvalidRequest"
165
192
  "401":
166
193
  $ref: "#/components/responses/UnauthorizedError"
167
194
  "405":
168
- description: Invalid input
195
+ description: Invalid input. This usually means that the request body is missing or malformed.
169
196
  "429":
170
197
  $ref: "#/components/responses/TooManyRequestsError"
171
198
  "500":
172
- description: Server error
173
- content:
174
- application/json:
175
- schema:
176
- title: Server error response
177
- description: Server error response
178
- type: object
179
- properties:
180
- error:
181
- type: string
199
+ $ref: "#/components/responses/ServerError"
182
200
  security:
183
201
  - bearerAuth: []
184
202
  requestBody:
185
203
  $ref: "#/components/requestBodies/MeetingTokenRequest"
186
-
187
204
  externalDocs:
188
205
  description: Find out more about Daily
189
206
  url: "https://docs.daily.co/reference"
@@ -412,6 +429,15 @@ components:
412
429
  - type: boolean
413
430
  required:
414
431
  - room_name
432
+ MeetingTokenResponse:
433
+ title: Meeting token response
434
+ description: Meeting token response
435
+ type: object
436
+ properties:
437
+ token:
438
+ type: string
439
+ format: jwt
440
+ description: The JWT token for the meeting.
415
441
 
416
442
  responses:
417
443
  UnauthorizedError:
@@ -420,3 +446,15 @@ components:
420
446
  description: Too many requests
421
447
  InvalidRequest:
422
448
  description: Invalid request
449
+ ServerError:
450
+ description: Server error.
451
+ content:
452
+ application/json:
453
+ schema:
454
+ title: Server error response
455
+ description: Details about the server error.
456
+ type: object
457
+ properties:
458
+ error:
459
+ type: string
460
+ description: A message describing the server error.
@@ -1,17 +1,17 @@
1
- # Daily::CreateMeetingToken200Response
1
+ # Daily::MeetingTokenResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **token** | **String** | | [optional] |
7
+ | **token** | **String** | The JWT token for the meeting. | [optional] |
8
8
 
9
9
  ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'daily-ruby'
13
13
 
14
- instance = Daily::CreateMeetingToken200Response.new(
14
+ instance = Daily::MeetingTokenResponse.new(
15
15
  token: null
16
16
  )
17
17
  ```
@@ -9,11 +9,11 @@ All URIs are relative to *https://api.daily.co/v1*
9
9
 
10
10
  ## create_meeting_token
11
11
 
12
- > <CreateMeetingToken200Response> create_meeting_token(opts)
12
+ > <MeetingTokenResponse> create_meeting_token(opts)
13
13
 
14
14
  Creates a meeting token
15
15
 
16
- A POST request to /meeting-tokens creates a new meeting token.
16
+ A POST request to /meeting-tokens creates a new meeting token. This token can be used to authenticate a user for a specific meeting.
17
17
 
18
18
  ### Examples
19
19
 
@@ -44,7 +44,7 @@ end
44
44
 
45
45
  This returns an Array which contains the response data, status code and headers.
46
46
 
47
- > <Array(<CreateMeetingToken200Response>, Integer, Hash)> create_meeting_token_with_http_info(opts)
47
+ > <Array(<MeetingTokenResponse>, Integer, Hash)> create_meeting_token_with_http_info(opts)
48
48
 
49
49
  ```ruby
50
50
  begin
@@ -52,7 +52,7 @@ begin
52
52
  data, status_code, headers = api_instance.create_meeting_token_with_http_info(opts)
53
53
  p status_code # => 2xx
54
54
  p headers # => { ... }
55
- p data # => <CreateMeetingToken200Response>
55
+ p data # => <MeetingTokenResponse>
56
56
  rescue Daily::ApiError => e
57
57
  puts "Error when calling MeetingTokensApi->create_meeting_token_with_http_info: #{e}"
58
58
  end
@@ -66,7 +66,7 @@ end
66
66
 
67
67
  ### Return type
68
68
 
69
- [**CreateMeetingToken200Response**](CreateMeetingToken200Response.md)
69
+ [**MeetingTokenResponse**](MeetingTokenResponse.md)
70
70
 
71
71
  ### Authorization
72
72
 
data/docs/RoomApi.md CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.daily.co/v1*
6
6
  | ------ | ------------ | ----------- |
7
7
  | [**create_room**](RoomApi.md#create_room) | **POST** /rooms | Create a new room |
8
8
  | [**delete_room**](RoomApi.md#delete_room) | **DELETE** /rooms/{name} | Delete room |
9
+ | [**get_room**](RoomApi.md#get_room) | **GET** /rooms/{name} | Get room |
9
10
  | [**get_rooms**](RoomApi.md#get_rooms) | **GET** /rooms | Get a list rooms |
10
11
 
11
12
 
@@ -15,7 +16,7 @@ All URIs are relative to *https://api.daily.co/v1*
15
16
 
16
17
  Create a new room
17
18
 
18
- A POST request to /rooms creates a new room.
19
+ Creates a new meeting room. The name of the room, privacy settings, and other properties can be specified in the request body.
19
20
 
20
21
  ### Examples
21
22
 
@@ -149,6 +150,75 @@ end
149
150
  - **Accept**: application/json
150
151
 
151
152
 
153
+ ## get_room
154
+
155
+ > <RoomResponse> get_room(name)
156
+
157
+ Get room
158
+
159
+ Get a Daily room.
160
+
161
+ ### Examples
162
+
163
+ ```ruby
164
+ require 'time'
165
+ require 'daily-ruby'
166
+ # setup authorization
167
+ Daily.configure do |config|
168
+ # Configure Bearer authorization: bearerAuth
169
+ config.access_token = 'YOUR_BEARER_TOKEN'
170
+ end
171
+
172
+ api_instance = Daily::RoomApi.new
173
+ name = 'name_example' # String | The room name that needs to be fetched
174
+
175
+ begin
176
+ # Get room
177
+ result = api_instance.get_room(name)
178
+ p result
179
+ rescue Daily::ApiError => e
180
+ puts "Error when calling RoomApi->get_room: #{e}"
181
+ end
182
+ ```
183
+
184
+ #### Using the get_room_with_http_info variant
185
+
186
+ This returns an Array which contains the response data, status code and headers.
187
+
188
+ > <Array(<RoomResponse>, Integer, Hash)> get_room_with_http_info(name)
189
+
190
+ ```ruby
191
+ begin
192
+ # Get room
193
+ data, status_code, headers = api_instance.get_room_with_http_info(name)
194
+ p status_code # => 2xx
195
+ p headers # => { ... }
196
+ p data # => <RoomResponse>
197
+ rescue Daily::ApiError => e
198
+ puts "Error when calling RoomApi->get_room_with_http_info: #{e}"
199
+ end
200
+ ```
201
+
202
+ ### Parameters
203
+
204
+ | Name | Type | Description | Notes |
205
+ | ---- | ---- | ----------- | ----- |
206
+ | **name** | **String** | The room name that needs to be fetched | |
207
+
208
+ ### Return type
209
+
210
+ [**RoomResponse**](RoomResponse.md)
211
+
212
+ ### Authorization
213
+
214
+ [bearerAuth](../README.md#bearerAuth)
215
+
216
+ ### HTTP request headers
217
+
218
+ - **Content-Type**: Not defined
219
+ - **Accept**: application/json
220
+
221
+
152
222
  ## get_rooms
153
223
 
154
224
  > <Array<RoomResponse>> get_rooms(opts)
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **error** | **String** | | [optional] |
7
+ | **error** | **String** | A message describing the server error. | [optional] |
8
8
 
9
9
  ## Example
10
10
 
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The official library for communicating with the Daily REST API.
5
5
 
6
- The version of the OpenAPI document: 0.0.0
6
+ The version of the OpenAPI document: 0.0.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 7.3.0
@@ -20,20 +20,20 @@ module Daily
20
20
  @api_client = api_client
21
21
  end
22
22
  # Creates a meeting token
23
- # A POST request to /meeting-tokens creates a new meeting token.
23
+ # A POST request to /meeting-tokens creates a new meeting token. This token can be used to authenticate a user for a specific meeting.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [MeetingTokenRequest] :meeting_token_request A room object
26
- # @return [CreateMeetingToken200Response]
26
+ # @return [MeetingTokenResponse]
27
27
  def create_meeting_token(opts = {})
28
28
  data, _status_code, _headers = create_meeting_token_with_http_info(opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Creates a meeting token
33
- # A POST request to /meeting-tokens creates a new meeting token.
33
+ # A POST request to /meeting-tokens creates a new meeting token. This token can be used to authenticate a user for a specific meeting.
34
34
  # @param [Hash] opts the optional parameters
35
35
  # @option opts [MeetingTokenRequest] :meeting_token_request A room object
36
- # @return [Array<(CreateMeetingToken200Response, Integer, Hash)>] CreateMeetingToken200Response data, response status code and response headers
36
+ # @return [Array<(MeetingTokenResponse, Integer, Hash)>] MeetingTokenResponse data, response status code and response headers
37
37
  def create_meeting_token_with_http_info(opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: MeetingTokensApi.create_meeting_token ...'
@@ -61,7 +61,7 @@ module Daily
61
61
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'meeting_token_request'])
62
62
 
63
63
  # return_type
64
- return_type = opts[:debug_return_type] || 'CreateMeetingToken200Response'
64
+ return_type = opts[:debug_return_type] || 'MeetingTokenResponse'
65
65
 
66
66
  # auth_names
67
67
  auth_names = opts[:debug_auth_names] || ['bearerAuth']