@42videobricks/nodejs-client v1.2.0

@42videobricks/nodejs-client

Api42Vb - JavaScript client for @42videobricks/nodejs-client 42videobricks is a Video Platform As A Service (VPaaS) This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2
• Package version: 1.2.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

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 @42videobricks/nodejs-client --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your @42videobricks/nodejs-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install 42videobricks/42videobricks-nodejs-client --save

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 Api42Vb = require('@42videobricks/nodejs-client');

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

var api = new Api42Vb.VideosApi()
var opts = {
  'limit': 10, // {Number} Number of elements to return (default=10)
  'offset': 0 // {Number} offset for pagination
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideos(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api-sbx.42videobricks.com

Documentation for Models

• Api42Vb.DataVideoUsage
• Api42Vb.DataVideoUsageList
• Api42Vb.Error
• Api42Vb.Pagination
• Api42Vb.Playlist
• Api42Vb.PlaylistList
• Api42Vb.PlaylistProperties
• Api42Vb.TagList
• Api42Vb.Video
• Api42Vb.VideoAssets
• Api42Vb.VideoAttachment
• Api42Vb.VideoAttachmentList
• Api42Vb.VideoList
• Api42Vb.VideoMultipartUploadFinalize
• Api42Vb.VideoMultipartUploadFinalizePartsInner
• Api42Vb.VideoMultipartUploadInit
• Api42Vb.VideoMultipartUploadInitResponse
• Api42Vb.VideoMultipartUploadInitResponsePartsInner
• Api42Vb.VideoProperties
• Api42Vb.VideoStatus
• Api42Vb.VideoUploadInitResponse
• Api42Vb.Webhook
• Api42Vb.WebhookList
• Api42Vb.WebhookProperties

Documentation for Authorization

Authentication schemes defined for the API:

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header