twentythree-cli 1.0.0

package/docs/commands/README.md

@@ -0,0 +1,31 @@
+# Command Reference
+
+TwentyThree CLI provides 244 commands across 24 topics.
+
+| Topic | Description | Reference |
+|-------|-------------|-----------|
+| `action` | Create a new CTA action on a video or webinar | [docs](action.md) |
+| `analytics` | Get conversion analytics data | [docs](analytics.md) |
+| `app` | Create a new app integration | [docs](app.md) |
+| `audience` | List audience companies | [docs](audience.md) |
+| `auth` | Configure domain and bearer token for a TwentyThree workspace | [docs](auth.md) |
+| `category` | Manage categories -- list, create, update, and delete | [docs](category.md) |
+| `collector` | Block a collector from a video or webinar | [docs](collector.md) |
+| `comment` | Add a comment to an object | [docs](comment.md) |
+| `doctor` | Check CLI credentials, connectivity, and token validity | [docs](doctor.md) |
+| `openupload` | List open upload tokens in the active workspace | [docs](openupload.md) |
+| `player` | Delete a player from the active workspace | [docs](player.md) |
+| `poll` | Create a new poll for a webinar | [docs](poll.md) |
+| `presentation` | List available presentation page link locations | [docs](presentation.md) |
+| `protection` | Apply protection to content | [docs](protection.md) |
+| `session` | Get a session access token | [docs](session.md) |
+| `setting` | Update workspace settings (key=value pairs) | [docs](setting.md) |
+| `site` | Get site settings for the active workspace | [docs](site.md) |
+| `spot` | Get details of a specific spot | [docs](spot.md) |
+| `tag` | List tags in the active workspace | [docs](tag.md) |
+| `thumbnail` | Manage thumbnail templates -- list, add, update, delete, duplicate, data, and manage files | [docs](thumbnail.md) |
+| `user` | Create a new user | [docs](user.md) |
+| `video` | Manage videos -- upload, list, update, delete, and more | [docs](video.md) |
+| `webhook` | List available webhook event types | [docs](webhook.md) |
+| `webinar` | Manage webinars -- create, list, update, delete, and more | [docs](webinar.md) |
+| `workspace` | List all configured workspaces | [docs](workspace.md) |

package/docs/commands/action/add.md

@@ -0,0 +1,36 @@
+`twentythree action:add`
+========================
+
+Create a new CTA action on a video or webinar
+
+* [`twentythree action add`](#twentythree-action-add)
+
+## `twentythree action add`
+
+Create a new CTA action on a video or webinar
+
+```
+USAGE
+  $ twentythree action add --type <value> --object-id <value> [--json] [-w <value>] [--fields <value>]
+
+FLAGS
+  --fields=<value>     Additional fields for the action (key=value pairs)
+  --object-id=<value>  (required) Object ID (video or webinar) to attach the action to
+  --type=<value>       (required) Action type (use `action types` to list available types)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new CTA action on a video or webinar
+
+EXAMPLES
+  $ twentythree action add --type overlay --object-id 12345
+
+  $ twentythree action add --type overlay --object-id 12345 --fields "title=Buy Now"
+
+  $ twentythree action add --type overlay --object-id 12345 --json
+```
+
+_See code: [src/commands/action/add.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/add.ts)_

package/docs/commands/action/delete.md

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

package/docs/commands/action/exclude.md

@@ -0,0 +1,38 @@
+`twentythree action:exclude`
+============================
+
+Exclude a CTA action from an object (or undo an exclusion)
+
+* [`twentythree action exclude ID`](#twentythree-action-exclude-id)
+
+## `twentythree action exclude ID`
+
+Exclude a CTA action from an object (or undo an exclusion)
+
+```
+USAGE
+  $ twentythree action exclude ID --object-id <value> [--json] [-w <value>] [--undo]
+
+ARGUMENTS
+  ID  Action ID
+
+FLAGS
+  --object-id=<value>  (required) Object ID to exclude the action from
+  --undo               Remove the exclusion (reverse this operation)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Exclude a CTA action from an object (or undo an exclusion)
+
+EXAMPLES
+  $ twentythree action exclude 12345 --object-id 6789
+
+  $ twentythree action exclude 12345 --object-id 6789 --undo
+
+  $ twentythree action exclude 12345 --object-id 6789 --json
+```
+
+_See code: [src/commands/action/exclude.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/exclude.ts)_

package/docs/commands/action/get.md

@@ -0,0 +1,47 @@
+`twentythree action:get`
+========================
+
+Get details of a CTA action
+
+* [`twentythree action get [ID]`](#twentythree-action-get-id)
+
+## `twentythree action get [ID]`
+
+Get details of a CTA action
+
+```
+USAGE
+  $ twentythree action get [ID] [--json] [-w <value>] [--object-id <value>] [--video-id <value>] [--webinar-id
+    <value>] [--token <value>] [--player-id <value>] [--exclude-internal] [--exclude-pending] [--exclude-items]
+
+ARGUMENTS
+  [ID]  Action ID (optional)
+
+FLAGS
+  --exclude-internal    Exclude internal actions
+  --exclude-items       Exclude action items
+  --exclude-pending     Exclude pending actions
+  --object-id=<value>   Object ID context
+  --player-id=<value>   Player ID context
+  --token=<value>       Object token for authentication
+  --video-id=<value>    Video ID context (maps to photo_id)
+  --webinar-id=<value>  Webinar ID context (maps to live_id)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Get details of a CTA action
+
+EXAMPLES
+  $ twentythree action get 12345
+
+  $ twentythree action get --video-id 6789
+
+  $ twentythree action get --webinar-id 1234 --json
+
+  $ twentythree action get 12345 --json
+```
+
+_See code: [src/commands/action/get.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/get.ts)_

package/docs/commands/action/include.md

@@ -0,0 +1,38 @@
+`twentythree action:include`
+============================
+
+Include an object in a CTA action scope (or undo an inclusion)
+
+* [`twentythree action include ID`](#twentythree-action-include-id)
+
+## `twentythree action include ID`
+
+Include an object in a CTA action scope (or undo an inclusion)
+
+```
+USAGE
+  $ twentythree action include ID --object-id <value> [--json] [-w <value>] [--undo]
+
+ARGUMENTS
+  ID  Action ID
+
+FLAGS
+  --object-id=<value>  (required) Object ID to include the action on
+  --undo               Remove the inclusion (reverse this operation)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Include an object in a CTA action scope (or undo an inclusion)
+
+EXAMPLES
+  $ twentythree action include 12345 --object-id 6789
+
+  $ twentythree action include 12345 --object-id 6789 --undo
+
+  $ twentythree action include 12345 --object-id 6789 --json
+```
+
+_See code: [src/commands/action/include.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/include.ts)_

package/docs/commands/action/list.md

@@ -0,0 +1,43 @@
+`twentythree action:list`
+=========================
+
+List CTA actions for a video, webinar, or object
+
+* [`twentythree action list`](#twentythree-action-list)
+
+## `twentythree action list`
+
+List CTA actions for a video, webinar, or object
+
+```
+USAGE
+  $ twentythree action list [--json] [-w <value>] [--object-id <value>] [--video-id <value>] [--webinar-id
+    <value>] [--player-id <value>] [--exclude-internal] [--exclude-pending] [--exclude-items]
+
+FLAGS
+  --exclude-internal    Exclude internal actions
+  --exclude-items       Exclude action items
+  --exclude-pending     Exclude pending actions
+  --object-id=<value>   Object ID to filter actions by
+  --player-id=<value>   Player ID to filter actions by
+  --video-id=<value>    Video ID to filter actions by (maps to photo_id)
+  --webinar-id=<value>  Webinar ID to filter actions by (maps to live_id)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List CTA actions for a video, webinar, or object
+
+EXAMPLES
+  $ twentythree action list --video-id 12345
+
+  $ twentythree action list --webinar-id 6789
+
+  $ twentythree action list --object-id 12345
+
+  $ twentythree action list --video-id 12345 --json
+```
+
+_See code: [src/commands/action/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/list.ts)_

package/docs/commands/action/types.md

@@ -0,0 +1,34 @@
+`twentythree action:types`
+==========================
+
+List available CTA action types
+
+* [`twentythree action types`](#twentythree-action-types)
+
+## `twentythree action types`
+
+List available CTA action types
+
+```
+USAGE
+  $ twentythree action types [--json] [-w <value>] [--exclude-internal]
+
+FLAGS
+  --exclude-internal  Exclude internal action types from the list
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List available CTA action types
+
+EXAMPLES
+  $ twentythree action types
+
+  $ twentythree action types --exclude-internal
+
+  $ twentythree action types --json
+```
+
+_See code: [src/commands/action/types.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/types.ts)_

package/docs/commands/action/update.md

@@ -0,0 +1,42 @@
+`twentythree action:update`
+===========================
+
+Update an existing CTA action
+
+* [`twentythree action update ID`](#twentythree-action-update-id)
+
+## `twentythree action update ID`
+
+Update an existing CTA action
+
+```
+USAGE
+  $ twentythree action update ID --name <value> --start-time <value> --end-time <value> [--json] [-w <value>]
+    [--time-relative-to <value>] [--return-url <value>]
+
+ARGUMENTS
+  ID  Action ID
+
+FLAGS
+  --end-time=<value>          (required) End time of the action (seconds)
+  --name=<value>              (required) Display name for the action
+  --return-url=<value>        Return URL for the action
+  --start-time=<value>        (required) Start time of the action (seconds)
+  --time-relative-to=<value>  [default: duration] What the timing is relative to (default: duration)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update an existing CTA action
+
+EXAMPLES
+  $ twentythree action update 12345 --name "Buy Now" --start-time 10 --end-time 20
+
+  $ twentythree action update 12345 --name "Buy Now" --start-time 10 --end-time 20 --return-url "https://example.com"
+
+  $ twentythree action update 12345 --name "Buy Now" --start-time 10 --end-time 20 --json
+```
+
+_See code: [src/commands/action/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/update.ts)_

package/docs/commands/action/upload.md

@@ -0,0 +1,36 @@
+`twentythree action:upload`
+===========================
+
+Upload a file to an action variable
+
+* [`twentythree action upload ID VARIABLE-NAME FILE`](#twentythree-action-upload-id-variable-name-file)
+
+## `twentythree action upload ID VARIABLE-NAME FILE`
+
+Upload a file to an action variable
+
+```
+USAGE
+  $ twentythree action upload ID VARIABLE-NAME FILE [--json] [-w <value>]
+
+ARGUMENTS
+  ID             Action ID
+  VARIABLE-NAME  Variable name for the file upload
+  FILE           Path to the file to upload
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Upload a file to an action variable
+
+EXAMPLES
+  $ twentythree action upload 12345 image ./banner.png
+
+  $ twentythree action upload 12345 video ./clip.mp4
+
+  $ twentythree action upload 12345 image ./banner.png --json
+```
+
+_See code: [src/commands/action/upload.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/upload.ts)_

package/docs/commands/action.md

@@ -0,0 +1,306 @@
+`twentythree action`
+====================
+
+Create a new CTA action on a video or webinar
+
+* [`twentythree action add`](#twentythree-action-add)
+* [`twentythree action delete ID`](#twentythree-action-delete-id)
+* [`twentythree action exclude ID`](#twentythree-action-exclude-id)
+* [`twentythree action get [ID]`](#twentythree-action-get-id)
+* [`twentythree action include ID`](#twentythree-action-include-id)
+* [`twentythree action list`](#twentythree-action-list)
+* [`twentythree action types`](#twentythree-action-types)
+* [`twentythree action update ID`](#twentythree-action-update-id)
+* [`twentythree action upload ID VARIABLE-NAME FILE`](#twentythree-action-upload-id-variable-name-file)
+
+## `twentythree action add`
+
+Create a new CTA action on a video or webinar
+
+```
+USAGE
+  $ twentythree action add --type <value> --object-id <value> [--json] [-w <value>] [--fields <value>]
+
+FLAGS
+  --fields=<value>     Additional fields for the action (key=value pairs)
+  --object-id=<value>  (required) Object ID (video or webinar) to attach the action to
+  --type=<value>       (required) Action type (use `action types` to list available types)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new CTA action on a video or webinar
+
+EXAMPLES
+  $ twentythree action add --type overlay --object-id 12345
+
+  $ twentythree action add --type overlay --object-id 12345 --fields "title=Buy Now"
+
+  $ twentythree action add --type overlay --object-id 12345 --json
+```
+
+_See code: [src/commands/action/add.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/add.ts)_
+
+## `twentythree action delete ID`
+
+Delete a CTA action
+
+```
+USAGE
+  $ twentythree action delete ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Action ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Delete a CTA action
+
+EXAMPLES
+  $ twentythree action delete 12345
+
+  $ twentythree action delete 12345 --json
+```
+
+_See code: [src/commands/action/delete.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/delete.ts)_
+
+## `twentythree action exclude ID`
+
+Exclude a CTA action from an object (or undo an exclusion)
+
+```
+USAGE
+  $ twentythree action exclude ID --object-id <value> [--json] [-w <value>] [--undo]
+
+ARGUMENTS
+  ID  Action ID
+
+FLAGS
+  --object-id=<value>  (required) Object ID to exclude the action from
+  --undo               Remove the exclusion (reverse this operation)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Exclude a CTA action from an object (or undo an exclusion)
+
+EXAMPLES
+  $ twentythree action exclude 12345 --object-id 6789
+
+  $ twentythree action exclude 12345 --object-id 6789 --undo
+
+  $ twentythree action exclude 12345 --object-id 6789 --json
+```
+
+_See code: [src/commands/action/exclude.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/exclude.ts)_
+
+## `twentythree action get [ID]`
+
+Get details of a CTA action
+
+```
+USAGE
+  $ twentythree action get [ID] [--json] [-w <value>] [--object-id <value>] [--video-id <value>] [--webinar-id
+    <value>] [--token <value>] [--player-id <value>] [--exclude-internal] [--exclude-pending] [--exclude-items]
+
+ARGUMENTS
+  [ID]  Action ID (optional)
+
+FLAGS
+  --exclude-internal    Exclude internal actions
+  --exclude-items       Exclude action items
+  --exclude-pending     Exclude pending actions
+  --object-id=<value>   Object ID context
+  --player-id=<value>   Player ID context
+  --token=<value>       Object token for authentication
+  --video-id=<value>    Video ID context (maps to photo_id)
+  --webinar-id=<value>  Webinar ID context (maps to live_id)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Get details of a CTA action
+
+EXAMPLES
+  $ twentythree action get 12345
+
+  $ twentythree action get --video-id 6789
+
+  $ twentythree action get --webinar-id 1234 --json
+
+  $ twentythree action get 12345 --json
+```
+
+_See code: [src/commands/action/get.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/get.ts)_
+
+## `twentythree action include ID`
+
+Include an object in a CTA action scope (or undo an inclusion)
+
+```
+USAGE
+  $ twentythree action include ID --object-id <value> [--json] [-w <value>] [--undo]
+
+ARGUMENTS
+  ID  Action ID
+
+FLAGS
+  --object-id=<value>  (required) Object ID to include the action on
+  --undo               Remove the inclusion (reverse this operation)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Include an object in a CTA action scope (or undo an inclusion)
+
+EXAMPLES
+  $ twentythree action include 12345 --object-id 6789
+
+  $ twentythree action include 12345 --object-id 6789 --undo
+
+  $ twentythree action include 12345 --object-id 6789 --json
+```
+
+_See code: [src/commands/action/include.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/include.ts)_
+
+## `twentythree action list`
+
+List CTA actions for a video, webinar, or object
+
+```
+USAGE
+  $ twentythree action list [--json] [-w <value>] [--object-id <value>] [--video-id <value>] [--webinar-id
+    <value>] [--player-id <value>] [--exclude-internal] [--exclude-pending] [--exclude-items]
+
+FLAGS
+  --exclude-internal    Exclude internal actions
+  --exclude-items       Exclude action items
+  --exclude-pending     Exclude pending actions
+  --object-id=<value>   Object ID to filter actions by
+  --player-id=<value>   Player ID to filter actions by
+  --video-id=<value>    Video ID to filter actions by (maps to photo_id)
+  --webinar-id=<value>  Webinar ID to filter actions by (maps to live_id)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List CTA actions for a video, webinar, or object
+
+EXAMPLES
+  $ twentythree action list --video-id 12345
+
+  $ twentythree action list --webinar-id 6789
+
+  $ twentythree action list --object-id 12345
+
+  $ twentythree action list --video-id 12345 --json
+```
+
+_See code: [src/commands/action/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/list.ts)_
+
+## `twentythree action types`
+
+List available CTA action types
+
+```
+USAGE
+  $ twentythree action types [--json] [-w <value>] [--exclude-internal]
+
+FLAGS
+  --exclude-internal  Exclude internal action types from the list
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List available CTA action types
+
+EXAMPLES
+  $ twentythree action types
+
+  $ twentythree action types --exclude-internal
+
+  $ twentythree action types --json
+```
+
+_See code: [src/commands/action/types.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/types.ts)_
+
+## `twentythree action update ID`
+
+Update an existing CTA action
+
+```
+USAGE
+  $ twentythree action update ID --name <value> --start-time <value> --end-time <value> [--json] [-w <value>]
+    [--time-relative-to <value>] [--return-url <value>]
+
+ARGUMENTS
+  ID  Action ID
+
+FLAGS
+  --end-time=<value>          (required) End time of the action (seconds)
+  --name=<value>              (required) Display name for the action
+  --return-url=<value>        Return URL for the action
+  --start-time=<value>        (required) Start time of the action (seconds)
+  --time-relative-to=<value>  [default: duration] What the timing is relative to (default: duration)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update an existing CTA action
+
+EXAMPLES
+  $ twentythree action update 12345 --name "Buy Now" --start-time 10 --end-time 20
+
+  $ twentythree action update 12345 --name "Buy Now" --start-time 10 --end-time 20 --return-url "https://example.com"
+
+  $ twentythree action update 12345 --name "Buy Now" --start-time 10 --end-time 20 --json
+```
+
+_See code: [src/commands/action/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/update.ts)_
+
+## `twentythree action upload ID VARIABLE-NAME FILE`
+
+Upload a file to an action variable
+
+```
+USAGE
+  $ twentythree action upload ID VARIABLE-NAME FILE [--json] [-w <value>]
+
+ARGUMENTS
+  ID             Action ID
+  VARIABLE-NAME  Variable name for the file upload
+  FILE           Path to the file to upload
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Upload a file to an action variable
+
+EXAMPLES
+  $ twentythree action upload 12345 image ./banner.png
+
+  $ twentythree action upload 12345 video ./clip.mp4
+
+  $ twentythree action upload 12345 image ./banner.png --json
+```
+
+_See code: [src/commands/action/upload.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/action/upload.ts)_