twentythree-cli 1.0.0

package/docs/commands/app/add.md

@@ -0,0 +1,38 @@
+`twentythree app:add`
+=====================
+
+Create a new app integration
+
+* [`twentythree app add`](#twentythree-app-add)
+
+## `twentythree app add`
+
+Create a new app integration
+
+```
+USAGE
+  $ twentythree app add --name <value> [--json] [-w <value>] [--description <value>] [--style <value>]
+    [--type <value>]
+
+FLAGS
+  --description=<value>  App description
+  --name=<value>         (required) App name
+  --style=<value>        App style
+  --type=<value>         App type
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new app integration
+
+EXAMPLES
+  $ twentythree app add --name "My App"
+
+  $ twentythree app add --name "My App" --description "A sample app"
+
+  $ twentythree app add --name "My App" --json
+```
+
+_See code: [src/commands/app/add.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/app/add.ts)_

package/docs/commands/app/delete.md

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

package/docs/commands/app/update.md

@@ -0,0 +1,41 @@
+`twentythree app:update`
+========================
+
+Update an existing app integration
+
+* [`twentythree app update ID`](#twentythree-app-update-id)
+
+## `twentythree app update ID`
+
+Update an existing app integration
+
+```
+USAGE
+  $ twentythree app update ID [--json] [-w <value>] [--name <value>] [--description <value>] [--style <value>]
+
+ARGUMENTS
+  ID  App ID
+
+FLAGS
+  --description=<value>  App description
+  --name=<value>         App name
+  --style=<value>        App style
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update an existing app integration
+
+EXAMPLES
+  $ twentythree app update 12345 --name "Updated Name"
+
+  $ twentythree app update 12345 --description "New description"
+
+  $ twentythree app update 12345 --name "Updated Name" --description "New description"
+
+  $ twentythree app update 12345 --name "Updated Name" --json
+```
+
+_See code: [src/commands/app/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/app/update.ts)_

package/docs/commands/app.md

@@ -0,0 +1,101 @@
+`twentythree app`
+=================
+
+Create a new app integration
+
+* [`twentythree app add`](#twentythree-app-add)
+* [`twentythree app delete ID`](#twentythree-app-delete-id)
+* [`twentythree app update ID`](#twentythree-app-update-id)
+
+## `twentythree app add`
+
+Create a new app integration
+
+```
+USAGE
+  $ twentythree app add --name <value> [--json] [-w <value>] [--description <value>] [--style <value>]
+    [--type <value>]
+
+FLAGS
+  --description=<value>  App description
+  --name=<value>         (required) App name
+  --style=<value>        App style
+  --type=<value>         App type
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create a new app integration
+
+EXAMPLES
+  $ twentythree app add --name "My App"
+
+  $ twentythree app add --name "My App" --description "A sample app"
+
+  $ twentythree app add --name "My App" --json
+```
+
+_See code: [src/commands/app/add.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/app/add.ts)_
+
+## `twentythree app delete ID`
+
+Delete an app integration from the active workspace
+
+```
+USAGE
+  $ twentythree app delete ID [--json] [-w <value>]
+
+ARGUMENTS
+  ID  App ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Delete an app integration from the active workspace
+
+EXAMPLES
+  $ twentythree app delete 12345
+
+  $ twentythree app delete 12345 --json
+```
+
+_See code: [src/commands/app/delete.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/app/delete.ts)_
+
+## `twentythree app update ID`
+
+Update an existing app integration
+
+```
+USAGE
+  $ twentythree app update ID [--json] [-w <value>] [--name <value>] [--description <value>] [--style <value>]
+
+ARGUMENTS
+  ID  App ID
+
+FLAGS
+  --description=<value>  App description
+  --name=<value>         App name
+  --style=<value>        App style
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Update an existing app integration
+
+EXAMPLES
+  $ twentythree app update 12345 --name "Updated Name"
+
+  $ twentythree app update 12345 --description "New description"
+
+  $ twentythree app update 12345 --name "Updated Name" --description "New description"
+
+  $ twentythree app update 12345 --name "Updated Name" --json
+```
+
+_See code: [src/commands/app/update.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/app/update.ts)_

package/docs/commands/audience/companies.md

@@ -0,0 +1,41 @@
+`twentythree audience:companies`
+================================
+
+List audience companies
+
+* [`twentythree audience companies`](#twentythree-audience-companies)
+
+## `twentythree audience companies`
+
+List audience companies
+
+```
+USAGE
+  $ twentythree audience companies [--json] [-w <value>] [--page <value>] [--size <value>] [--offset <value>] [--orderby
+    <value>] [--order <value>] [--identified] [--domains <value>]
+
+FLAGS
+  --domains=<value>  Filter by company domains (space-separated)
+  --[no-]identified  Filter to identified companies only
+  --offset=<value>   Offset for pagination
+  --order=<value>    Sort direction (asc/desc)
+  --orderby=<value>  Order by field
+  --page=<value>     Page number
+  --size=<value>     Page size
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List audience companies
+
+EXAMPLES
+  $ twentythree audience companies
+
+  $ twentythree audience companies --identified --size 50
+
+  $ twentythree audience companies --domains "acme.com" --json
+```
+
+_See code: [src/commands/audience/companies.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/companies.ts)_

package/docs/commands/audience/field.md

@@ -0,0 +1,119 @@
+`twentythree audience:field`
+============================
+
+List custom audience fields
+
+* [`twentythree audience field list`](#twentythree-audience-field-list)
+* [`twentythree audience field remove`](#twentythree-audience-field-remove)
+* [`twentythree audience field set`](#twentythree-audience-field-set)
+* [`twentythree audience field types`](#twentythree-audience-field-types)
+
+## `twentythree audience field list`
+
+List custom audience fields
+
+```
+USAGE
+  $ twentythree audience field list [--json] [-w <value>] [--include-widget-html]
+
+FLAGS
+  --include-widget-html  Include HTML widget for each field
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List custom audience fields
+
+EXAMPLES
+  $ twentythree audience field list
+
+  $ twentythree audience field list --include-widget-html
+
+  $ twentythree audience field list --json
+```
+
+_See code: [src/commands/audience/field/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/field/list.ts)_
+
+## `twentythree audience field remove`
+
+Remove a custom audience field
+
+```
+USAGE
+  $ twentythree audience field remove --key <value> [--json] [-w <value>]
+
+FLAGS
+  --key=<value>  (required) Field key to remove
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Remove a custom audience field
+
+EXAMPLES
+  $ twentythree audience field remove --key "department"
+
+  $ twentythree audience field remove --key "old-field" --json
+```
+
+_See code: [src/commands/audience/field/remove.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/field/remove.ts)_
+
+## `twentythree audience field set`
+
+Create or update a custom audience field
+
+```
+USAGE
+  $ twentythree audience field set --key <value> --type <value> --label <value> [--json] [-w <value>] [--options
+    <value>] [--priority <value>]
+
+FLAGS
+  --key=<value>       (required) Unique field key
+  --label=<value>     (required) Human-readable label
+  --options=<value>   Semicolon-separated options (for enumerable types)
+  --priority=<value>  Display order priority
+  --type=<value>      (required) Field type (use audience field types to list valid values)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Create or update a custom audience field
+
+EXAMPLES
+  $ twentythree audience field set --key "department" --type text --label "Department"
+
+  $ twentythree audience field set --key "tier" --type enum --label "Customer Tier" --options "free;pro;enterprise"
+
+  $ twentythree audience field set --key "score" --type number --label "NPS Score" --priority 1 --json
+```
+
+_See code: [src/commands/audience/field/set.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/field/set.ts)_
+
+## `twentythree audience field types`
+
+List valid audience field types
+
+```
+USAGE
+  $ twentythree audience field types [--json] [-w <value>]
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List valid audience field types
+
+EXAMPLES
+  $ twentythree audience field types
+
+  $ twentythree audience field types --json
+```
+
+_See code: [src/commands/audience/field/types.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/field/types.ts)_

package/docs/commands/audience/funnel.md

@@ -0,0 +1,38 @@
+`twentythree audience:funnel`
+=============================
+
+Get audience funnel analytics
+
+* [`twentythree audience funnel`](#twentythree-audience-funnel)
+
+## `twentythree audience funnel`
+
+Get audience funnel analytics
+
+```
+USAGE
+  $ twentythree audience funnel [--json] [-w <value>] [--objects <value>] [--live-type <value>]
+    [--resolve-recordings] [--resolve-live-series]
+
+FLAGS
+  --live-type=<value>    Live event type filter
+  --objects=<value>      Filter by object IDs (space-separated)
+  --resolve-live-series  Resolve live series details
+  --resolve-recordings   Resolve recording details
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Get audience funnel analytics
+
+EXAMPLES
+  $ twentythree audience funnel
+
+  $ twentythree audience funnel --objects "123 456" --json
+
+  $ twentythree audience funnel --live-type on_demand --resolve-recordings
+```
+
+_See code: [src/commands/audience/funnel.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/funnel.ts)_

package/docs/commands/audience/identity-sources.md

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

package/docs/commands/audience/list-collectors.md

@@ -0,0 +1,35 @@
+`twentythree audience:list-collectors`
+======================================
+
+List collectors linked to audience
+
+* [`twentythree audience list-collectors`](#twentythree-audience-list-collectors)
+
+## `twentythree audience list-collectors`
+
+List collectors linked to audience
+
+```
+USAGE
+  $ twentythree audience list-collectors [--json] [-w <value>] [--object-id <value>] [--action-id <value>]
+
+FLAGS
+  --action-id=<value>  Filter by action ID
+  --object-id=<value>  Filter by object ID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List collectors linked to audience
+
+EXAMPLES
+  $ twentythree audience list-collectors
+
+  $ twentythree audience list-collectors --object-id 123
+
+  $ twentythree audience list-collectors --action-id 456 --json
+```
+
+_See code: [src/commands/audience/list-collectors.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/list-collectors.ts)_

package/docs/commands/audience/list.md

@@ -0,0 +1,42 @@
+`twentythree audience:list`
+===========================
+
+List audience members
+
+* [`twentythree audience list`](#twentythree-audience-list)
+
+## `twentythree audience list`
+
+List audience members
+
+```
+USAGE
+  $ twentythree audience list [--json] [-w <value>] [--page <value>] [--size <value>] [--offset <value>] [--orderby
+    <value>] [--order <value>] [--search <value>] [--identified] [--objects <value>]
+
+FLAGS
+  --[no-]identified  Filter to identified profiles only
+  --objects=<value>  Filter by viewed object IDs (space-separated)
+  --offset=<value>   Offset for pagination
+  --order=<value>    Sort direction (asc/desc)
+  --orderby=<value>  Order by field (recent, timeline_count, score, first)
+  --page=<value>     Page number
+  --search=<value>   Free-text search across names and emails
+  --size=<value>     Page size (max 500)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  List audience members
+
+EXAMPLES
+  $ twentythree audience list
+
+  $ twentythree audience list --page 2 --size 50
+
+  $ twentythree audience list --search "john" --identified --json
+```
+
+_See code: [src/commands/audience/list.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/list.ts)_

package/docs/commands/audience/metrics.md

@@ -0,0 +1,40 @@
+`twentythree audience:metrics`
+==============================
+
+Get audience aggregate metrics
+
+* [`twentythree audience metrics`](#twentythree-audience-metrics)
+
+## `twentythree audience metrics`
+
+Get audience aggregate metrics
+
+```
+USAGE
+  $ twentythree audience metrics [--json] [-w <value>] [--page <value>] [--size <value>] [--offset <value>] [--search
+    <value>] [--identified] [--objects <value>]
+
+FLAGS
+  --[no-]identified  Filter to identified profiles only
+  --objects=<value>  Filter by viewed object IDs (space-separated)
+  --offset=<value>   Offset for pagination
+  --page=<value>     Page number
+  --search=<value>   Free-text search filter
+  --size=<value>     Page size
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Get audience aggregate metrics
+
+EXAMPLES
+  $ twentythree audience metrics
+
+  $ twentythree audience metrics --identified --json
+
+  $ twentythree audience metrics --search "acme" --size 100
+```
+
+_See code: [src/commands/audience/metrics.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/metrics.ts)_

package/docs/commands/audience/register.md

@@ -0,0 +1,45 @@
+`twentythree audience:register`
+===============================
+
+Register an audience contact
+
+* [`twentythree audience register`](#twentythree-audience-register)
+
+## `twentythree audience register`
+
+Register an audience contact
+
+```
+USAGE
+  $ twentythree audience register --email <value> [--json] [-w <value>] [--object-id <value>] [--uuid <value>]
+    [--action-id <value>] [--firstname <value>] [--lastname <value>] [--company <value>] [--phone <value>] [--return-url
+    <value>] [--source <value>]
+
+FLAGS
+  --action-id=<value>   Collector action ID
+  --company=<value>     Company name
+  --email=<value>       (required) Contact email address
+  --firstname=<value>   First name
+  --lastname=<value>    Last name
+  --object-id=<value>   Webinar/video ID to register for
+  --phone=<value>       Phone number
+  --return-url=<value>  Base URL for tracking URL
+  --source=<value>      Registration source (api, import, site, custom)
+  --uuid=<value>        Existing contact UUID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Register an audience contact
+
+EXAMPLES
+  $ twentythree audience register --email "jane@example.com"
+
+  $ twentythree audience register --email "john@acme.com" --object-id 123 --firstname "John" --lastname "Doe"
+
+  $ twentythree audience register --email "user@co.com" --company "Acme Corp" --source api --json
+```
+
+_See code: [src/commands/audience/register.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/register.ts)_

package/docs/commands/audience/remove.md

@@ -0,0 +1,35 @@
+`twentythree audience:remove`
+=============================
+
+Permanently remove an audience contact
+
+* [`twentythree audience remove`](#twentythree-audience-remove)
+
+## `twentythree audience remove`
+
+Permanently remove an audience contact
+
+```
+USAGE
+  $ twentythree audience remove [--json] [-w <value>] [--email <value>] [--uuid <value>]
+
+FLAGS
+  --email=<value>  Contact email address
+  --uuid=<value>   Contact UUID
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Permanently remove an audience contact
+
+EXAMPLES
+  $ twentythree audience remove --email "jane@example.com"
+
+  $ twentythree audience remove --uuid "abc-def-ghi"
+
+  $ twentythree audience remove --email "user@co.com" --json
+```
+
+_See code: [src/commands/audience/remove.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/remove.ts)_

package/docs/commands/audience/search.md

@@ -0,0 +1,39 @@
+`twentythree audience:search`
+=============================
+
+Search audience members
+
+* [`twentythree audience search`](#twentythree-audience-search)
+
+## `twentythree audience search`
+
+Search audience members
+
+```
+USAGE
+  $ twentythree audience search --text <value> [--json] [-w <value>] [--size <value>] [--offset <value>] [--orderby
+    <value>] [--order <value>]
+
+FLAGS
+  --offset=<value>   Results offset
+  --order=<value>    Sort direction (asc/desc)
+  --orderby=<value>  Order by field
+  --size=<value>     Number of results
+  --text=<value>     (required) Search text (required)
+
+GLOBAL FLAGS
+  -w, --workspace=<value>  Workspace domain or display name to use for this invocation.
+      --json               Format output as json.
+
+DESCRIPTION
+  Search audience members
+
+EXAMPLES
+  $ twentythree audience search --text "john doe"
+
+  $ twentythree audience search --text "acme" --size 20 --json
+
+  $ twentythree audience search --text "jane" --orderby score --order desc
+```
+
+_See code: [src/commands/audience/search.ts](https://github.com/23/twentythree-cli/blob/v0.1.0/src/commands/audience/search.ts)_