@webcastudio/sdk

4.12.0-rc.1 • Public • Published

@webcastudio/sdk

vcv - JavaScript client for @webcastudio/sdk Vancast Cloud Video API SDK This SDK is automatically generated by the Swagger Codegen project:

  • API version: 4.12.0
  • Package version: 4.12.0
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

Install it via:

npm install @webcastudio/sdk --save

Getting Started

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

var vcv = require('@webcastudio/sdk');

vcv.ApiClient.configure({
  url: 'https://[CUSTOMER].vancastvideo.com/api',
  credentials: {
    apiKey: 'API_KEY_TOKEN'
  }
});
var api = new vcv.AccountsApi()

var accountId = 56; // {Number} 

var body = new vcv.AccountSSOKey(); // {AccountSSOKey} 

api.createAccountSSOKey(accountId, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

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

Class Method HTTP request Description
vcv.AccountsApi createAccountSSOKey POST /accounts/{accountId}/sso-keys Create AccountSSOKey
vcv.AccountsApi findAccountSSOKeys GET /accounts/{accountId}/sso-keys Find AccountSSOKeys
vcv.AccountsApi getAccountByHostname GET /account/domain Get Account details by hostname
vcv.AccountsApi getAccountSSOKey GET /accounts/{accountId}/sso-keys/{id} Get AccountSSOKey
vcv.AccountsApi getHiveCustomer GET /accounts/{id}/hive Get Hive Customer settings
vcv.AccountsApi getNetworkReport GET /accounts/{accountId}/reports/usage/network Get Network Usage Report
vcv.AccountsApi getStorageReport GET /accounts/{accountId}/reports/storage Get Account Cloud Storage report
vcv.AccountsApi getTranscodingTimeReport GET /accounts/{accountId}/reports/transcoding-time Get Transcoding Time
vcv.AccountsApi removeAccountSSOKey DELETE /accounts/{accountId}/sso-keys/{id} Delete AccountSSOKey
vcv.AccountsApi updateAccountSSOKey PUT /accounts/{accountId}/sso-keys/{id} Update AccountSSOKey
vcv.AudienceInteractionApi findAllAudienceQuestions GET /event/webcast/{sessionId}/qa/questions Find Question
vcv.EventApi authorizeEndUser POST /event/webcast/{sessionId}/authorize Authorize End User
vcv.EventApi endUserSignUp POST /event/signup EndUser Signup
vcv.EventApi getLinkByToken GET /event/link/{token} Get WebcastLink details by token
vcv.EventApi getManifest GET /event/webcast/{sessionId}/manifest Get WebcastManifest details
vcv.EventApi getStreams GET /event/webcast/{sessionId}/streams Get Webcast stream endpoints resource list
vcv.InteractionApi acceptInvitation POST /events/{eventId}/interaction/moderate/invitations/{token}/accept Accept ModerationInvitation
vcv.InteractionApi assignModerator POST /interaction/qa/{sessionId}/questions/{id}/assign/{endUserId} Assign a moderator to a question
vcv.InteractionApi assignQuestionTopic POST /interaction/qa/{sessionId}/question/{questionId}/topics Creates a new topic if it does not exist and assign it to a question.
vcv.InteractionApi authorizeModerator POST /interaction/qa/{eventId}/authorize Check a moderator authorization
vcv.InteractionApi cancelInvitation DELETE /events/{eventId}/interaction/moderate/invitations/{id} Cancels ModerationInvitation
vcv.InteractionApi createAnswer POST /interaction/qa/{sessionId}/questions/{id}/answers Create Answer
vcv.InteractionApi createInvitation POST /events/{eventId}/interaction/moderate/invitations Create ModerationInvitation
vcv.InteractionApi createModerationToken POST /interaction/qa/{eventId}/auth Create a Moderation token
vcv.InteractionApi createQuestion POST /interaction/qa/{sessionId}/questions Create Question
vcv.InteractionApi deleteQuestion DELETE /interaction/qa/{sessionId}/question/{questionId} Deletes a question with id = questionId and its answers
vcv.InteractionApi findAllInvitations GET /events/{eventId}/interaction/moderate/invitations Find ModerationInvitation
vcv.InteractionApi findAllQuestions GET /interaction/qa/{sessionId}/questions Find Question
vcv.InteractionApi getInteractionEvent GET /interaction/qa/{eventId} Get WebcastEvent details
vcv.InteractionApi getInvitationByToken GET /events/{eventId}/interaction/moderate/{token} Get ModerationInvitation
vcv.InteractionApi removeQuestions DELETE /interaction/qa/{sessionId}/questions Removes all questions and answers from a session
vcv.InteractionApi unAssignModerator DELETE /interaction/qa/{sessionId}/questions/{id}/assign/{endUserId} Removes a moderator from a question
vcv.InteractionApi updateInvitation PUT /events/{eventId}/interaction/moderate/invitations/{id} Update ModerationInvitation
vcv.InteractionApi updateQuestion PUT /interaction/qa/{sessionId}/questions/{id} Update Question
vcv.InteractionApi withdrawQuestionTopic DELETE /interaction/qa/{sessionId}/question/{questionId}/topics/${topicId} Withdraw a topic from a question
vcv.PresentersApi authorizePresenter POST /presenters/{eventId}/authorize Check a presenter collaborator authorization
vcv.PresentersApi getPresenterAppInstances GET /presenters/{eventId}/{sessionId}/streaming/appinstances Get a list of streaming app instances from a given session.
vcv.PresentersApi getPresenterEvent GET /presenters/{eventId} Get Webcast event for a presenter collaborator.
vcv.PresentersApi getPresenterSession GET /presenters/{eventId}/sessions/{id} Get Webcast session for a presenter collaborator.
vcv.PresentersApi getPresenterSlideshows GET /presenters/{eventId}/slideshows Get a resource list of slideshow contents.
vcv.WebcastEventApi addPreviewUser POST /events/{eventId}/preview-users Adds a Preview User
vcv.WebcastEventApi removePreviewUser DELETE /events/{eventId}/preview-users/{id} Remove a Preview User
vcv.WebcastEventsApi addWebcastEventMember POST /events/{eventId}/members Add a new member
vcv.WebcastEventsApi changeWebcastEventMemberRole PUT /events/{eventId}/members/{userId} Change WebcastEvent member role
vcv.WebcastEventsApi copySessionAsVod POST /events/{eventId}/sessions/{id}/copyasvod Creates a new VOD session copying an existing session that was produced live.
vcv.WebcastEventsApi createEmailCampaign POST /events/{eventId}/links/{linkId}/integrations/emailcampaigns Create EmailCampaign
vcv.WebcastEventsApi createEventForVod POST /events/vod Creates an Event configured for VOD
vcv.WebcastEventsApi createLink POST /events/{eventId}/links Create WebcastLink
vcv.WebcastEventsApi createOdChapter POST /events/{eventId}/ondemands/{onDemandId}/chapters Create Chapter
vcv.WebcastEventsApi createOnDemand POST /events/{eventId}/ondemands Create OnDemand
vcv.WebcastEventsApi createRegistrationField POST /events/{eventId}/links/{linkId}/fields Create RegistrationField
vcv.WebcastEventsApi createRegistrationFieldTranslation POST /events/{eventId}/links/{linkId}/fields/{fieldId}/translations Create RegistrationFieldTranslation
vcv.WebcastEventsApi createStreamTargetDef POST /events/{eventId}/webcast/distribution-settings/{settingsId}/stream-targets Creates a new StreamTargetDef
vcv.WebcastEventsApi createWebcastEvent POST /events/ Create a Webcast Event
vcv.WebcastEventsApi createWebcastLinkAsset POST /events/{eventId}/links/{linkId}/assets Create WebcastLinkAsset
vcv.WebcastEventsApi findAllWebcastLinkAssets GET /events/{eventId}/links/{linkId}/assets Find WebcastLinkAsset
vcv.WebcastEventsApi findDistributionSettings GET /events/{eventId}/webcast/distribution-settings Find all WebcastDistributionSettings associated with the event
vcv.WebcastEventsApi findOdChapters GET /events/{eventId}/ondemands/{onDemandId}/chapters Find Chapter
vcv.WebcastEventsApi findOnDemands GET /events/{eventId}/ondemands Find OnDemands
vcv.WebcastEventsApi getAudienceAccessReport GET /events/{eventId}/reports/audience/access Audience Access
vcv.WebcastEventsApi getAudienceViewingReport GET /events/{eventId}/reports/audience/webcast-viewing Audience Viewing
vcv.WebcastEventsApi getContents GET /events/{eventId}/contents Get Content list
vcv.WebcastEventsApi getEmailCampaign GET /events/{eventId}/links/{linkId}/integrations/emailcampaigns/{id} Find EmailCampaign
vcv.WebcastEventsApi getEmailCampaigns GET /events/{eventId}/links/{linkId}/integrations/emailcampaigns Find EmailCampaign
vcv.WebcastEventsApi getLink GET /events/{eventId}/links/{id} Get WebcastLink details
vcv.WebcastEventsApi getLinks GET /events/{eventId}/links Get WebcastLinks
vcv.WebcastEventsApi getOdChapter GET /events/{eventId}/ondemands/{onDemandId}/chapters/{id} Get Chapter
vcv.WebcastEventsApi getOdContents GET /events/{eventId}/ondemands/{id}/contents Get OnDemand contents
vcv.WebcastEventsApi getOndemand GET /events/{eventId}/ondemands/{id} Get OnDemand
vcv.WebcastEventsApi getPreviewUsers GET /events/{eventId}/preview-users Get event preview users
vcv.WebcastEventsApi getRGImportCandidates GET /events/{eventId}/links/{linkId}/registration-gate/import/candidates Get RegistrationGateImportCandidates
vcv.WebcastEventsApi getRegistrationFields GET /events/{eventId}/links/{linkId}/fields Get RegistrationFields
vcv.WebcastEventsApi getTemplateFile GET /events/{eventId}/template/{file} Get a template instance file
vcv.WebcastEventsApi getWebcastEvent GET /events/{id} Get WebcastWebcast details
vcv.WebcastEventsApi getWebcastEventMembers GET /events/{eventId}/members Get Members
vcv.WebcastEventsApi getWebcastLinkStreamTargets GET /events/{eventId}/links/{linkId}/targets Find WebcastLinkStreamTarget
vcv.WebcastEventsApi importRegistrationGate POST /events/{eventId}/links/{linkId}/registration-gate/import Import registrationGate
vcv.WebcastEventsApi removeContent DELETE /events/{eventId}/contents/{id} Delete Content
vcv.WebcastEventsApi removeEmailCampaign DELETE /events/{eventId}/links/{linkId}/integrations/emailcampaigns/{id} Delete EmailCampaign
vcv.WebcastEventsApi removeImageRendition DELETE /events/{eventId}/contents/{id}/renditions/{alias} Delete ImageContent rendition
vcv.WebcastEventsApi removeLink DELETE /events/{eventId}/links/{id} Delete WebcastLink
vcv.WebcastEventsApi removeOdChapter DELETE /events/{eventId}/ondemands/{onDemandId}/chapters/{id} Delete Chapter
vcv.WebcastEventsApi removeOnDemand DELETE /events/{eventId}/ondemands/{id} Remove OnDemand
vcv.WebcastEventsApi removeRegistrationField DELETE /events/{eventId}/links/{linkId}/fields/{id} Delete RegistrationField
vcv.WebcastEventsApi removeRegistrationFieldTranslation DELETE /events/{eventId}/links/{linkId}/fields/{fieldId}/translations/{id} Delete RegistrationFieldTranslation
vcv.WebcastEventsApi removeSlideshowSource DELETE /events/{eventId}/contents/{id}/slideshows/sources/{alias} Delete SlideshowContent rendition
vcv.WebcastEventsApi removeWebcastAssetRendition POST /events/{eventId}/links/{linkId}/assets/{id}/renditions/{renditionName} Deletes a WebcastLinkAsset rendition
vcv.WebcastEventsApi removeWebcastLinkAsset DELETE /events/{eventId}/links/{linkId}/assets/{id} Remove WebcastLinkAsset
vcv.WebcastEventsApi replaceImage POST /events/{eventId}/contents/{id} Replace ImageContent
vcv.WebcastEventsApi replaceWebcastAsset POST /events/{eventId}/links/{linkId}/assets/{id} Replaces a WebcastLinkAsset
vcv.WebcastEventsApi revokeWebcastEventMember DELETE /events/{eventId}/members/{userId} Revoke WebcastEvent member privileges
vcv.WebcastEventsApi saveWebcastLinkStreamTargets POST /events/{eventId}/links/{linkId}/targets Save or update WebcastLinkStreamTarget
vcv.WebcastEventsApi terminateStreamingEngine DELETE /events/{eventId}/streamingengines/{id} Terminate an Streaming Engine
vcv.WebcastEventsApi updateAttachmentProperties PUT /events/{eventId}/contents/{id} Update Attachment Content properties
vcv.WebcastEventsApi updateEmailCampaign PUT /events/{eventId}/links/{linkId}/integrations/emailcampaigns/{id} Update EmailCampaign
vcv.WebcastEventsApi updateLink PUT /events/{eventId}/links/{id} Update WebcastLink
vcv.WebcastEventsApi updateLinkSettings PUT /events/{eventId}/links/{id}/settings Update WebcastLink settings
vcv.WebcastEventsApi updateLinkSettingsLevel1 PUT /events/{eventId}/links/{id}/settings/{key1} Update WebcastLink settings
vcv.WebcastEventsApi updateLinkSettingsLevel2 PUT /events/{eventId}/links/{id}/settings/{key1}/{key2} Update WebcastLink settings
vcv.WebcastEventsApi updateLinkSettingsLevel3 PUT /events/{eventId}/links/{id}/settings/{key1}/{key2}/{key3} Update WebcastLink settings
vcv.WebcastEventsApi updateOdChapter PUT /events/{eventId}/ondemands/{onDemandId}/chapters/{id} Update Chapter
vcv.WebcastEventsApi updateOnDemand PUT /events/{eventId}/ondemands/{id} Update OnDemand
vcv.WebcastEventsApi updateRegistrationField PUT /events/{eventId}/links/{linkId}/fields/{id} Update RegistrationField
vcv.WebcastEventsApi updateRegistrationFieldTranslation PUT /events/{eventId}/links/{linkId}/fields/{fieldId}/translations/{id} Update RegistrationFieldTranslation
vcv.WebcastEventsApi updateStreamTargetDef PUT /events/{eventId}/webcast/distribution-settings/{settingsId}/stream-targets/{id} updates a StreamTargetDef
vcv.WebcastEventsApi updateTemplate GET /events/{eventId}/template/ Update template instance files
vcv.WebcastEventsApi updatedistributionSettings PUT /events/{eventId}/webcast/distribution-settings/{id} Updates a WebcastDistributionSettings
vcv.WebcastEventsApi uploadImageRendition POST /events/{eventId}/contents/{id}/renditions/{alias} Upload ImageContent rendition
vcv.WebcastEventsApi uploadOdChapters POST /events/{eventId}/ondemands/{id}/chapters.json Replaces current chapters
vcv.WebcastEventsApi uploadOndemandCuepoints POST /events/{eventId}/ondemands/{id}/cuepoints.json Replace current cuepoints
vcv.WebcastEventsApi uploadSlideshow POST /events/{eventId}/contents Upload SlideshowContent
vcv.WebcastEventsApi uploadSlideshowSource POST /events/{eventId}/contents/{id}/slideshows/sources/{alias} Upload SlideshowContent source
vcv.WorkspacesApi changeWorkspacesMember PUT /workspaces/{workspaceId}/members Change Member permissions
vcv.WorkspacesApi createEmailCampaignApiKey POST /workspaces/{workspaceId}/integrations/emailcampaigns/apikeys Create EmailCampaignApiKey
vcv.WorkspacesApi createWebcastSSOKeys POST /workspaces/{workspaceId}/sso-keys Create Webcast SSO Key pair
vcv.WorkspacesApi createWorkspaceApiKey POST /workspaces/{workspaceId}/apikeys Create WorkspaceApiKey
vcv.WorkspacesApi createWorkspaceJoinInvitation GET /workspaces/{workspaceId}/invitations Creates workspace join invitation.
vcv.WorkspacesApi getEmailCampaignApiKeys GET /workspaces/{workspaceId}/integrations/emailcampaigns/apikeys Find EmailCampaignApiKey
vcv.WorkspacesApi getWorkspace GET /workspaces/{id} Get Workspace
vcv.WorkspacesApi getWorkspaceApiKey GET /workspaces/{workspaceId}/apikeys/{id} Get WorkspaceApiKey
vcv.WorkspacesApi getWorkspaceApiKeys GET /workspaces/{workspaceId}/apikeys Find WorkspaceApiKey
vcv.WorkspacesApi getWorkspaceSSOKeys GET /workspaces/{workspaceId}/sso-keys Get Webcast SSO Key pairs list
vcv.WorkspacesApi getWorkspaceTranscodingPresets GET /workspaces/{workspaceId}/transcoding/presets Get Workspace Transcoding Presets
vcv.WorkspacesApi getWorkspacesMembers GET /workspaces/{workspaceId}/members Get Members
vcv.WorkspacesApi removeEmailCampaignApiKey DELETE /workspaces/{workspaceId}/integrations/emailcampaigns/apikeys/{id} Delete EmailCampaignApiKey
vcv.WorkspacesApi removeWebcastSSOKey DELETE /workspaces/{workspaceId}/sso-keys/{id} Delete a Webcast SSO Key pair
vcv.WorkspacesApi removeWorkspaceApiKey DELETE /workspaces/{workspaceId}/apikeys/{id} Delete WorkspaceApiKey
vcv.WorkspacesApi removeWorkspacesMember DELETE /workspaces/{workspaceId}/members Remove Member
vcv.WorkspacesApi updateEmailCampaignApiKey PUT /workspaces/{workspaceId}/integrations/emailcampaigns/apikeys/{id} Update EmailCampaignApiKey
vcv.WorkspacesApi updateWebcastSSOKeys PUT /workspaces/{workspaceId}/sso-keys/{id} Update a Webcast SSO Key pair
vcv.WorkspacesApi updateWorkspaceApiKey PUT /workspaces/{workspaceId}/apikeys/{id} Update WorkspaceApiKey
vcv.WorkspacesApi updateWorkspacePreference PUT /workspaces/{workspaceId}/preferences Update Workspace preference

Documentation for Models

Documentation for Authorization

ApiKeyHeader

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

Readme

Keywords

none

Package Sidebar

Install

npm i @webcastudio/sdk

Weekly Downloads

0

Version

4.12.0-rc.1

License

Unlicense

Unpacked Size

1.76 MB

Total Files

486

Last publish

Collaborators

  • webcastudio