/dyte

A Ruby wrapper for version 2 of the Dyte API.

Primary LanguageRubyMIT LicenseMIT

Dyte

A gem that wraps v2 of the Dyte API to make it easy to use in Ruby applications. Please note that some resources are not yet implemented. This is due to the fact that v2 of the Dyte API is incomplete. Once the Dyte team has finalized the response structure the remaining resources will be implemented. In order to obtain access to v2 of the Dyte API please contact the Dyte team.

Issues and pull requests are welcome! ❤️

Installation

Add this line to your application's Gemfile:

gem 'dyte'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install dyte

Usage

TODO: Write usage instructions here

Resources

Meetings

# Returns all meetings in an organization.
client.meetings.list

# Returns a meeting in an organization for the given meeting ID.
client.meetings.fetch(meeting_id: "id")

# Creates a meeting in an organization.
client.meetings.create({})

# Updates a meeting in an organization for the given meeting ID.
client.meetings.update(meeting_id: "id", {})

# Regenerates participant's authentication token for the given meeting and participant ID.
client.meetings.regenerate_token(meeting_id: "id", participant_id: "id")

# Returns all participants for the given meeting ID.
client.meetings.fetch_participants(meeting_id: "id") 

# Returns a participant for the given meeting and participant ID.
client.meetings.fetch_participant_details(meeting_id: "id", participant_id: "id")

# Edits a participant for the given meeting and participant ID.
client.meetings.edit_participant_details(meeting_id: "id", participant_id: "id")

Presets

client.presets.list
client.presets.fetch(preset_id: "id")
client.presets.create({})
client.presets.update(preset_id: "id", {})

Sessions

client.sessions.list
client.sessions.fetch(session_id: "id")
client.sessions.fetch_participants(session_id: "id")
client.sessions.participant_details(session_id: "id", participant_id: "id")
client.sessions.chat_messages(session_id: "id")

Participants

Development

After checking out the repo run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Contribution guidelines TBD. For now just open a PR and we'll figure it out.

License

The gem is available as open source under the terms of the MIT License.