Zoomify Gem

Wrapper for Zoom API V2

Installation

Add this line to your application's Gemfile:

gem 'zoomify'

And then execute:

$ bundle

Or install it yourself as:

$ gem install zoomify

Usage

Initialize Zoom client in your app

client = Zoomify::Client.new(api_key: 'your_api_key', api_secret: 'your_api_secret')

Accounts

List all sub accounts

accounts = client.accounts

Additional parameters can be passed as

accounts = client.accounts(page_size: 5, page_number: 3)

Create a sub account (params can be found here)

account = client.accounts_create(params)

Retrieve a sub account

account = client.account(id: 'account id')

Disassociate an account

account = client.accounts_delete(id: 'account id')

Update a sub account's options (params can be found here)

account = client.accounts_update_options(id: 'account id', share_rc: true, share_mc: true)

Retrieve a sub account's settings

account = client.accounts_settings(id: 'account id')

Update a sub account's settings (params can be found here)

account = client.accounts_settings_update(id: 'account id', schedule_meting: {host_video: true})

Billing

Retrieve billing information for a sub account

billing = client.billing(id: 'account id')

Update billing information for a sub account (params can be found here)

billing = client.billing_update(id: 'account id', first_name: 'John Doe')

Retrieve plan information for a sub account

plan = client.plan(id: 'account id')

Subscribe plans for a sub account (params can be found here)

plan = client.plan_subscribe(id: 'account id', contact: {first_name: 'John Doe'})

Update a plan base for a sub account (params can be found here)

plan_base = client.update_base_plan(id: 'account id', type: 'string', hosts: 1)

Add an additional plan for a sub account (params can be found here)

addon = client.create_addon(id: 'account id', type: 'string', hosts: 1)

Update an additional plan for a sub account (params can be found here)

addon = client.update_addon(id: 'account id', type: 'string', hosts: 1)

Users

List Users (optional params can be found here here)

users = client.users

Create a user (params can be found here here)

user = client.user_create(params)

Retrieve a user (params can be found here here)

user = client.user(id: 'user id')

Update a user (params can be found here here)

user = client.user_update(id: 'user id', first_name: 'John Doe')

Delete a user (optional params can be found here)

user = client.user_delete(id: 'user id')

List a user's assistants

assistants = client.user_assistants(id: 'user id')

Add assistants (params can be found here)

assistant = client.user_assistants_create(id: 'user id', assistants: [{id: 'string', email: 'string'}])

Delete all assistants of a user

assistant = client.user_assistants_delete_all(id: 'user id')

Delete a user's assistant

assistant = client.user_assistant_delete(id: 'user id', assistant_id: 'assistant id')

List a user's schedulers

schedulers = client.user_schedulers(id: 'user id')

Delete all schedulers of a users

schedulers = client.user_schedulers_delete_all(id: 'user id')

Delete a user's scheduler

scheduler = client.user_schedulers_delete(id: 'user id', scheduler_id: 'scheduler id')

Upload a user's picture (information about params can be found here)

picture = client.upload_picture(id: 'user id', pic_file: 'file')

Retrieve a user's settings

settings = client.user_settings(id: 'user id')

Update a user's settings (params can be found here)

settings = client.user_settings_update(id: 'user id', scheduled_meeting: { host_video: true })

Update a user's status (params can be found here)

status = client.user_status_update(id: 'user id', action: 'active')

Update a user's password (params can be found here)

password = client.user_password_update(id: 'user id', password: 'ABCXYZ')

Retrieve a user's permissions

permissions = client.user_permissions(id: 'user id')

Retrieve a user's token (optional params can be found here)

token = client.user_token(id: 'user id')

Revoke a user's SSO Token

token = client.user_token_delete(id: 'user id')

Verify a user's zpk (Deprecated)

zpk = client.verify_zpk(zpk: 'User zpk')

Verify a user's email

email = client.verify_email(email: 'User email')

Check a user's personal meeting room name

vanity_name = client.verify_vanity_name(vanity_name: 'User Vanity Name')

Meetings

List meetings (optional params can be found here)

meetings = client.meetings(id: 'user id')

Create a meeting (params can be found here)

meeting = client.meetings_create(id: 'user_id', topic: 'Zoomify Gem')

Retrieve a meeting

meeting = client.meeting(id: 'meeting id')

Update a meeting (params can be found here)

meeting = client.meeting_update(id: 'meeting id', topic: 'Zoomify Gem')

Delete a meeting (optional params can be found here)

meeting = client.meeting_delete(id: 'meeting id')

Update a meeting's status (params can be found here)

status = client.meeting_update_status(id: 'meeting id', action: 'end')

List a meeting's registrants (optional params can be found here)

registrants = client.meeting_registrants(id: 'meeting id')

Add a meeting registrant (params can be found here)

registrant = client.meeting_registrants_create(id: 'meeting id', email: 'johndoe@email.com', first_name: 'John', last_name: 'Doe')

Update a meeting registrant's status (params can be found here)

status = client.meeting_registrants_update_status(id: 'meeting id', action: 'approve')

Retrieve past meeting details

past_meeting = client.past_meeting(uuid: 'meeting uuid')

Retrieve past meeting participants (optional params can be found here)

participants = client.past_meeting_participants(uuid: 'meeting uuid')

Webinars

List webinars (optional params can be found here)

webinars = client.webinars(id: 'user id')

Create a webinar (params can be found here)

webinar = client.webinar_create(id: 'user_id', topic: 'Zoomify Gem')

Retrieve a webinar

webinar = client.webinar(id: 'webinar id')

Update a webinar (params can be found here)

webinar = client.webinar_update(id: 'webinar id', topic: 'Zoomify Gem')

Delete a webinar (optional params can be found here)

webinar = client.webinar_delete(id: 'webinar id')

Update a webinar's status (params can be found here)

status = client.webinar_update_status(id: 'webinar id', status: 'end')

List a webinar's panelists

panelists = client.webinar_panelists(id: 'webinar id')

Add a webinar penelist (params can be found here)

panelist = client.webinar_panelists_create(id: 'webinar id', panelists: [{name: 'string', email: string}])

Remove all panelists from webinar

panelists = client.webinar_panelists_delete_all(id: 'webinar id')

Remove a webinar panelist

panelist = client.webinar_panelists_delete(id: 'webinar id', panelist_id: 'panelist id')

List a webinar's registrants (optional params can be found here)

registrants = client.webinar_registrants(id: 'webinar id') 

Add a webinar registrant (params can be found here)

registrant = client.webinar_registrants_create(id: 'webinar_id', email: 'johndoe@email.com', first_name: 'John', last_name: 'Doe')

Update a webinar registrant's status (params can be found here)

status = client.webinar_registrants_update_status(id: 'webinar id', action: 'approve')

List of ended webinar instances

webinars = client.past_webinars(id: 'webinar id')

Groups

List groups

groups = client.g