@pbvision/partner-sdk 0.1.9 → 0.1.11

package/README.md

@@ -12,6 +12,7 @@ standard length game, so we'll notify your servers when the results are ready.
   - [Send Videos](#send-videos)
     - [Option 1: PBV downloads your video from a URL](#option-1-pbv-downloads-your-video-from-a-url)
     - [Option 2: Upload your video](#option-2-upload-your-video)
+  - [Video Editors](#video-editors)
 - [After Video Processing is Done](#after-video-processing-is-done)
   - [Callback Data](#callback-data)
 - [Video Guidelines](#video-guidelines)
@@ -117,10 +118,21 @@ const optionalMetadata = {
 await pbv.uploadVideo(YOUR_VIDEO_FILENAME, optionalMetadata);
 ```
 
+### Video Editors
+
+Editors can tag themselves and friends in the video. They also have access to
+the video even if the video is private (to make uploaded by your partner
+account private by default, please email us).
+
+You can get the current list of editors on a video by using the `getVideoEditors()`
+method. Similarly, the `setVideoEditors()` method can be used to change the
+email addresses which have editor access on your video.
+
 ## After Video Processing is Done
 
 When our AI is done processing your video, we will email the players in the
-game (_if_ their email addresses were provided via `userEmails`).
+game (_if_ their email addresses were provided via `userEmails`). These users
+will be "editors" on the video and be able to tag themselves and their friends.
 
 If you [provided a webhook](#webhook-setup), then we'll send
 an HTTP POST request to your server. Your server should acknowledge this

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pbvision/partner-sdk",
   "description": "SDK for interacting with the PB Vision pickleball AI engine.",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "license": "MIT",
   "type": "module",
   "engines": {

package/src/index.js

@@ -47,6 +47,28 @@ export class PBVision {
     return this.__callAPI('webhook/set', { url: webhookUrl })
   }
 
+  /**
+   * Gets the email addresses (if any) which have editor access to a video your
+   * partner account uploaded.
+   *
+   * @param {string} vid video id
+   */
+  async getVideoEditors (vid) {
+    return this.__callAPI('video/editors/get', { vid })
+  }
+
+  /**
+   * Sets the email addresses (if any) which have editor access to a video your
+   * partner account uploaded.
+   *
+   * @param {string} vid video id
+   * @param {Array<string>} editorEmails a list of 0 to 4 email addresses to
+   *   allow edit access to the video (replaces any previous editors list).
+   */
+  async setVideoEditors (vid, editorEmails) {
+    return this.__callAPI('video/editors/set', { vid, editorEmails })
+  }
+
   /**
    * @typedef {Object} VideoUrlToDownloadResponse
    * @property {string} vid the ID of the new video
@@ -62,13 +84,13 @@ export class PBVision {
    * @param {VideoMetadata} [metadata]
    * @returns {VideoUrlToDownloadResponse}
    */
-  async sendVideoUrlToDownload (videoUrl, { userEmails = [], name, desc, gameStartEpoch, facility, court } = {}) {
+  async sendVideoUrlToDownload (videoUrl, { userEmails = [], name, desc, gameStartEpoch, facility, court, fid } = {}) {
     assert(typeof videoUrl === 'string' && videoUrl.startsWith('http'),
       'URL must be a string beginning with http')
     assert(videoUrl.split('?')[0].endsWith('.mp4'), 'video URL must have the .mp4 extension')
     const resp = await this.__callAPI(
       'add_video_by_url',
-      { url: videoUrl, userEmails, name, desc, gameStartEpoch, facility, court })
+      { url: videoUrl, userEmails, name, desc, gameStartEpoch, facility, court, fid })
     return JSON.parse(resp)
   }
 
@@ -102,6 +124,7 @@ export class PBVision {
    * @property {integer} [gameStartEpoch] the epoch at which the game started
    * @property {string} [facility] the facility where the game was recorded (e.g., "Cool Club #3 - Barcelona")
    * @property {string} [court] the court where the game was recorded (e.g., "11A")
+   * @property {integer} [fid] the ID of the folder in which this video should be added
    */
 
   /**
@@ -114,10 +137,10 @@ export class PBVision {
    * @param {VideoMetadata} [metadata]
    * @returns {VideoUrlToDownloadResponse}
    */
-  async uploadVideo (mp4Filename, { userEmails = [], name, desc, gameStartEpoch, facility, court } = {}) {
+  async uploadVideo (mp4Filename, { userEmails = [], name, desc, gameStartEpoch, facility, court, fid } = {}) {
     const pieces = mp4Filename.split('.')
     const ext = pieces[pieces.length - 1]
-    const makeVIDResp = await this.__callAPI('make_video_id', { userEmails, name, desc, gameStartEpoch, facility, court, fileExt: ext })
+    const makeVIDResp = await this.__callAPI('make_video_id', { userEmails, name, desc, gameStartEpoch, facility, court, fid, fileExt: ext })
     const { hasCredits, vid } = JSON.parse(makeVIDResp)
     if (hasCredits === false) {
       return { hasCredits }