daily-ruby 0.0.2 → 1.0.1

data/docs/MeetingsApi.md

@@ -0,0 +1,247 @@
+# Daily::MeetingsApi
+
+All URIs are relative to *https://api.daily.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_individual_meeting_info**](MeetingsApi.md#get_individual_meeting_info) | **GET** /meetings/{meeting} | /meetings/:meeting |
+| [**get_meeting_info**](MeetingsApi.md#get_meeting_info) | **GET** /meetings | /meetings |
+| [**get_meeting_participants**](MeetingsApi.md#get_meeting_participants) | **GET** /meetings/{meeting}/participants | /meetings/:meeting/participants |
+
+
+## get_individual_meeting_info
+
+> <MeetingsMeetingGetRes> get_individual_meeting_info(meeting)
+
+/meetings/:meeting
+
+retrieve info about a particular meeting
+
+### 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::MeetingsApi.new
+meeting = 'meeting_example' # String | the ID of the meeting session
+
+begin
+  # /meetings/:meeting
+  result = api_instance.get_individual_meeting_info(meeting)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling MeetingsApi->get_individual_meeting_info: #{e}"
+end
+```
+
+#### Using the get_individual_meeting_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeetingsMeetingGetRes>, Integer, Hash)> get_individual_meeting_info_with_http_info(meeting)
+
+```ruby
+begin
+  # /meetings/:meeting
+  data, status_code, headers = api_instance.get_individual_meeting_info_with_http_info(meeting)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeetingsMeetingGetRes>
+rescue Daily::ApiError => e
+  puts "Error when calling MeetingsApi->get_individual_meeting_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meeting** | **String** | the ID of the meeting session |  |
+
+### Return type
+
+[**MeetingsMeetingGetRes**](MeetingsMeetingGetRes.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_meeting_info
+
+> <GetMeetingInfo200Response> get_meeting_info(opts)
+
+/meetings
+
+retrieve meeting analytics
+
+### 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::MeetingsApi.new
+opts = {
+  room: 'room_example', # String | 
+  timeframe_start: 56, # Integer | 
+  timeframe_end: 56, # Integer | 
+  limit: 56, # Integer | 
+  starting_after: 'starting_after_example', # String | 
+  ending_before: 'ending_before_example', # String | 
+  ongoing: true, # Boolean | 
+  no_participants: true # Boolean | 
+}
+
+begin
+  # /meetings
+  result = api_instance.get_meeting_info(opts)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling MeetingsApi->get_meeting_info: #{e}"
+end
+```
+
+#### Using the get_meeting_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetMeetingInfo200Response>, Integer, Hash)> get_meeting_info_with_http_info(opts)
+
+```ruby
+begin
+  # /meetings
+  data, status_code, headers = api_instance.get_meeting_info_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetMeetingInfo200Response>
+rescue Daily::ApiError => e
+  puts "Error when calling MeetingsApi->get_meeting_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **room** | **String** |  | [optional] |
+| **timeframe_start** | **Integer** |  | [optional] |
+| **timeframe_end** | **Integer** |  | [optional] |
+| **limit** | **Integer** |  | [optional] |
+| **starting_after** | **String** |  | [optional] |
+| **ending_before** | **String** |  | [optional] |
+| **ongoing** | **Boolean** |  | [optional] |
+| **no_participants** | **Boolean** |  | [optional] |
+
+### Return type
+
+[**GetMeetingInfo200Response**](GetMeetingInfo200Response.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_meeting_participants
+
+> <MeetingParticipantsGetRes> get_meeting_participants(meeting, opts)
+
+/meetings/:meeting/participants
+
+retrieve info about the participants in a particular meeting
+
+### 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::MeetingsApi.new
+meeting = 'meeting_example' # String | the ID of the meeting session
+opts = {
+  limit: 56, # Integer | the largest number of participant records to return
+  joined_after: 'joined_after_example', # String | limit to participants who joined after the given participant, identified by `participant_id`
+  joined_before: 'joined_before_example' # String | limit to participants who joined before the given participant, identified by `participant_id`
+}
+
+begin
+  # /meetings/:meeting/participants
+  result = api_instance.get_meeting_participants(meeting, opts)
+  p result
+rescue Daily::ApiError => e
+  puts "Error when calling MeetingsApi->get_meeting_participants: #{e}"
+end
+```
+
+#### Using the get_meeting_participants_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeetingParticipantsGetRes>, Integer, Hash)> get_meeting_participants_with_http_info(meeting, opts)
+
+```ruby
+begin
+  # /meetings/:meeting/participants
+  data, status_code, headers = api_instance.get_meeting_participants_with_http_info(meeting, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeetingParticipantsGetRes>
+rescue Daily::ApiError => e
+  puts "Error when calling MeetingsApi->get_meeting_participants_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meeting** | **String** | the ID of the meeting session |  |
+| **limit** | **Integer** | the largest number of participant records to return | [optional] |
+| **joined_after** | **String** | limit to participants who joined after the given participant, identified by &#x60;participant_id&#x60; | [optional] |
+| **joined_before** | **String** | limit to participants who joined before the given participant, identified by &#x60;participant_id&#x60; | [optional] |
+
+### Return type
+
+[**MeetingParticipantsGetRes**](MeetingParticipantsGetRes.md)
+
+### Authorization
+
+[sec0](../README.md#sec0)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MeetingsMeetingGetRes.md

@@ -0,0 +1,28 @@
+# Daily::MeetingsMeetingGetRes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **room** | **String** |  | [optional] |
+| **start_time** | **Integer** |  | [optional] |
+| **duration** | **Integer** |  | [optional] |
+| **ongoing** | **Boolean** |  | [optional] |
+| **max_participants** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::MeetingsMeetingGetRes.new(
+  id: d61cd7b2-a273-42b4-89bd-be763fd562c1,
+  room: room-name,
+  start_time: 1672606399,
+  duration: 2055,
+  ongoing: false,
+  max_participants: 4
+)
+```
+

data/docs/ParticipantJoined.md

@@ -0,0 +1,24 @@
+# Daily::ParticipantJoined
+
+## 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** | **Float** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
+| **payload** | [**ParticipantJoinedPayload**](ParticipantJoinedPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::ParticipantJoined.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/ParticipantJoinedPayload.md

@@ -0,0 +1,32 @@
+# Daily::ParticipantJoinedPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **joined_at** | **Float** | The Unix epoch time in seconds representing when the participant joined. | [optional] |
+| **session_id** | **String** | The user session ID, or participant id. | [optional] |
+| **room** | **String** | The name of the room. | [optional] |
+| **user_id** | **String** | The ID of the user, set by the meeting token. | [optional] |
+| **user_name** | **String** | The name of the user, set by the meeting token. | [optional] |
+| **owner** | **Boolean** | A flag determining if this user is considered the owner. | [optional] |
+| **will_eject_at** | **Float** | The Unix epoch time in seconds representing when the participant will be ejected. | [optional] |
+| **permissions** | [**ParticipantJoinedPayloadPermissions**](ParticipantJoinedPayloadPermissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::ParticipantJoinedPayload.new(
+  joined_at: null,
+  session_id: null,
+  room: null,
+  user_id: null,
+  user_name: null,
+  owner: null,
+  will_eject_at: null,
+  permissions: null
+)
+```
+

data/docs/ParticipantJoinedPayloadPermissions.md

@@ -0,0 +1,22 @@
+# Daily::ParticipantJoinedPayloadPermissions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_presence** | **Boolean** | Determines whether the participant is \"present\" or \"hidden\" | [optional] |
+| **can_send** | **Array<String>** | Array of strings identifying which types of media the participant can send or a boolean to grant/revoke permissions for all media types. | [optional] |
+| **can_admin** | **Array<String>** | Array of strings identifying which types of admin tasks the participant can do or a boolean to grant/revoke permissions for all types. | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::ParticipantJoinedPayloadPermissions.new(
+  has_presence: null,
+  can_send: null,
+  can_admin: null
+)
+```
+

data/docs/ParticipantLeft.md

@@ -0,0 +1,24 @@
+# Daily::ParticipantLeft
+
+## 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** | **Float** | The Unix epoch time in seconds representing when the event was generated. | [optional] |
+| **payload** | [**ParticipantLeftPayload**](ParticipantLeftPayload.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::ParticipantLeft.new(
+  version: null,
+  type: null,
+  event_ts: null,
+  payload: null
+)
+```
+

data/docs/ParticipantLeftPayload.md

@@ -0,0 +1,34 @@
+# Daily::ParticipantLeftPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **joined_at** | **Float** | The Unix epoch time in seconds representing when the participant joined. | [optional] |
+| **duration** | **Float** | The time in seconds representing how long the participant was in the call. | [optional] |
+| **session_id** | **String** | The user session ID, or participant id. | [optional] |
+| **room** | **String** | The name of the room. | [optional] |
+| **user_id** | **String** | The ID of the user, set by the meeting token. | [optional] |
+| **user_name** | **String** | The name of the user, set by the meeting token. | [optional] |
+| **owner** | **Boolean** | A flag determining if this user is considered the owner. | [optional] |
+| **will_eject_at** | **Float** | The Unix epoch time in seconds representing when the participant will be ejected. | [optional] |
+| **permissions** | [**ParticipantJoinedPayloadPermissions**](ParticipantJoinedPayloadPermissions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::ParticipantLeftPayload.new(
+  joined_at: null,
+  duration: null,
+  session_id: null,
+  room: null,
+  user_id: null,
+  user_name: null,
+  owner: null,
+  will_eject_at: null,
+  permissions: null
+)
+```
+

data/docs/Permissions.md

@@ -0,0 +1,22 @@
+# Daily::Permissions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **has_presence** | **Boolean** | Whether the participant appears as \"present\" in the call, i.e. whether they appear in [`participants()`](/reference/daily-js/instance-methods/participants#main). | [optional] |
+| **can_send** | [**PermissionsCanSend**](PermissionsCanSend.md) |  | [optional] |
+| **can_admin** | [**PermissionsCanAdmin**](PermissionsCanAdmin.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'daily-ruby'
+
+instance = Daily::Permissions.new(
+  has_presence: null,
+  can_send: null,
+  can_admin: null
+)
+```
+

data/docs/{MeetingTokenRequestPropertiesPermissionsCanSend.md → PermissionsCanAdmin.md}

@@ -1,4 +1,4 @@
-# Daily::MeetingTokenRequestPropertiesPermissionsCanSend
+# Daily::PermissionsCanAdmin
 
 ## Class instance methods
 
@@ -11,7 +11,7 @@ Returns the list of classes defined in oneOf.
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanSend.openapi_one_of
+Daily::PermissionsCanAdmin.openapi_one_of
 # =>
 # [
 #   :'Array<String>',
@@ -28,10 +28,10 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanSend.build(data)
+Daily::PermissionsCanAdmin.build(data)
 # => #<Array<String>:0x00007fdd4aab02a0>
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanSend.build(data_that_doesnt_match)
+Daily::PermissionsCanAdmin.build(data_that_doesnt_match)
 # => nil
 ```
 

data/docs/{MeetingTokenRequestPropertiesPermissionsCanAdmin.md → PermissionsCanSend.md}

@@ -1,4 +1,4 @@
-# Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin
+# Daily::PermissionsCanSend
 
 ## Class instance methods
 
@@ -11,7 +11,7 @@ Returns the list of classes defined in oneOf.
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.openapi_one_of
+Daily::PermissionsCanSend.openapi_one_of
 # =>
 # [
 #   :'Array<String>',
@@ -28,10 +28,10 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
 ```ruby
 require 'daily-ruby'
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.build(data)
+Daily::PermissionsCanSend.build(data)
 # => #<Array<String>:0x00007fdd4aab02a0>
 
-Daily::MeetingTokenRequestPropertiesPermissionsCanAdmin.build(data_that_doesnt_match)
+Daily::PermissionsCanSend.build(data_that_doesnt_match)
 # => nil
 ```