Project

daily-ruby

0.0
The project is in a healthy, maintained state
The official Daily API Ruby client for Daily's REST API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 3.6, >= 3.6.0

Runtime

>= 0
>= 1.0.1, < 3.0
 Project Readme

daily-ruby

Daily - the Ruby gem for the Daily API

The Daily REST API offers the ability to manage the following:

  • Overall Domain Configuration
  • Individual Room creation and config management
  • Meeting token creation and validation
  • Recording and compositing management
  • Meeting analytics
  • Logs and metrics
  • Real-time presence

Please reach out to help@daily.co if we can help with anything

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.1
  • Package version: 1.0.5
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://docs.daily.co

Installation

Build a gem

To build the Ruby code into a gem:

gem build daily-ruby.gemspec

Then either install the gem locally:

gem install ./daily-ruby-1.0.5.gem

(for development, run gem install --dev ./daily-ruby-1.0.5.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'daily-ruby', '~> 1.0.5'

Install from Git

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:

gem 'daily-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
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'
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = Daily::BatchRoomsApi.new
opts = {
  batch_room_create_request: Daily::BatchRoomCreateRequest.new # BatchRoomCreateRequest |
}

begin
  #/batch/rooms
  result = api_instance.batch_room_create(opts)
  p result
rescue Daily::ApiError => e
  puts "Exception when calling BatchRoomsApi->batch_room_create: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.daily.co/v1

Class Method HTTP request Description
Daily::BatchRoomsApi batch_room_create POST /batch/rooms /batch/rooms
Daily::BatchRoomsApi batch_room_delete DELETE /batch/rooms /batch/rooms
Daily::DialinApi pinless_call_update POST /dialin/pinlessCallUpdate /dialin/pinlessCallUpdate
Daily::DomainApi get_domain_config GET / Get domain configuration
Daily::DomainApi set_domain_config POST / Set domain configuration
Daily::LogsApi list_api_logs GET /logs/api /logs/api
Daily::LogsApi list_logs GET /logs /logs
Daily::MeetingTokensApi create_meeting_token POST /meeting-tokens meeting-tokens
Daily::MeetingTokensApi validate_meeting_token GET /meeting-tokens/{meeting_token} meeting-tokens/:meeting_token
Daily::MeetingsApi get_individual_meeting_info GET /meetings/{meeting} /meetings/:meeting
Daily::MeetingsApi get_meeting_info GET /meetings /meetings
Daily::MeetingsApi get_meeting_participants GET /meetings/{meeting}/participants /meetings/:meeting/participants
Daily::PhoneNumbersApi buy_phone_number POST /buy-phone-number /buy-phone-number
Daily::PhoneNumbersApi list_available_numbers GET /list-available-numbers /list-available-numbers
Daily::PhoneNumbersApi purchased_phone_nunbers GET /purchased-phone-numbers /purchased-phone-numbers
Daily::PhoneNumbersApi release_phone_number DELETE /release-phone-number/{id} release-phone-number/:id
Daily::PresenceApi get_presence GET /presence /presence
Daily::RecordingsApi delete_recording DELETE /recordings/{recording_id} recordings/:id
Daily::RecordingsApi get_recording_info GET /recordings/{recording_id} recordings/:id
Daily::RecordingsApi get_recording_link GET /recordings/{recording_id}/access-link recordings/:id/access-link
Daily::RecordingsApi list_recordings GET /recordings /recordings
Daily::RoomsApi create_room POST /rooms /rooms
Daily::RoomsApi delete_room DELETE /rooms/{room_name} rooms/:name
Daily::RoomsApi eject POST /rooms/{room_name}/eject rooms/:name/eject
Daily::RoomsApi get_room_config GET /rooms/{room_name} rooms/:name
Daily::RoomsApi get_room_presence GET /rooms/{room_name}/presence rooms/:name/presence
Daily::RoomsApi get_session_data GET /rooms/{room_name}/get-session-data rooms/:name/get-session-data
Daily::RoomsApi list_rooms GET /rooms /rooms
Daily::RoomsApi room_dial_out_send_dtmf POST /rooms/{room_name}/dialOut/sendDTMF rooms/:name/dialOut/sendDTMF
Daily::RoomsApi room_dial_out_start POST /rooms/{room_name}/dialOut/start rooms/:name/dialOut/start
Daily::RoomsApi room_dial_out_stop POST /rooms/{room_name}/dialOut/stop rooms/:name/dialOut/stop
Daily::RoomsApi room_livestreaming_start POST /rooms/{room_name}/live-streaming/start rooms/:name/live-streaming/start
Daily::RoomsApi room_livestreaming_stop POST /rooms/{room_name}/live-streaming/stop rooms/:name/live-streaming/stop
Daily::RoomsApi room_livestreaming_update POST /rooms/{room_name}/live-streaming/update rooms/:name/live-streaming/update
Daily::RoomsApi room_recordings_start POST /rooms/{room_name}/recordings/start rooms/:name/recordings/start
Daily::RoomsApi room_recordings_stop POST /rooms/{room_name}/recordings/stop rooms/:name/recordings/stop
Daily::RoomsApi room_recordings_update POST /rooms/{room_name}/recordings/update rooms/:name/recordings/update
Daily::RoomsApi room_sip_call_transfer POST /rooms/{room_name}/sipCallTransfer rooms/:name/sipCallTransfer
Daily::RoomsApi room_sip_refer POST /rooms/{room_name}/sipRefer rooms/:name/sipRefer
Daily::RoomsApi room_transcription_start POST /rooms/{room_name}/transcription/start rooms/:name/transcription/start
Daily::RoomsApi room_transcription_stop POST /rooms/{room_name}/transcription/stop rooms/:name/transcription/stop
Daily::RoomsApi send_app_message POST /rooms/{room_name}/send-app-message rooms/:name/send-app-message
Daily::RoomsApi set_room_config POST /rooms/{room_name} rooms/:name
Daily::RoomsApi set_session_data POST /rooms/{room_name}/set-session-data rooms/:name/set-session-data
Daily::RoomsApi update_permissions POST /rooms/{room_name}/update-permissions rooms/:name/update-permissions
Daily::TranscriptApi delete_transcript DELETE /transcript/{transcriptId} transcript/:id
Daily::TranscriptApi get_transcript_info GET /transcript/{transcriptId} transcript/:transcriptId
Daily::TranscriptApi get_transcript_link GET /transcript/{transcriptId}/access-link transcript/:id/access-link
Daily::TranscriptApi list_transcript GET /transcript /transcript
Daily::WebhooksApi create_webhook POST /webhooks /webhooks
Daily::WebhooksApi delete_webhook DELETE /webhooks/{id} webhooks/:id
Daily::WebhooksApi get_webhook_config GET /webhooks/{id} webhooks/:id
Daily::WebhooksApi get_webhooks GET /webhooks /webhooks
Daily::WebhooksApi update_webhook_config POST /webhooks/{id} webhooks/:id

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

sec0

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header