@pbvision/partner-sdk 0.1.8 → 0.1.10

package/README.md

@@ -13,6 +13,7 @@ standard length game, so we'll notify your servers when the results are ready.
     - [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)
 - [After Video Processing is Done](#after-video-processing-is-done)
+  - [Callback Data](#callback-data)
 - [Video Guidelines](#video-guidelines)
 - [Reference Guide](#reference-guide)
 
@@ -21,7 +22,9 @@ standard length game, so we'll notify your servers when the results are ready.
 ### Step 1: Get API Access
 
 Email **[dev@pb.vision](mailto:dev@pb.vision)** to request API access for your
-account. We'll send you an API Key.
+account. Let us know which data you need access to (e.g. insights, stats) which
+is documented below in the [Callback Data](#callback-data) section. We'll send
+you an API Key after discussing your needs more in depth.
 
 ### Step 2: SDK Setup
 
@@ -60,7 +63,7 @@ curl -X POST \
      -H 'x-api-key: YOUR_API_KEY' \
      -H 'Content-Type: application/json' \
      -d '{"url": "https://YOUR_WEBHOOK_URL"}' \
-     https://api-ko3kowqi6a-uc.a.run.app/partner/webhook/set
+     https://api-2o2klzx4pa-uc.a.run.app/partner/webhook/set
 ```
 
 ### Send Videos
@@ -93,11 +96,9 @@ curl -X POST \
      -H 'x-api-key: YOUR_API_KEY' \
      -H 'Content-Type: application/json' \
      -d '{"url": "https://YOUR_VIDEO_URL", "userEmails": ["test@example.com"]}' \
-     https://api-ko3kowqi6a-uc.a.run.app/partner/add_video_by_url
+     https://api-2o2klzx4pa-uc.a.run.app/partner/add_video_by_url
 ```
 
-To use the production server instead of the test server, change `ko3kowqi6a` to `2o2klzx4pa`.
-
 #### Option 2: Upload your video
 
 You can directly upload your video from a file using the SDK too:
@@ -145,6 +146,8 @@ data is enabled for your API key, only some of these fields may be present):
 }
 ```
 
+### Callback Data
+
 - `from_url` is the video url you sent us in [step 3](#send-videos)
 - `webpage` is a link to our web app where the stats can be explored
 - `error` is only present if your video could not be processed

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.8",
+  "version": "0.1.10",
   "license": "MIT",
   "type": "module",
   "engines": {

package/src/index.js

@@ -62,13 +62,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 +102,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 +115,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 }