twentythree-cli 1.0.0

package/docs/commands/openupload.md

@@ -0,0 +1,105 @@
+`twentythree openupload`
+========================
+
+List open upload tokens in the active workspace
+
+* [`twentythree openupload list`](#twentythree-openupload-list)
+* [`twentythree openupload update-file`](#twentythree-openupload-update-file)
+* [`twentythree openupload upload-file`](#twentythree-openupload-upload-file)
+
+## `twentythree openupload list`
+
+List open upload tokens in the active workspace
+
+```
+USAGE
+  $ twentythree openupload list [--json] [-w <value>] [--token-upload-id <value>] [--token <value>] [--app]
+
+FLAGS
+  --app                      Filter by app open uploads
+  --token=<value>            Filter by open upload token
+  --token-upload-id=<value>  Filter by open upload token upload ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List open upload tokens in the active workspace
+
+EXAMPLES
+  $ twentythree openupload list
+
+  $ twentythree openupload list --token-upload-id 123
+
+  $ twentythree openupload list --json
+```
+
+_See code: [src/commands/openupload/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/openupload/list.ts)_
+
+## `twentythree openupload update-file`
+
+Update metadata for an open upload entry
+
+```
+USAGE
+  $ twentythree openupload update-file --token-upload-id <value> --token <value> --upload-key <value> [--json] [-w <value>]
+    [--title <value>] [--description <value>] [--tags <value>]
+
+FLAGS
+  --description=<value>      New description for the uploaded file
+  --tags=<value>             Tags for the uploaded file (space-separated)
+  --title=<value>            New title for the uploaded file
+  --token=<value>            (required) Open upload token
+  --token-upload-id=<value>  (required) Open upload token upload ID
+  --upload-key=<value>       (required) Upload key identifying the uploaded file
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update metadata for an open upload entry
+
+EXAMPLES
+  $ twentythree openupload update-file --token-upload-id 123 --token abc123 --upload-key key456 --title "My Video"
+
+  $ twentythree openupload update-file --token-upload-id 123 --token abc123 --upload-key key456 --tags "demo tutorial"
+
+  $ twentythree openupload update-file --token-upload-id 123 --token abc123 --upload-key key456 --json
+```
+
+_See code: [src/commands/openupload/update-file.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/openupload/update-file.ts)_
+
+## `twentythree openupload upload-file`
+
+Upload a file via an open upload token using the chunked upload engine
+
+```
+USAGE
+  $ twentythree openupload upload-file --file-path <value> --token-upload-id <value> --token <value> [--json] [-w <value>]
+    [--chunk-size <value>] [--concurrency <value>]
+
+FLAGS
+  --chunk-size=<value>       [default: 5242880] Chunk size in bytes (default: 5242880 = 100MB)
+  --concurrency=<value>      [default: 5] Number of chunks to upload in parallel (default: 5)
+  --file-path=<value>        (required) Path to the file to upload
+  --token=<value>            (required) Open upload token
+  --token-upload-id=<value>  (required) Open upload token upload ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Upload a file via an open upload token using the chunked upload engine
+
+EXAMPLES
+  $ twentythree openupload upload-file --file-path ./video.mp4 --token-upload-id 123 --token abc123
+
+  $ twentythree openupload upload-file --file-path ./video.mp4 --token-upload-id 123 --token abc123 --chunk-size 52428800
+
+  $ twentythree openupload upload-file --file-path ./video.mp4 --token-upload-id 123 --token abc123 --json
+```
+
+_See code: [src/commands/openupload/upload-file.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/openupload/upload-file.ts)_

package/docs/commands/player/delete.md

@@ -0,0 +1,32 @@
+`twentythree player:delete`
+===========================
+
+Delete a player from the active workspace
+
+* [`twentythree player delete ID`](#twentythree-player-delete-id)
+
+## `twentythree player delete ID`
+
+Delete a player from the active workspace
+
+```
+USAGE
+  $ twentythree player delete ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Player ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Delete a player from the active workspace
+
+EXAMPLES
+  $ twentythree player delete 42
+
+  $ twentythree player delete 42 --json
+```
+
+_See code: [src/commands/player/delete.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/delete.ts)_

package/docs/commands/player/embed-versions.md

@@ -0,0 +1,34 @@
+`twentythree player:embed-versions`
+===================================
+
+List available embed versions for an object
+
+* [`twentythree player embed-versions`](#twentythree-player-embed-versions)
+
+## `twentythree player embed-versions`
+
+List available embed versions for an object
+
+```
+USAGE
+  $ twentythree player embed-versions --object-type <value> --object-id <value> [--json] [-w <value>] [--source <value>]
+
+FLAGS
+  --object-id=<value>    (required) Object ID
+  --object-type=<value>  (required) Object type: photo, live, album, or site
+  --source=<value>       Embed source parameter (e.g. embed, share)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List available embed versions for an object
+
+EXAMPLES
+  $ twentythree player embed-versions --object-type photo --object-id 123
+
+  $ twentythree player embed-versions --object-type live --object-id 456 --json
+```
+
+_See code: [src/commands/player/embed-versions.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/embed-versions.ts)_

package/docs/commands/player/embed.md

@@ -0,0 +1,51 @@
+`twentythree player:embed`
+==========================
+
+Generate embed code for a video, webinar, or category
+
+* [`twentythree player embed`](#twentythree-player-embed)
+
+## `twentythree player embed`
+
+Generate embed code for a video, webinar, or category
+
+```
+USAGE
+  $ twentythree player embed [--json] [-w <value>] [--video-id <value>] [--webinar-id <value>] [--category-id
+    <value>] [--player-id <value>] [--url <value>] [--width <value>] [--height <value>] [--responsive] [--autoplay]
+    [--iframe] [--start <value>] [--include-unpublished] [--token <value>] [--source <value>]
+
+FLAGS
+  --[no-]autoplay             Enable auto-play in the embed code (maps to autoplay_p)
+  --category-id=<value>       Category ID to embed (maps to album_id)
+  --height=<value>            Desired embed height in pixels
+  --[no-]iframe               Return an iframe-based embed code (maps to iframe_p)
+  --[no-]include-unpublished  Include unpublished content in player parameters (maps to include_unpublished_p)
+  --player-id=<value>         Player ID to use (default: workspace default)
+  --[no-]responsive           Return a responsive embed code (maps to responsive_p)
+  --source=<value>            Analytics source tag
+  --start=<value>             Start position in seconds
+  --token=<value>             Video token for private or token-protected videos
+  --url=<value>               Workspace URL to resolve to an embed code
+  --video-id=<value>          Video ID to embed (maps to photo_id)
+  --webinar-id=<value>        Webinar ID to embed (maps to live_id)
+  --width=<value>             Desired embed width in pixels
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Generate embed code for a video, webinar, or category
+
+EXAMPLES
+  $ twentythree player embed --video-id 123
+
+  $ twentythree player embed --video-id 123 --responsive > embed.html
+
+  $ twentythree player embed --webinar-id 456 --iframe
+
+  $ twentythree player embed --video-id 123 --json
+```
+
+_See code: [src/commands/player/embed.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/embed.ts)_

package/docs/commands/player/list.md

@@ -0,0 +1,32 @@
+`twentythree player:list`
+=========================
+
+List players in the active workspace
+
+* [`twentythree player list`](#twentythree-player-list)
+
+## `twentythree player list`
+
+List players in the active workspace
+
+```
+USAGE
+  $ twentythree player list [--json] [-w <value>] [--source <value>]
+
+FLAGS
+  --source=<value>  Analytics source tag
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List players in the active workspace
+
+EXAMPLES
+  $ twentythree player list
+
+  $ twentythree player list --json
+```
+
+_See code: [src/commands/player/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/list.ts)_

package/docs/commands/player/styles.md

@@ -0,0 +1,32 @@
+`twentythree player:styles`
+===========================
+
+List available player visual styles
+
+* [`twentythree player styles`](#twentythree-player-styles)
+
+## `twentythree player styles`
+
+List available player visual styles
+
+```
+USAGE
+  $ twentythree player styles [--json] [-w <value>] [--fields <value>]
+
+FLAGS
+  --fields=<value>  Comma-separated list of fields to return
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List available player visual styles
+
+EXAMPLES
+  $ twentythree player styles
+
+  $ twentythree player styles --json
+```
+
+_See code: [src/commands/player/styles.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/styles.ts)_

package/docs/commands/player/update.md

@@ -0,0 +1,37 @@
+`twentythree player:update`
+===========================
+
+Update settings for a player
+
+* [`twentythree player update ID`](#twentythree-player-update-id)
+
+## `twentythree player update ID`
+
+Update settings for a player
+
+```
+USAGE
+  $ twentythree player update ID [--json] [-w <value>] [--name <value>] [--description <value>] [--data <value>]
+
+ARGUMENTS
+  ID  Player ID
+
+FLAGS
+  --data=<value>         JSON-encoded player properties to merge into the request body
+  --description=<value>  New description for the player
+  --name=<value>         New name for the player
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update settings for a player
+
+EXAMPLES
+  $ twentythree player update 42 --name "My Player"
+
+  $ twentythree player update 42 --description "New description"
+```
+
+_See code: [src/commands/player/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/update.ts)_

package/docs/commands/player.md

@@ -0,0 +1,193 @@
+`twentythree player`
+====================
+
+Delete a player from the active workspace
+
+* [`twentythree player delete ID`](#twentythree-player-delete-id)
+* [`twentythree player embed`](#twentythree-player-embed)
+* [`twentythree player embed-versions`](#twentythree-player-embed-versions)
+* [`twentythree player list`](#twentythree-player-list)
+* [`twentythree player styles`](#twentythree-player-styles)
+* [`twentythree player update ID`](#twentythree-player-update-id)
+
+## `twentythree player delete ID`
+
+Delete a player from the active workspace
+
+```
+USAGE
+  $ twentythree player delete ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Player ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Delete a player from the active workspace
+
+EXAMPLES
+  $ twentythree player delete 42
+
+  $ twentythree player delete 42 --json
+```
+
+_See code: [src/commands/player/delete.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/delete.ts)_
+
+## `twentythree player embed`
+
+Generate embed code for a video, webinar, or category
+
+```
+USAGE
+  $ twentythree player embed [--json] [-w <value>] [--video-id <value>] [--webinar-id <value>] [--category-id
+    <value>] [--player-id <value>] [--url <value>] [--width <value>] [--height <value>] [--responsive] [--autoplay]
+    [--iframe] [--start <value>] [--include-unpublished] [--token <value>] [--source <value>]
+
+FLAGS
+  --[no-]autoplay             Enable auto-play in the embed code (maps to autoplay_p)
+  --category-id=<value>       Category ID to embed (maps to album_id)
+  --height=<value>            Desired embed height in pixels
+  --[no-]iframe               Return an iframe-based embed code (maps to iframe_p)
+  --[no-]include-unpublished  Include unpublished content in player parameters (maps to include_unpublished_p)
+  --player-id=<value>         Player ID to use (default: workspace default)
+  --[no-]responsive           Return a responsive embed code (maps to responsive_p)
+  --source=<value>            Analytics source tag
+  --start=<value>             Start position in seconds
+  --token=<value>             Video token for private or token-protected videos
+  --url=<value>               Workspace URL to resolve to an embed code
+  --video-id=<value>          Video ID to embed (maps to photo_id)
+  --webinar-id=<value>        Webinar ID to embed (maps to live_id)
+  --width=<value>             Desired embed width in pixels
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Generate embed code for a video, webinar, or category
+
+EXAMPLES
+  $ twentythree player embed --video-id 123
+
+  $ twentythree player embed --video-id 123 --responsive > embed.html
+
+  $ twentythree player embed --webinar-id 456 --iframe
+
+  $ twentythree player embed --video-id 123 --json
+```
+
+_See code: [src/commands/player/embed.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/embed.ts)_
+
+## `twentythree player embed-versions`
+
+List available embed versions for an object
+
+```
+USAGE
+  $ twentythree player embed-versions --object-type <value> --object-id <value> [--json] [-w <value>] [--source <value>]
+
+FLAGS
+  --object-id=<value>    (required) Object ID
+  --object-type=<value>  (required) Object type: photo, live, album, or site
+  --source=<value>       Embed source parameter (e.g. embed, share)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List available embed versions for an object
+
+EXAMPLES
+  $ twentythree player embed-versions --object-type photo --object-id 123
+
+  $ twentythree player embed-versions --object-type live --object-id 456 --json
+```
+
+_See code: [src/commands/player/embed-versions.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/embed-versions.ts)_
+
+## `twentythree player list`
+
+List players in the active workspace
+
+```
+USAGE
+  $ twentythree player list [--json] [-w <value>] [--source <value>]
+
+FLAGS
+  --source=<value>  Analytics source tag
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List players in the active workspace
+
+EXAMPLES
+  $ twentythree player list
+
+  $ twentythree player list --json
+```
+
+_See code: [src/commands/player/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/list.ts)_
+
+## `twentythree player styles`
+
+List available player visual styles
+
+```
+USAGE
+  $ twentythree player styles [--json] [-w <value>] [--fields <value>]
+
+FLAGS
+  --fields=<value>  Comma-separated list of fields to return
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List available player visual styles
+
+EXAMPLES
+  $ twentythree player styles
+
+  $ twentythree player styles --json
+```
+
+_See code: [src/commands/player/styles.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/styles.ts)_
+
+## `twentythree player update ID`
+
+Update settings for a player
+
+```
+USAGE
+  $ twentythree player update ID [--json] [-w <value>] [--name <value>] [--description <value>] [--data <value>]
+
+ARGUMENTS
+  ID  Player ID
+
+FLAGS
+  --data=<value>         JSON-encoded player properties to merge into the request body
+  --description=<value>  New description for the player
+  --name=<value>         New name for the player
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update settings for a player
+
+EXAMPLES
+  $ twentythree player update 42 --name "My Player"
+
+  $ twentythree player update 42 --description "New description"
+```
+
+_See code: [src/commands/player/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/player/update.ts)_

package/docs/commands/poll/add.md

@@ -0,0 +1,33 @@
+`twentythree poll:add`
+======================
+
+Create a new poll for a webinar
+
+* [`twentythree poll add`](#twentythree-poll-add)
+
+## `twentythree poll add`
+
+Create a new poll for a webinar
+
+```
+USAGE
+  $ twentythree poll add --object-id <value> [--json] [-w <value>] [--question <value>]
+
+FLAGS
+  --object-id=<value>  (required) Object ID (webinar or live object)
+  --question=<value>   Poll question
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new poll for a webinar
+
+EXAMPLES
+  $ twentythree poll add --object-id 12345 --question "What is your preference?"
+
+  $ twentythree poll add --object-id 12345 --question "How are you?" --json
+```
+
+_See code: [src/commands/poll/add.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/poll/add.ts)_

package/docs/commands/poll/answer.md

@@ -0,0 +1,38 @@
+`twentythree poll:answer`
+=========================
+
+Submit a poll answer
+
+* [`twentythree poll answer ID`](#twentythree-poll-answer-id)
+
+## `twentythree poll answer ID`
+
+Submit a poll answer
+
+```
+USAGE
+  $ twentythree poll answer ID [--json] [-w <value>] [--object-id <value>] [--object-token <value>] [--option-id
+    <value>]
+
+ARGUMENTS
+  ID  Poll ID
+
+FLAGS
+  --object-id=<value>     Object ID (webinar or live object)
+  --object-token=<value>  Object token (auto-looked up if omitted)
+  --option-id=<value>     Poll option ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Submit a poll answer
+
+EXAMPLES
+  $ twentythree poll answer 99 --object-id 12345 --option-id 3
+
+  $ twentythree poll answer 99 --object-id 12345 --option-id 3 --json
+```
+
+_See code: [src/commands/poll/answer.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/poll/answer.ts)_

package/docs/commands/poll/list.md

@@ -0,0 +1,33 @@
+`twentythree poll:list`
+=======================
+
+List polls for a webinar
+
+* [`twentythree poll list`](#twentythree-poll-list)
+
+## `twentythree poll list`
+
+List polls for a webinar
+
+```
+USAGE
+  $ twentythree poll list --object-id <value> [--json] [-w <value>] [--object-token <value>]
+
+FLAGS
+  --object-id=<value>     (required) Object ID (webinar or live object)
+  --object-token=<value>  Object token (auto-looked up if omitted)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List polls for a webinar
+
+EXAMPLES
+  $ twentythree poll list --object-id 12345
+
+  $ twentythree poll list --object-id 12345 --json
+```
+
+_See code: [src/commands/poll/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/poll/list.ts)_

package/docs/commands/poll/remove.md

@@ -0,0 +1,32 @@
+`twentythree poll:remove`
+=========================
+
+Remove a poll
+
+* [`twentythree poll remove ID`](#twentythree-poll-remove-id)
+
+## `twentythree poll remove ID`
+
+Remove a poll
+
+```
+USAGE
+  $ twentythree poll remove ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Poll ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Remove a poll
+
+EXAMPLES
+  $ twentythree poll remove 99
+
+  $ twentythree poll remove 99 --json
+```
+
+_See code: [src/commands/poll/remove.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/poll/remove.ts)_