twentythree-cli 1.0.0

package/docs/commands/spot.md

@@ -0,0 +1,222 @@
+`twentythree spot`
+==================
+
+Get details of a specific spot
+
+* [`twentythree spot check ID`](#twentythree-spot-check-id)
+* [`twentythree spot create`](#twentythree-spot-create)
+* [`twentythree spot delete ID`](#twentythree-spot-delete-id)
+* [`twentythree spot list`](#twentythree-spot-list)
+* [`twentythree spot reset-version ID`](#twentythree-spot-reset-version-id)
+* [`twentythree spot set-videos ID`](#twentythree-spot-set-videos-id)
+* [`twentythree spot update ID`](#twentythree-spot-update-id)
+
+## `twentythree spot check ID`
+
+Get details of a specific spot
+
+```
+USAGE
+  $ twentythree spot check ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Spot 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 specific spot
+
+EXAMPLES
+  $ twentythree spot check 12345
+
+  $ twentythree spot check 12345 --json
+```
+
+_See code: [src/commands/spot/check.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/check.ts)_
+
+## `twentythree spot create`
+
+Create a new spot
+
+```
+USAGE
+  $ twentythree spot create --spot-name <value> [--json] [-w <value>] [--spot-type <value>] [--spot-design
+    <value>] [--spot-layout <value>]
+
+FLAGS
+  --spot-design=<value>  Design for the spot
+  --spot-layout=<value>  Layout for the spot
+  --spot-name=<value>    (required) Name for the new spot
+  --spot-type=<value>    Type of spot
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new spot
+
+EXAMPLES
+  $ twentythree spot create --spot-name "My Spot"
+
+  $ twentythree spot create --spot-name "My Spot" --spot-type "video"
+
+  $ twentythree spot create --spot-name "My Spot" --json
+```
+
+_See code: [src/commands/spot/create.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/create.ts)_
+
+## `twentythree spot delete ID`
+
+Delete a spot from the active workspace
+
+```
+USAGE
+  $ twentythree spot delete ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Spot ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Delete a spot from the active workspace
+
+EXAMPLES
+  $ twentythree spot delete 12345
+
+  $ twentythree spot delete 12345 --json
+```
+
+_See code: [src/commands/spot/delete.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/delete.ts)_
+
+## `twentythree spot list`
+
+List spots in the active workspace
+
+```
+USAGE
+  $ twentythree spot list [--json] [-w <value>] [--page <value>] [--size <value>] [--search <value>]
+    [--spot-type <value>] [--active] [--orderby <value>] [--order <value>]
+
+FLAGS
+  --[no-]active        Filter by active status
+  --order=<value>      Sort order (asc or desc)
+  --orderby=<value>    Field to order results by
+  --page=<value>       Page number
+  --search=<value>     Search term
+  --size=<value>       Number of results per page
+  --spot-type=<value>  Filter by spot type
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List spots in the active workspace
+
+EXAMPLES
+  $ twentythree spot list
+
+  $ twentythree spot list --search "my spot"
+
+  $ twentythree spot list --active
+
+  $ twentythree spot list --json
+```
+
+_See code: [src/commands/spot/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/list.ts)_
+
+## `twentythree spot reset-version ID`
+
+Reset the version of a spot
+
+```
+USAGE
+  $ twentythree spot reset-version ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Spot ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Reset the version of a spot
+
+EXAMPLES
+  $ twentythree spot reset-version 12345
+
+  $ twentythree spot reset-version 12345 --json
+```
+
+_See code: [src/commands/spot/reset-version.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/reset-version.ts)_
+
+## `twentythree spot set-videos ID`
+
+Assign videos to a spot
+
+```
+USAGE
+  $ twentythree spot set-videos ID --videos <value> [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Spot ID
+
+FLAGS
+  --videos=<value>  (required) Comma-separated video IDs to assign to the spot
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Assign videos to a spot
+
+EXAMPLES
+  $ twentythree spot set-videos 12345 --videos "111,222,333"
+
+  $ twentythree spot set-videos 12345 --videos "111" --json
+```
+
+_See code: [src/commands/spot/set-videos.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/set-videos.ts)_
+
+## `twentythree spot update ID`
+
+Update a spot
+
+```
+USAGE
+  $ twentythree spot update ID [--json] [-w <value>] [--spot-name <value>] [--active]
+
+ARGUMENTS
+  ID  Spot ID
+
+FLAGS
+  --[no-]active        Set active status
+  --spot-name=<value>  New name for the spot
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update a spot
+
+EXAMPLES
+  $ twentythree spot update 12345 --spot-name "New Name"
+
+  $ twentythree spot update 12345 --active
+
+  $ twentythree spot update 12345 --no-active
+
+  $ twentythree spot update 12345 --spot-name "New Name" --json
+```
+
+_See code: [src/commands/spot/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/spot/update.ts)_

package/docs/commands/tag/list.md

@@ -0,0 +1,44 @@
+`twentythree tag:list`
+======================
+
+List tags in the active workspace
+
+* [`twentythree tag list`](#twentythree-tag-list)
+
+## `twentythree tag list`
+
+List tags in the active workspace
+
+```
+USAGE
+  $ twentythree tag list [--json] [-w <value>] [--search <value>] [--exclude-machine-tags]
+    [--only-machine-tags] [--only-published] [--orderby tag|count] [--order asc|desc]
+
+FLAGS
+  --exclude-machine-tags  Exclude machine tags from the results
+  --only-machine-tags     Return only machine tags (overrides --exclude-machine-tags)
+  --only-published        Return only tags from published videos
+  --order=<option>        Sort order for the results
+                          <options: asc|desc>
+  --orderby=<option>      Order tags by this value
+                          <options: tag|count>
+  --search=<value>        Filter tags by a search string
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List tags in the active workspace
+
+EXAMPLES
+  $ twentythree tag list
+
+  $ twentythree tag list --search marketing
+
+  $ twentythree tag list --orderby count --order desc
+
+  $ twentythree tag list --json
+```
+
+_See code: [src/commands/tag/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/tag/list.ts)_

package/docs/commands/tag/related.md

@@ -0,0 +1,32 @@
+`twentythree tag:related`
+=========================
+
+List tags related to a given tag
+
+* [`twentythree tag related TAG`](#twentythree-tag-related-tag)
+
+## `twentythree tag related TAG`
+
+List tags related to a given tag
+
+```
+USAGE
+  $ twentythree tag related TAG [--json] [-w <value>]
+
+ARGUMENTS
+  TAG  Tag to find related tags for
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List tags related to a given tag
+
+EXAMPLES
+  $ twentythree tag related marketing
+
+  $ twentythree tag related marketing --json
+```
+
+_See code: [src/commands/tag/related.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/tag/related.ts)_

package/docs/commands/tag.md

@@ -0,0 +1,71 @@
+`twentythree tag`
+=================
+
+List tags in the active workspace
+
+* [`twentythree tag list`](#twentythree-tag-list)
+* [`twentythree tag related TAG`](#twentythree-tag-related-tag)
+
+## `twentythree tag list`
+
+List tags in the active workspace
+
+```
+USAGE
+  $ twentythree tag list [--json] [-w <value>] [--search <value>] [--exclude-machine-tags]
+    [--only-machine-tags] [--only-published] [--orderby tag|count] [--order asc|desc]
+
+FLAGS
+  --exclude-machine-tags  Exclude machine tags from the results
+  --only-machine-tags     Return only machine tags (overrides --exclude-machine-tags)
+  --only-published        Return only tags from published videos
+  --order=<option>        Sort order for the results
+                          <options: asc|desc>
+  --orderby=<option>      Order tags by this value
+                          <options: tag|count>
+  --search=<value>        Filter tags by a search string
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List tags in the active workspace
+
+EXAMPLES
+  $ twentythree tag list
+
+  $ twentythree tag list --search marketing
+
+  $ twentythree tag list --orderby count --order desc
+
+  $ twentythree tag list --json
+```
+
+_See code: [src/commands/tag/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/tag/list.ts)_
+
+## `twentythree tag related TAG`
+
+List tags related to a given tag
+
+```
+USAGE
+  $ twentythree tag related TAG [--json] [-w <value>]
+
+ARGUMENTS
+  TAG  Tag to find related tags for
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List tags related to a given tag
+
+EXAMPLES
+  $ twentythree tag related marketing
+
+  $ twentythree tag related marketing --json
+```
+
+_See code: [src/commands/tag/related.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/tag/related.ts)_

package/docs/commands/thumbnail/add.md

@@ -0,0 +1,33 @@
+`twentythree thumbnail:add`
+===========================
+
+Create a new thumbnail template
+
+* [`twentythree thumbnail add`](#twentythree-thumbnail-add)
+
+## `twentythree thumbnail add`
+
+Create a new thumbnail template
+
+```
+USAGE
+  $ twentythree thumbnail add --name <value> --liquid-template <value> [--json] [-w <value>]
+
+FLAGS
+  --liquid-template=<value>  (required) Liquid template content for the thumbnail
+  --name=<value>             (required) Name for the new thumbnail template
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new thumbnail template
+
+EXAMPLES
+  $ twentythree thumbnail add --name "My Template" --liquid-template "<div>{{ video.title }}</div>"
+
+  $ twentythree thumbnail add --name "My Template" --liquid-template "<div>{{ video.title }}</div>" --json
+```
+
+_See code: [src/commands/thumbnail/add.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/add.ts)_

package/docs/commands/thumbnail/data.md

@@ -0,0 +1,35 @@
+`twentythree thumbnail:data`
+============================
+
+Get Liquid render data for a thumbnail template and object
+
+* [`twentythree thumbnail data ID`](#twentythree-thumbnail-data-id)
+
+## `twentythree thumbnail data ID`
+
+Get Liquid render data for a thumbnail template and object
+
+```
+USAGE
+  $ twentythree thumbnail data ID --object-id <value> [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Thumbnail template ID
+
+FLAGS
+  --object-id=<value>  (required) Object ID to get template data for
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Get Liquid render data for a thumbnail template and object
+
+EXAMPLES
+  $ twentythree thumbnail data 42 --object-id 12345
+
+  $ twentythree thumbnail data 42 --object-id 12345 --json
+```
+
+_See code: [src/commands/thumbnail/data.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/data.ts)_

package/docs/commands/thumbnail/delete.md

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

package/docs/commands/thumbnail/duplicate.md

@@ -0,0 +1,37 @@
+`twentythree thumbnail:duplicate`
+=================================
+
+Duplicate a thumbnail template
+
+* [`twentythree thumbnail duplicate ID`](#twentythree-thumbnail-duplicate-id)
+
+## `twentythree thumbnail duplicate ID`
+
+Duplicate a thumbnail template
+
+```
+USAGE
+  $ twentythree thumbnail duplicate ID [--json] [-w <value>] [--name <value>]
+
+ARGUMENTS
+  ID  Thumbnail template ID
+
+FLAGS
+  --name=<value>  Name for the duplicate
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Duplicate a thumbnail template
+
+EXAMPLES
+  $ twentythree thumbnail duplicate 42
+
+  $ twentythree thumbnail duplicate 42 --name "My Copy"
+
+  $ twentythree thumbnail duplicate 42 --name "My Copy" --json
+```
+
+_See code: [src/commands/thumbnail/duplicate.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/duplicate.ts)_

package/docs/commands/thumbnail/file.md

@@ -0,0 +1,90 @@
+`twentythree thumbnail:file`
+============================
+
+Delete a file from a thumbnail template
+
+* [`twentythree thumbnail file delete`](#twentythree-thumbnail-file-delete)
+* [`twentythree thumbnail file list ID`](#twentythree-thumbnail-file-list-id)
+* [`twentythree thumbnail file upload FILE`](#twentythree-thumbnail-file-upload-file)
+
+## `twentythree thumbnail file delete`
+
+Delete a file from a thumbnail template
+
+```
+USAGE
+  $ twentythree thumbnail file delete --template-id <value> --filename <value> [--json] [-w <value>]
+
+FLAGS
+  --filename=<value>     (required) Filename to delete
+  --template-id=<value>  (required) Thumbnail template ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Delete a file from a thumbnail template
+
+EXAMPLES
+  $ twentythree thumbnail file delete --template-id 42 --filename logo.png
+
+  $ twentythree thumbnail file delete --template-id 42 --filename logo.png --json
+```
+
+_See code: [src/commands/thumbnail/file/delete.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/file/delete.ts)_
+
+## `twentythree thumbnail file list ID`
+
+List files associated with a thumbnail template
+
+```
+USAGE
+  $ twentythree thumbnail file list ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  Thumbnail template ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List files associated with a thumbnail template
+
+EXAMPLES
+  $ twentythree thumbnail file list 42
+
+  $ twentythree thumbnail file list 42 --json
+```
+
+_See code: [src/commands/thumbnail/file/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/file/list.ts)_
+
+## `twentythree thumbnail file upload FILE`
+
+Upload an image file to a thumbnail template
+
+```
+USAGE
+  $ twentythree thumbnail file upload FILE --template-id <value> [--json] [-w <value>]
+
+ARGUMENTS
+  FILE  Path to the image file to upload
+
+FLAGS
+  --template-id=<value>  (required) Thumbnail template ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Upload an image file to a thumbnail template
+
+EXAMPLES
+  $ twentythree thumbnail file upload ./logo.png --template-id 42
+
+  $ twentythree thumbnail file upload ./banner.jpg --template-id 42 --json
+```
+
+_See code: [src/commands/thumbnail/file/upload.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/file/upload.ts)_

package/docs/commands/thumbnail/list.md

@@ -0,0 +1,37 @@
+`twentythree thumbnail:list`
+============================
+
+List thumbnail templates in the active workspace
+
+* [`twentythree thumbnail list`](#twentythree-thumbnail-list)
+
+## `twentythree thumbnail list`
+
+List thumbnail templates in the active workspace
+
+```
+USAGE
+  $ twentythree thumbnail list [--json] [-w <value>] [--search <value>] [--object-type <value>]
+
+FLAGS
+  --object-type=<value>  Filter by object type (photo, live, liveseries)
+  --search=<value>       Filter by name
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List thumbnail templates in the active workspace
+
+EXAMPLES
+  $ twentythree thumbnail list
+
+  $ twentythree thumbnail list --search "my template"
+
+  $ twentythree thumbnail list --object-type photo
+
+  $ twentythree thumbnail list --json
+```
+
+_See code: [src/commands/thumbnail/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/list.ts)_

package/docs/commands/thumbnail/update.md

@@ -0,0 +1,44 @@
+`twentythree thumbnail:update`
+==============================
+
+Update a thumbnail template
+
+* [`twentythree thumbnail update ID`](#twentythree-thumbnail-update-id)
+
+## `twentythree thumbnail update ID`
+
+Update a thumbnail template
+
+```
+USAGE
+  $ twentythree thumbnail update ID [--json] [-w <value>] [--name <value>] [--liquid-template <value>] [--object-type
+    <value>] [--width <value>] [--height <value>]
+
+ARGUMENTS
+  ID  Thumbnail template ID
+
+FLAGS
+  --height=<value>           Template height in pixels
+  --liquid-template=<value>  New Liquid template content
+  --name=<value>             New name for the template
+  --object-type=<value>      Object type (photo, live, liveseries)
+  --width=<value>            Template width in pixels
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update a thumbnail template
+
+EXAMPLES
+  $ twentythree thumbnail update 42 --name "Updated Name"
+
+  $ twentythree thumbnail update 42 --liquid-template "<div>{{ video.title }}</div>"
+
+  $ twentythree thumbnail update 42 --object-type photo --width 1280 --height 720
+
+  $ twentythree thumbnail update 42 --name "Updated Name" --json
+```
+
+_See code: [src/commands/thumbnail/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/thumbnail/update.ts)_