{"_id":"@42videobricks/nodejs-client","_rev":"6-c55d21d25971c8499a85475585f436fd","name":"@42videobricks/nodejs-client","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.2":{"name":"@42videobricks/nodejs-client","version":"1.1.2","keywords":["42videobricks","video","api","client","sdk","rest"],"license":"MIT","_id":"@42videobricks/nodejs-client@1.1.2","maintainers":[{"name":"yann-alchimie","email":"yann.gourdel@alchimie.com"}],"homepage":"https://github.com/42videobricks/42videobricks-nodejs-client#readme","bugs":{"url":"https://github.com/42videobricks/42videobricks-nodejs-client/issues"},"dist":{"shasum":"0e55456d23205325fb8b8c5951d1ec9467b3733e","tarball":"https://registry.npmjs.org/@42videobricks/nodejs-client/-/nodejs-client-1.1.2.tgz","fileCount":29,"integrity":"sha512-PZGbmEbzVtZ3FLpmm7rss8OslNSLJe36CGqgMyPa77V0VQ2uNOq5OxdY0KVhl9FfacLqMrQBNb90ScXYkYyIHA==","signatures":[{"sig":"MEQCIAN4jGDwVgxR12DnqwsmkCMkAJVDnhugBMl01BfNqrn0AiAQa09VKUBU7FE6zfrFHnbnb6j96apvTs5jsmR60QwdXg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":362266},"main":"dist/index.js","browser":{"fs":false},"gitHead":"b4fd29449659ab7994f1e11b93d6f3eaad68c87d","scripts":{"test":"mocha --require @babel/register --recursive","build":"babel src -d dist","prepare":"npm run build"},"_npmUser":{"name":"yann-alchimie","email":"yann.gourdel@alchimie.com"},"repository":{"url":"git+https://github.com/42videobricks/42videobricks-nodejs-client.git","type":"git"},"_npmVersion":"8.15.0","description":"Official Node.js client library for 42videobricks API.","directories":{},"_nodeVersion":"16.17.1","dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.0.1","sinon":"^7.2.0","expect.js":"^0.3.1","@babel/core":"^7.0.0","@babel/register":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nodejs-client_1.1.2_1697814175180_0.13778859193043314","host":"s3://npm-registry-packages"}},"1.2.0":{"name":"@42videobricks/nodejs-client","version":"1.2.0","keywords":["42videobricks","video","api","client","sdk","rest"],"license":"MIT","_id":"@42videobricks/nodejs-client@1.2.0","maintainers":[{"name":"bastien-alchimie","email":"bastien.combes@alchimie.com"},{"name":"laurent-alchimie","email":"laurent.bodelet@alchimie.com"},{"name":"yann-alchimie","email":"yann.gourdel@alchimie.com"}],"homepage":"https://github.com/42videobricks/42videobricks-nodejs-client#readme","bugs":{"url":"https://github.com/42videobricks/42videobricks-nodejs-client/issues"},"dist":{"shasum":"76b8134707a3d1ff5ef45f7580cbb192e6b9a00c","tarball":"https://registry.npmjs.org/@42videobricks/nodejs-client/-/nodejs-client-1.2.0.tgz","fileCount":34,"integrity":"sha512-/r4WcrCy1kk19wH+VkRCfYxc0t+FCOVGITTn8BcqwAZuo/HWEasdUvw39FwG0oy5QAyP5HT/Qazk58tqwOvgvA==","signatures":[{"sig":"MEYCIQCG2RrdGTgUJlj3t2DVrC0/0YNs1gUm4+Ch4NRPQhsmtwIhAKUbINwC4/yC8O1zqQUAtHo24CkQTtXKT/6IBiBvX461","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":302712},"main":"dist/index.js","browser":{"fs":false},"gitHead":"5c22c6de7053eefed43885be4a6b640d9eb75999","scripts":{"test":"mocha --require @babel/register --recursive","build":"babel src -d dist","prepare":"npm run build"},"_npmUser":{"name":"yann-alchimie","email":"yann.gourdel@alchimie.com"},"repository":{"url":"git+https://github.com/42videobricks/42videobricks-nodejs-client.git","type":"git"},"_npmVersion":"8.15.0","description":"Official Node.js client library for 42videobricks API.","directories":{},"_nodeVersion":"16.17.1","dependencies":{"@babel/cli":"^7.0.0","superagent":"^5.3.0"},"_hasShrinkwrap":false,"devDependencies":{"mocha":"^8.0.1","sinon":"^7.2.0","expect.js":"^0.3.1","@babel/core":"^7.0.0","@babel/register":"^7.0.0","@babel/preset-env":"^7.0.0","@babel/plugin-syntax-import-meta":"^7.0.0","@babel/plugin-proposal-decorators":"^7.0.0","@babel/plugin-proposal-json-strings":"^7.0.0","@babel/plugin-syntax-dynamic-import":"^7.0.0","@babel/plugin-proposal-function-bind":"^7.0.0","@babel/plugin-proposal-function-sent":"^7.0.0","@babel/plugin-proposal-do-expressions":"^7.0.0","@babel/plugin-proposal-class-properties":"^7.0.0","@babel/plugin-proposal-numeric-separator":"^7.0.0","@babel/plugin-proposal-optional-chaining":"^7.0.0","@babel/plugin-proposal-pipeline-operator":"^7.0.0","@babel/plugin-proposal-throw-expressions":"^7.0.0","@babel/plugin-proposal-export-default-from":"^7.0.0","@babel/plugin-proposal-export-namespace-from":"^7.0.0","@babel/plugin-proposal-nullish-coalescing-operator":"^7.0.0","@babel/plugin-proposal-logical-assignment-operators":"^7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/nodejs-client_1.2.0_1700820861577_0.08104211035610365","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-10-20T14:50:29.919Z","modified":"2025-01-13T12:29:24.560Z","1.1.1":"2023-10-20T14:50:30.202Z","1.1.2":"2023-10-20T15:02:55.398Z","1.2.0":"2023-11-24T10:14:21.791Z"},"bugs":{"url":"https://github.com/42videobricks/42videobricks-nodejs-client/issues"},"license":"MIT","homepage":"https://github.com/42videobricks/42videobricks-nodejs-client#readme","keywords":["42videobricks","video","api","client","sdk","rest"],"repository":{"url":"git+https://github.com/42videobricks/42videobricks-nodejs-client.git","type":"git"},"description":"Official Node.js client library for 42videobricks API.","maintainers":[{"email":"bastien.combes@alchimie.com","name":"bastien-alchimie"},{"email":"laurent.bodelet@alchimie.com","name":"laurent-alchimie"}],"readme":"# @42videobricks/nodejs-client\n\nApi42Vb - JavaScript client for @42videobricks/nodejs-client\n42videobricks is a Video Platform As A Service (VPaaS)\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.2\n- Package version: 1.2.0\n- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen\n\n## Installation\n\n### For [Node.js](https://nodejs.org/)\n\n#### npm\n\nTo publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in [\"Publishing npm packages\"](https://docs.npmjs.com/getting-started/publishing-npm-packages).\n\nThen install it via:\n\n```shell\nnpm install @42videobricks/nodejs-client --save\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n##### Local development\n\nTo 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:\n\n```shell\nnpm install\n```\n\nNext, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:\n\n```shell\nnpm link\n```\n\nTo use the link you just defined in your project, switch to the directory you want to use your @42videobricks/nodejs-client from, and run:\n\n```shell\nnpm link /path/to/<JAVASCRIPT_CLIENT_DIR>\n```\n\nFinally, you need to build the module:\n\n```shell\nnpm run build\n```\n\n#### git\n\nIf the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID\nthen install it via:\n\n```shell\n    npm install 42videobricks/42videobricks-nodejs-client --save\n```\n\n### Webpack Configuration\n\nUsing Webpack you may encounter the following error: \"Module not found: Error:\nCannot resolve module\", most certainly you should disable AMD loader. Add/merge\nthe following section to your webpack config:\n\n```javascript\nmodule: {\n  rules: [\n    {\n      parser: {\n        amd: false\n      }\n    }\n  ]\n}\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar Api42Vb = require('@42videobricks/nodejs-client');\n\nvar defaultClient = Api42Vb.ApiClient.instance;\n// Configure API key authorization: api_key\nvar api_key = defaultClient.authentications['api_key'];\napi_key.apiKey = \"YOUR API KEY\"\n// Uncomment the following line to set a prefix for the API key, e.g. \"Token\" (defaults to null)\n//api_key.apiKeyPrefix['x-api-key'] = \"Token\"\n\nvar api = new Api42Vb.VideosApi()\nvar opts = {\n  'limit': 10, // {Number} Number of elements to return (default=10)\n  'offset': 0 // {Number} offset for pagination\n};\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.getVideos(opts, callback);\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api-sbx.42videobricks.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Api42Vb.DataApi* | [**getDataVideoUsage**](docs/DataApi.md#getDataVideoUsage) | **GET** /data/videos/usage | List Video Usage KPIs\n*Api42Vb.PlaylistsApi* | [**addPlaylist**](docs/PlaylistsApi.md#addPlaylist) | **POST** /playlists | Add a new playlist\n*Api42Vb.PlaylistsApi* | [**deletePlaylistById**](docs/PlaylistsApi.md#deletePlaylistById) | **DELETE** /playlists/{playlistId} | Delete a playlist\n*Api42Vb.PlaylistsApi* | [**getPlaylistById**](docs/PlaylistsApi.md#getPlaylistById) | **GET** /playlists/{playlistId} | Retun a single playlist\n*Api42Vb.PlaylistsApi* | [**getPlaylists**](docs/PlaylistsApi.md#getPlaylists) | **GET** /playlists | List playlists\n*Api42Vb.PlaylistsApi* | [**updatePlaylistById**](docs/PlaylistsApi.md#updatePlaylistById) | **PUT** /playlists/{playlistId} | Update an existing playlist\n*Api42Vb.TagsApi* | [**getTags**](docs/TagsApi.md#getTags) | **GET** /tags | List Video Tags\n*Api42Vb.VideosApi* | [**addAttachmentByVideoId**](docs/VideosApi.md#addAttachmentByVideoId) | **POST** /videos/{videoId}/attachments/{attachmentType}/{locale} | Upload an attachement\n*Api42Vb.VideosApi* | [**addThumbnailByVideoId**](docs/VideosApi.md#addThumbnailByVideoId) | **POST** /videos/{videoId}/thumbnail | Upload a thumbnail\n*Api42Vb.VideosApi* | [**addVideo**](docs/VideosApi.md#addVideo) | **POST** /videos | Add a new video\n*Api42Vb.VideosApi* | [**deleteAttachmentByVideoId**](docs/VideosApi.md#deleteAttachmentByVideoId) | **DELETE** /videos/{videoId}/attachments/{attachmentType}/{locale} | Delete an attachment\n*Api42Vb.VideosApi* | [**deleteThumbnailByVideoId**](docs/VideosApi.md#deleteThumbnailByVideoId) | **DELETE** /videos/{videoId}/thumbnail | Delete a thumbnail\n*Api42Vb.VideosApi* | [**deleteVideoById**](docs/VideosApi.md#deleteVideoById) | **DELETE** /videos/{videoId} | Delete a video\n*Api42Vb.VideosApi* | [**finalizeMultipartUploadVideoById**](docs/VideosApi.md#finalizeMultipartUploadVideoById) | **POST** /videos/{videoId}/multipart-upload/finalize | Multipart upload finalization\n*Api42Vb.VideosApi* | [**finalizeUploadVideoById**](docs/VideosApi.md#finalizeUploadVideoById) | **PUT** /videos/{videoId}/upload/finalize | Single file upload finalization\n*Api42Vb.VideosApi* | [**getAttachmentByVideoId**](docs/VideosApi.md#getAttachmentByVideoId) | **GET** /videos/{videoId}/attachments/{attachmentType}/{locale} | Get the attachment\n*Api42Vb.VideosApi* | [**getAttachmentFileByVideoId**](docs/VideosApi.md#getAttachmentFileByVideoId) | **GET** /videos/{videoId}/attachments/{attachmentType}/{locale}/file | Get attachement file\n*Api42Vb.VideosApi* | [**getAttachmentsByVideoId**](docs/VideosApi.md#getAttachmentsByVideoId) | **GET** /videos/{videoId}/attachments | List of attachments\n*Api42Vb.VideosApi* | [**getVideoById**](docs/VideosApi.md#getVideoById) | **GET** /videos/{videoId} | Retun a single video\n*Api42Vb.VideosApi* | [**getVideoStatusById**](docs/VideosApi.md#getVideoStatusById) | **GET** /videos/{videoId}/status | Retun the detailed status of the video\n*Api42Vb.VideosApi* | [**getVideos**](docs/VideosApi.md#getVideos) | **GET** /videos | List videos\n*Api42Vb.VideosApi* | [**initMultipartUploadVideoById**](docs/VideosApi.md#initMultipartUploadVideoById) | **POST** /videos/{videoId}/multipart-upload/init | Multipart upload intialization\n*Api42Vb.VideosApi* | [**initUploadVideoById**](docs/VideosApi.md#initUploadVideoById) | **GET** /videos/{videoId}/upload/init | Single file upload intialization\n*Api42Vb.VideosApi* | [**updateVideoById**](docs/VideosApi.md#updateVideoById) | **PUT** /videos/{videoId} | Update an existing video\n*Api42Vb.WebhooksApi* | [**addWebhook**](docs/WebhooksApi.md#addWebhook) | **POST** /webhooks | Add a new webhook\n*Api42Vb.WebhooksApi* | [**deleteWebhookById**](docs/WebhooksApi.md#deleteWebhookById) | **DELETE** /webhooks/{webhookId} | Delete a webhook\n*Api42Vb.WebhooksApi* | [**getWebhookById**](docs/WebhooksApi.md#getWebhookById) | **GET** /webhooks/{webhookId} | Retun a single webhook\n*Api42Vb.WebhooksApi* | [**getWebhooks**](docs/WebhooksApi.md#getWebhooks) | **GET** /webhooks | List webhooks\n*Api42Vb.WebhooksApi* | [**updateWebhookById**](docs/WebhooksApi.md#updateWebhookById) | **PUT** /webhooks/{webhookId} | Update an existing webhook\n\n\n## Documentation for Models\n\n - [Api42Vb.DataVideoUsage](docs/DataVideoUsage.md)\n - [Api42Vb.DataVideoUsageList](docs/DataVideoUsageList.md)\n - [Api42Vb.Error](docs/Error.md)\n - [Api42Vb.Pagination](docs/Pagination.md)\n - [Api42Vb.Playlist](docs/Playlist.md)\n - [Api42Vb.PlaylistList](docs/PlaylistList.md)\n - [Api42Vb.PlaylistProperties](docs/PlaylistProperties.md)\n - [Api42Vb.TagList](docs/TagList.md)\n - [Api42Vb.Video](docs/Video.md)\n - [Api42Vb.VideoAssets](docs/VideoAssets.md)\n - [Api42Vb.VideoAttachment](docs/VideoAttachment.md)\n - [Api42Vb.VideoAttachmentList](docs/VideoAttachmentList.md)\n - [Api42Vb.VideoList](docs/VideoList.md)\n - [Api42Vb.VideoMultipartUploadFinalize](docs/VideoMultipartUploadFinalize.md)\n - [Api42Vb.VideoMultipartUploadFinalizePartsInner](docs/VideoMultipartUploadFinalizePartsInner.md)\n - [Api42Vb.VideoMultipartUploadInit](docs/VideoMultipartUploadInit.md)\n - [Api42Vb.VideoMultipartUploadInitResponse](docs/VideoMultipartUploadInitResponse.md)\n - [Api42Vb.VideoMultipartUploadInitResponsePartsInner](docs/VideoMultipartUploadInitResponsePartsInner.md)\n - [Api42Vb.VideoProperties](docs/VideoProperties.md)\n - [Api42Vb.VideoStatus](docs/VideoStatus.md)\n - [Api42Vb.VideoUploadInitResponse](docs/VideoUploadInitResponse.md)\n - [Api42Vb.Webhook](docs/Webhook.md)\n - [Api42Vb.WebhookList](docs/WebhookList.md)\n - [Api42Vb.WebhookProperties](docs/WebhookProperties.md)\n\n\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n### api_key\n\n\n- **Type**: API key\n- **API key parameter name**: x-api-key\n- **Location**: HTTP header\n\n","readmeFilename":"README.md"}