❤
npm
Sign UpSign In

bluejeans-api-rest-onvideo

1.0.0 • Public • Published

bluejeans-api-rest-onvideo

BlueJeansOnVideoRestApi - JavaScript client for bluejeans-api-rest-onvideo

Video That Works Where You Do.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://bluejeans.com/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install bluejeans-api-rest-onvideo --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your bluejeans-api-rest-onvideo from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('bluejeans-api-rest-onvideo') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/bluejeans/api-rest-onvideo#npm-repo then install it via:

    npm install bluejeans/api-rest-onvideo#npm-repo --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var BlueJeansOnVideoRestApi = require('bluejeans-api-rest-onvideo');

var defaultClient = BlueJeansOnVideoRestApi.ApiClient.instance;

// Configure API key authorization: access_token
var access_token = defaultClient.authentications['access_token'];
access_token.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//access_token.apiKeyPrefix['access_token'] = "Token"

var api = new BlueJeansOnVideoRestApi.ApplicationApi()

var userId = 56; // {Number} The ID of the user of interest. This value is an integer which can be retrieved for the current user via the Get User Account Details endpoint.

var application = new BlueJeansOnVideoRestApi.Application(); // {Application} The information about the new client application.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createClientApplication(userId, application, callback);

Documentation for API Endpoints

All URIs are relative to https://api.bluejeans.com

Class Method HTTP request Description
BlueJeansOnVideoRestApi.ApplicationApi createClientApplication POST /v1/user/{user_id}/developer_applications Create Client Application
BlueJeansOnVideoRestApi.ApplicationApi regenerateClientApplicationSecret PUT /v1/user/{user_id}/developer_applications/{client_id}/secret Regenerate Client Application Secret
BlueJeansOnVideoRestApi.ApplicationApi updateClientApplication PUT /v1/user/{user_id}/developer_applications/{client_id} Update Client Application
BlueJeansOnVideoRestApi.AuthenticationApi getAuthorizationCode GET /oauth2/authorize Get Authorization Code
BlueJeansOnVideoRestApi.AuthenticationApi getTokenByClient POST /oauth2/token?Client Authentication via Client Grant Type
BlueJeansOnVideoRestApi.AuthenticationApi getTokenByCode POST /oauth2/token?Code Authentication via Code Grant Type
BlueJeansOnVideoRestApi.AuthenticationApi getTokenByMeeting POST /oauth2/token?Meeting Authentication via Meeting Grant Type
BlueJeansOnVideoRestApi.AuthenticationApi getTokenByPassword POST /oauth2/token?Password Authentication via Password Grant Type
BlueJeansOnVideoRestApi.AuthenticationApi getTokenByRefresh POST /oauth2/token?Refresh Authentication via Refresh Grant Type
BlueJeansOnVideoRestApi.AuthenticationApi getTokenInfo GET /oauth2/tokenInfo Validate a Token
BlueJeansOnVideoRestApi.AuthenticationApi revokeAccessToken DELETE /oauth2/token?Revoke Revoke Access Token
BlueJeansOnVideoRestApi.CommandCenterApi getEndpointDistribution GET /v1/enterprise/{enterprise_id}/indigo/analytics/endpoints/distribution Endpoint Distribution
BlueJeansOnVideoRestApi.CommandCenterApi getFeedbackComments GET /v1/enterprise/{enterprise_id}/indigo/analytics/feedback/comments Survey Feedback Comments
BlueJeansOnVideoRestApi.CommandCenterApi getFeedbackCount GET /v1/enterprise/{enterprise_id}/indigo/feedback/count Survey Feedback Scores
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingLiveByEnterprise GET /v1/enterprise/{enterprise_id}/indigo/meetings/live/{meeting_uuid}/endpoints/ List Live Meeting Endpoints by Enterprise
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingPastByEnterprise GET /v1/enterprise/{enterprise_id}/indigo/meetings/{meeting_uuid} List Meeting Endpoints & Stats by Enterprise
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingPastByUser GET /v1/user/{user_id}/indigo/meetings/{meeting_uuid} List Meeting Endpoints & Stats by User
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingUsage GET /v1/enterprise/{enterprise_id}/indigo/analytics/meetings/usage Meeting Usage Over Time
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingsLiveByEnterprise GET /v1/enterprise/{enterprise_id}/indigo/meetings/live Live Meetings Summary by Enterprise
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingsPastByEnterprise GET /v1/enterprise/{enterprise_id}/indigo/meetings List Past Meetings by Enterprise
BlueJeansOnVideoRestApi.CommandCenterApi getMeetingsPastByUser GET /v1/user/{user_id}/indigo/meetings List Past Meetings by User
BlueJeansOnVideoRestApi.CommandCenterApi getRoiRanges GET /v1/enterprise/{enterprise_id}/indigo/analytics/roi_ranges ROI Data
BlueJeansOnVideoRestApi.CommandCenterApi getTopUsers GET /v1/enterprise/{enterprise_id}/indigo/analytics/users/usage Top Users
BlueJeansOnVideoRestApi.EnterpriseApi createUser POST /v1/enterprise/{enterprise_id}/users Create Enterprise User
BlueJeansOnVideoRestApi.EnterpriseApi exportUsers GET /v1/enterprise/{enterprise_id}/users/export Export Enterprise Users
BlueJeansOnVideoRestApi.EnterpriseApi listUsers GET /v1/enterprise/{enterprise_id}/users List Enterprise Users
BlueJeansOnVideoRestApi.EnterpriseApi removeUser DELETE /v1/enterprise/{enterprise_id}/users/{user_id} Remove Enterprise User
BlueJeansOnVideoRestApi.HistoryApi getHistoryByEnterprise GET /v1/enterprise/{enterprise_id}/meeting_history/{meeting_guid} Get Meeting History by Enterprise
BlueJeansOnVideoRestApi.HistoryApi getHistoryByUser GET /v1/user/{user_id}/meeting_history/{meeting_guid} Get Meeting History by User
BlueJeansOnVideoRestApi.HistoryApi getHistorySharingByUser GET /v1/user/{user_id}/meeting_history/{meeting_guid}/sharing Get Meeting History Sharing by User
BlueJeansOnVideoRestApi.HistoryApi getRecording GET /v1/user/{user_id}/meeting_history/recordings/{recording_entity_id} Get Recording
BlueJeansOnVideoRestApi.HistoryApi listHistoryByEnterprise GET /v1/enterprise/{enterprise_id}/meeting_history List History by Enterprise
BlueJeansOnVideoRestApi.HistoryApi listHistoryByUser GET /v1/user/{user_id}/meeting_history List History by User
BlueJeansOnVideoRestApi.HistoryApi listRecordings GET /v1/user/{user_id}/meeting_history/recordings List Meeting Recordings
BlueJeansOnVideoRestApi.MeetingApi cancelMeeting DELETE /v1/user/{user_id}/scheduled_meeting/{meeting_id} Cancel Meeting
BlueJeansOnVideoRestApi.MeetingApi createMeeting POST /v1/user/{user_id}/scheduled_meeting Create Meeting
BlueJeansOnVideoRestApi.MeetingApi dialoutPstn POST /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/dialout/pstn Dialout via PSTN
BlueJeansOnVideoRestApi.MeetingApi generatePairingCodePstn POST /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/pairing_code/PSTN Generate Pairing Code (PSTN)
BlueJeansOnVideoRestApi.MeetingApi generatePairingCodeSip POST /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/pairing_code/SIP Generate Pairing Code (SIP)
BlueJeansOnVideoRestApi.MeetingApi generatePairingCodeWebRtc POST /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/pairing_code/webrtc Generate Pairing Code (WebRTC)
BlueJeansOnVideoRestApi.MeetingApi getEndpointLayout GET /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints/{endpoint_guid}/layout Get Endpoint Layout
BlueJeansOnVideoRestApi.MeetingApi getMeeting GET /v1/user/{user_id}/scheduled_meeting/{meeting_id} Get Meeting
BlueJeansOnVideoRestApi.MeetingApi getMeetingEmails GET /v1/user/{user_id}/scheduled_meeting/{meeting_id}/emails Get Meeting Email
BlueJeansOnVideoRestApi.MeetingApi getMeetingEndpoint GET /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints/{endpoint_guid} Get Endpoint Information
BlueJeansOnVideoRestApi.MeetingApi getMeetingEndpoints GET /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints List Meeting Endpoints
BlueJeansOnVideoRestApi.MeetingApi getMeetingNumbers GET /v1/user/{user_id}/meetings/{meeting_id}/numbers Get Meeting Join Info
BlueJeansOnVideoRestApi.MeetingApi getMeetingState GET /v1/user/{user_id}/live_meetings/{numeric_meeting_id} Get Meeting State
BlueJeansOnVideoRestApi.MeetingApi listMeetings GET /v1/user/{user_id}/scheduled_meeting List Meetings
BlueJeansOnVideoRestApi.MeetingApi sendMeetingInvite POST /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/invite Send Email Invite
BlueJeansOnVideoRestApi.MeetingApi updateEndpointLayout PUT /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints/{endpoint_guid}/layout Update Endpoint Layout
BlueJeansOnVideoRestApi.MeetingApi updateMeeting PUT /v1/user/{user_id}/scheduled_meeting/{meeting_id} Update Meeting
BlueJeansOnVideoRestApi.MeetingApi updateMeetingEndpoint PUT /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints/{endpoint_guid} Update Endpoint Video/Audio State
BlueJeansOnVideoRestApi.MeetingApi updateMeetingEndpoints PUT /v1/user/{user_id}/live_meetings/{numeric_meeting_id}/endpoints Update Meeting Endpoints State
BlueJeansOnVideoRestApi.MeetingApi updateMeetingState PUT /v1/user/{user_id}/live_meetings/{numeric_meeting_id} Update Meeting State
BlueJeansOnVideoRestApi.RecordingApi getMeetingRecordings GET /v1/user/{user_id}/meeting_history/{meeting_id}/recordings Get All Recordings for a Specified Meeting ID
BlueJeansOnVideoRestApi.RecordingApi getRecordingContent GET /v1/user/{user_id}/cms/{content_id} Get Recording Download Link
BlueJeansOnVideoRestApi.RecordingApi startRecording POST /v1/user/{user_id}/live_meetings/{meeting_id}/recordings Start Recording
BlueJeansOnVideoRestApi.RecordingApi stopRecording PUT /v1/user/{user_id}/live_meetings/{meeting_id}/recordings Stop Recording
BlueJeansOnVideoRestApi.RecordingApi v1UserUserIdMeetingHistoryMeetingGuidRecordingsDelete DELETE /v1/user/{user_id}/meeting_history/{meeting_guid}/recordings/ Delete All Recordings for a Specified Meeting GUID
BlueJeansOnVideoRestApi.RecordingApi v1UserUserIdMeetingHistoryMeetingIdRecordingsRecordingChapterIdDelete DELETE /v1/user/{user_id}/meeting_history/{meeting_id}/recordings/{recording_chapter_id}/ Delete a Specified Recording Chapter
BlueJeansOnVideoRestApi.UserApi getEnterpriseProfile GET /v1/user/{user_id}/enterprise_profile Get Enterprise Profile
BlueJeansOnVideoRestApi.UserApi getGrantedApplications GET /v1/user/{user_id}/granted_applications Get Granted Applications
BlueJeansOnVideoRestApi.UserApi getGroups GET /v1/user/{user_id}/groups Get User Feature Groups
BlueJeansOnVideoRestApi.UserApi getRoom GET /v1/user/{user_id}/room Get User’s Default Meeting Settings
BlueJeansOnVideoRestApi.UserApi getUser GET /v1/user/{user_id} Get User Account Details
BlueJeansOnVideoRestApi.UserApi revokeGrantedApplication DELETE /v1/user/{user_id}/granted_applications/{client_id} Remoke Granted Application
BlueJeansOnVideoRestApi.UserApi setGroups PUT /v1/user/{user_id}/groups Set User Feature Groups
BlueJeansOnVideoRestApi.UserApi updateRoom PUT /v1/user/{user_id}/room Update User’s Default Meeting Settings
BlueJeansOnVideoRestApi.UserApi updateUser PUT /v1/user/{user_id} Update User Account Details

Documentation for Models

Documentation for Authorization

access_token

  • Type: API key
  • API key parameter name: access_token
  • Location: URL query string

Readme

Keywords

none

Package Sidebar

Install

npm i bluejeans-api-rest-onvideo

Repository

github.com/bluejeans/api-rest-onvideo

Homepage

github.com/bluejeans/api-rest-onvideo#readme

Weekly Downloads

1

Version

1.0.0

License

MIT

Last publish

Collaborators

  • lukedawilson
Try on RunKit
Report malware