1.0.6 • Published 2 years ago

brime-api v1.0.6

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

brime-api

BrimeApi - JavaScript client for brime-api

Installation

npm install brime-api --save

Getting Started

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

var BrimeApi = require('brime-api');

var api = new BrimeApi.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.broadcastsStats(callback);

Documentation for API Endpoints

All URIs are relative to https://localhost

ClassMethodHTTP requestDescription
BrimeApi.DefaultApibroadcastsStatsGET /stats/broadcastsBroadcasts Stats
BrimeApi.DefaultApicategoriesBySlugGET /categories/slug/{slug}Categories by Slug
BrimeApi.DefaultApicategoriesByXidGET /categories/{xid}Categories by XID
BrimeApi.DefaultApiclipsByChannelGET /clip/channel/{channel_xid}Clips by Channel
BrimeApi.DefaultApiconfiguredEndpointsGET /multistreaming/repubsConfigured Endpoints
BrimeApi.DefaultApicreateClipGET /clip/createCreate Clip
BrimeApi.DefaultApicreateEndpointPOST /multistreaming/repubsCreate Endpoint
BrimeApi.DefaultApideleteEndpoint1DELETE /multistreaming/{platform}Delete Endpoint
BrimeApi.DefaultApigetChannelByXidGET /channels/{xid}Channel lookup by XID
BrimeApi.DefaultApigetChannelInformationGET /channels/slug/{slug}Channel lookup by Slug
BrimeApi.DefaultApilistChattersViewersGET /chat/channel/{xid}/chattersList Chatters / Viewers
BrimeApi.DefaultApilistIngestServersGET /ingestsIngest Servers
BrimeApi.DefaultApilookupClipGET /clip/{xid}Lookup Clip
BrimeApi.DefaultApipastBroadcastsByChannelGET /channel/{channel_xid}/broadcastsPast Broadcasts by Channel
BrimeApi.DefaultApiregisteredUsersGET /users/countRegistered Users
BrimeApi.DefaultApisearchCategoriesGET /categories/search/{name}Search Categories
BrimeApi.DefaultApisendMessagePOST /chat/sendSend Message
BrimeApi.DefaultApisupportedPlatformsGET /multistreaming/platformsSupported Platforms
BrimeApi.DefaultApiupdateChatNameColorPOST /account/chat_colorUpdate Chat Name Color
BrimeApi.DefaultApiupdateEndpointPUT /multistreaming/{platform}Update Endpoint
BrimeApi.DefaultApiupdateUserChatLanguagePOST /account/chat_langUpdate Chat Language
BrimeApi.DefaultApiuserDisplaynamePOST /account/displaynameUpdate Display Name
BrimeApi.DefaultApiuserFollowingListGET /account/followingUser Following List
BrimeApi.DefaultApiuserInfoGET /account/meUser Info

Documentation for Models

Documentation for Authorization

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago