kenso 0.1.17 → 0.1.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/reference.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Kenso CLI command reference
2
2
 
3
- Generated from kenso 0.1.17 (API contracts 2b8736a3a88d) by `scripts/build-reference.ts`. Do not edit it: `pnpm build` writes it again.
3
+ Generated from kenso 0.1.19 (API contracts 6c5f39fbe3fd) by `scripts/build-reference.ts`. Do not edit it: `pnpm build` writes it again.
4
4
 
5
- 1376 commands, one entry each: summary, API route, feature gate and flag names. Beta commands work only on workspaces with their feature flag; `kenso describe` hides the ones yours cannot use. Every command also takes the global flags below. A command's notes, flag descriptions, body schema and examples: `kenso <resource> <action> --help`, or `kenso describe <resource> <action>` as JSON.
5
+ 1403 commands, one entry each: summary, API route, feature gate and flag names. Beta commands work only on workspaces with their feature flag; `kenso describe` hides the ones yours cannot use. Every command also takes the global flags below. A command's notes, flag descriptions, body schema and examples: `kenso <resource> <action> --help`, or `kenso describe <resource> <action>` as JSON.
6
6
 
7
7
  ## Global flags
8
8
 
@@ -144,6 +144,7 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
144
144
  - [custom-variables](#custom-variables) (4)
145
145
  - [dashboard](#dashboard) (1)
146
146
  - [data-retention](#data-retention) (2)
147
+ - [delivery-settings](#delivery-settings) (2)
147
148
  - [describe](#describe) (1)
148
149
  - [dialer-connections](#dialer-connections) (11)
149
150
  - [dialer-webhook](#dialer-webhook) (1)
@@ -163,6 +164,7 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
163
164
  - [events](#events) (2)
164
165
  - [experiments](#experiments) (11)
165
166
  - [external-bookings](#external-bookings) (2)
167
+ - [facebook-accounts](#facebook-accounts) (9)
166
168
  - [fathom-connection](#fathom-connection) (3)
167
169
  - [file-comments](#file-comments) (4)
168
170
  - [files](#files) (7)
@@ -183,6 +185,7 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
183
185
  - [infra](#infra) (3)
184
186
  - [infra-action-batches](#infra-action-batches) (3)
185
187
  - [infra-action-previews](#infra-action-previews) (1)
188
+ - [instagram-accounts](#instagram-accounts) (5)
186
189
  - [intake-settings](#intake-settings) (2)
187
190
  - [integrations](#integrations) (3)
188
191
  - [invitations](#invitations) (5)
@@ -216,7 +219,7 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
216
219
  - [knowledge-website-pages](#knowledge-website-pages) (3)
217
220
  - [knowledge-writing-style](#knowledge-writing-style) (2)
218
221
  - [learnings](#learnings) (1)
219
- - [linkedin-accounts](#linkedin-accounts) (7)
222
+ - [linkedin-accounts](#linkedin-accounts) (8)
220
223
  - [linkedin-connections](#linkedin-connections) (2)
221
224
  - [linkedin-inbound](#linkedin-inbound) (1)
222
225
  - [linkedin-inbound-seats](#linkedin-inbound-seats) (1)
@@ -248,6 +251,7 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
248
251
  - [meeting-types](#meeting-types) (6)
249
252
  - [meetings](#meetings) (26)
250
253
  - [members](#members) (10)
254
+ - [message-media](#message-media) (2)
251
255
  - [microsoft-teams-admin-consent-sessions](#microsoft-teams-admin-consent-sessions) (1)
252
256
  - [migration-connections](#migration-connections) (9)
253
257
  - [migration-runs](#migration-runs) (7)
@@ -272,7 +276,7 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
272
276
  - [performance-deal](#performance-deal) (8)
273
277
  - [permission-templates](#permission-templates) (5)
274
278
  - [person-behavior](#person-behavior) (1)
275
- - [placement-tests](#placement-tests) (3)
279
+ - [placement-tests](#placement-tests) (4)
276
280
  - [portal-sessions](#portal-sessions) (1)
277
281
  - [prompt-templates](#prompt-templates) (5)
278
282
  - [prompt-versions](#prompt-versions) (3)
@@ -345,6 +349,8 @@ Exit codes: 0 ok, 1 error, 2 usage, 3 auth, 4 not found, 5 some rows failed, 6 r
345
349
  - [webhook-endpoints](#webhook-endpoints) (8)
346
350
  - [webhook-event-types](#webhook-event-types) (1)
347
351
  - [website](#website) (8)
352
+ - [whatsapp-accounts](#whatsapp-accounts) (5)
353
+ - [whatsapp-settings](#whatsapp-settings) (2)
348
354
  - [white-label](#white-label) (1)
349
355
  - [white-label-brand](#white-label-brand) (5)
350
356
  - [white-label-children](#white-label-children) (5)
@@ -571,7 +577,7 @@ Flags: `--account-type`, `--data`, `--each`, `--concurrency`.
571
577
 
572
578
  Create an account from its domains. `POST /v1/accounts`. Beta: needs `accounts`.
573
579
 
574
- Flags: `--skip-research`, `--name`, `--stage`, `--owner-member-id`, `--fit-score`, `--why-now`, `--angle`, `--cadence-days`, `--industry`, `--funding-round`, `--employee-count`, `--hq-location`, `--linkedin-url`, `--ken-company-id`, `--sends-from-inbox-id`, `--sends-from-linked-in-account-id`, `--source`, `--no-skip-research`, `--data`, `--each`, `--concurrency`.
580
+ Flags: `--skip-research`, `--name`, `--stage`, `--owner-member-id`, `--fit-score`, `--why-now`, `--angle`, `--cadence-days`, `--industry`, `--funding-round`, `--employee-count`, `--hq-location`, `--linkedin-url`, `--ken-company-id`, `--sends-from-inbox-id`, `--sends-from-linked-in-account-id`, `--sends-from-whats-app-account-id`, `--source`, `--no-skip-research`, `--data`, `--each`, `--concurrency`.
575
581
 
576
582
  ### kenso accounts delete
577
583
 
@@ -649,7 +655,7 @@ Flags: `--q`, `--sort`, `--limit`, `--cursor`, `--include-total`, `--time-zone`,
649
655
 
650
656
  Update account fields. Absent fields stay unchanged; null clears. `PATCH /v1/accounts/{accountId}`. Beta: needs `accounts`.
651
657
 
652
- Flags: `--account-id` (required), `--name`, `--stage`, `--owner-member-id`, `--fit-score`, `--why-now`, `--angle`, `--cadence-days`, `--industry`, `--funding-round`, `--employee-count`, `--hq-location`, `--linkedin-url`, `--ken-company-id`, `--sends-from-inbox-id`, `--sends-from-linked-in-account-id`, `--overwrite-pinned`, `--tier-override`, `--is-customer`, `--account-type`, `--no-overwrite-pinned`, `--no-is-customer`, `--data`, `--each`, `--concurrency`.
658
+ Flags: `--account-id` (required), `--name`, `--stage`, `--owner-member-id`, `--fit-score`, `--why-now`, `--angle`, `--cadence-days`, `--industry`, `--funding-round`, `--employee-count`, `--hq-location`, `--linkedin-url`, `--ken-company-id`, `--sends-from-inbox-id`, `--sends-from-linked-in-account-id`, `--sends-from-whats-app-account-id`, `--overwrite-pinned`, `--sends-from-instagram-account-id`, `--tier-override`, `--is-customer`, `--account-type`, `--no-overwrite-pinned`, `--no-is-customer`, `--data`, `--each`, `--concurrency`.
653
659
 
654
660
  ## ad-audiences
655
661
 
@@ -3299,6 +3305,20 @@ Change the workspace's data retention period. `PATCH /v1/data-retention`. Beta:
3299
3305
 
3300
3306
  Flags: `--months`, `--data`, `--each`, `--concurrency`.
3301
3307
 
3308
+ ## delivery-settings
3309
+
3310
+ ### kenso delivery-settings get
3311
+
3312
+ Return the workspace's delivery settings. `GET /v1/delivery-settings`. Beta: needs `placement_native`.
3313
+
3314
+ Flags: `--each`, `--concurrency`.
3315
+
3316
+ ### kenso delivery-settings update
3317
+
3318
+ Update the workspace's delivery settings. `PATCH /v1/delivery-settings`. Beta: needs `placement_native`.
3319
+
3320
+ Flags: `--placement-auto-pause`, `--no-placement-auto-pause`, `--data`, `--each`, `--concurrency`.
3321
+
3302
3322
  ## describe
3303
3323
 
3304
3324
  ### kenso describe
@@ -3739,6 +3759,62 @@ List external bookings. `GET /v1/external-bookings` (a list). Beta: needs `meeti
3739
3759
 
3740
3760
  Flags: `--account-id`, `--campaign-id`, `--cursor`, `--limit`, `--person-id`, `--provider`, `--start-after`, `--start-before`, `--status`, `--all`, `--each`, `--concurrency`.
3741
3761
 
3762
+ ## facebook-accounts
3763
+
3764
+ ### kenso facebook-accounts create-connect-session
3765
+
3766
+ Start connecting a new Facebook account. `POST /v1/facebook-accounts/connect-sessions`. Beta: needs `facebook_outreach`.
3767
+
3768
+ Flags: `--each`, `--concurrency`.
3769
+
3770
+ ### kenso facebook-accounts create-reconnect-session
3771
+
3772
+ Start a hosted session that reconnects the account. `POST /v1/facebook-accounts/{facebookAccountId}/reconnect-sessions`. Beta: needs `facebook_outreach`.
3773
+
3774
+ Flags: `--facebook-account-id` (required), `--each`, `--concurrency`.
3775
+
3776
+ ### kenso facebook-accounts delete
3777
+
3778
+ Remove a Facebook account from Kenso. `DELETE /v1/facebook-accounts/{facebookAccountId}`. Beta: needs `facebook_outreach`.
3779
+
3780
+ Flags: `--facebook-account-id` (required), `--each`, `--concurrency`.
3781
+
3782
+ ### kenso facebook-accounts get
3783
+
3784
+ Return one Facebook account in the current workspace. `GET /v1/facebook-accounts/{facebookAccountId}`. Beta: needs `facebook_outreach`.
3785
+
3786
+ Flags: `--facebook-account-id` (required), `--each`, `--concurrency`.
3787
+
3788
+ ### kenso facebook-accounts list
3789
+
3790
+ List Facebook accounts in the current workspace. `GET /v1/facebook-accounts` (a list). Beta: needs `facebook_outreach`.
3791
+
3792
+ Flags: `--cursor`, `--limit`, `--all`, `--each`, `--concurrency`.
3793
+
3794
+ ### kenso facebook-accounts pause
3795
+
3796
+ Pause automated actions from the account. `POST /v1/facebook-accounts/{facebookAccountId}/pause`. Beta: needs `facebook_outreach`.
3797
+
3798
+ Flags: `--facebook-account-id` (required), `--each`, `--concurrency`.
3799
+
3800
+ ### kenso facebook-accounts reset-ramp
3801
+
3802
+ Restart the account's ramp from today with its current plan. `POST /v1/facebook-accounts/{facebookAccountId}/ramp/reset`. Beta: needs `facebook_outreach`.
3803
+
3804
+ Flags: `--facebook-account-id` (required), `--each`, `--concurrency`.
3805
+
3806
+ ### kenso facebook-accounts resume
3807
+
3808
+ Resume automated actions from the account. `POST /v1/facebook-accounts/{facebookAccountId}/resume`. Beta: needs `facebook_outreach`.
3809
+
3810
+ Flags: `--facebook-account-id` (required), `--each`, `--concurrency`.
3811
+
3812
+ ### kenso facebook-accounts update
3813
+
3814
+ Update a Facebook account. Absent fields stay unchanged. `PATCH /v1/facebook-accounts/{facebookAccountId}`. Beta: needs `facebook_outreach`.
3815
+
3816
+ Flags: `--facebook-account-id` (required), `--timezone`, `--min-mutual-friends`, `--data`, `--each`, `--concurrency`.
3817
+
3742
3818
  ## fathom-connection
3743
3819
 
3744
3820
  ### kenso fathom-connection connect
@@ -4271,6 +4347,38 @@ Preview a bulk inbox or domain action. `POST /v1/infra/action-previews`. Beta: n
4271
4347
 
4272
4348
  Flags: `--action`, `--data`, `--each`, `--concurrency`.
4273
4349
 
4350
+ ## instagram-accounts
4351
+
4352
+ ### kenso instagram-accounts create-connect-session
4353
+
4354
+ Start connecting a new Instagram account, or reconnect one. `POST /v1/instagram-accounts/connect-sessions`. Beta: needs `instagram`.
4355
+
4356
+ Flags: `--name`, `--instagram-account-id`, `--data`, `--each`, `--concurrency`.
4357
+
4358
+ ### kenso instagram-accounts delete
4359
+
4360
+ Remove an Instagram account from Kenso. `DELETE /v1/instagram-accounts/{instagramAccountId}`. Beta: needs `instagram`.
4361
+
4362
+ Flags: `--instagram-account-id` (required), `--each`, `--concurrency`.
4363
+
4364
+ ### kenso instagram-accounts get
4365
+
4366
+ Return one Instagram account in the current workspace. `GET /v1/instagram-accounts/{instagramAccountId}`. Beta: needs `instagram`.
4367
+
4368
+ Flags: `--instagram-account-id` (required), `--each`, `--concurrency`.
4369
+
4370
+ ### kenso instagram-accounts list
4371
+
4372
+ List Instagram accounts in the current workspace. `GET /v1/instagram-accounts` (a list). Beta: needs `instagram`.
4373
+
4374
+ Flags: `--cursor`, `--limit`, `--all`, `--each`, `--concurrency`.
4375
+
4376
+ ### kenso instagram-accounts update
4377
+
4378
+ Update an Instagram account. Absent fields stay unchanged. `PATCH /v1/instagram-accounts/{instagramAccountId}`. Beta: needs `instagram`.
4379
+
4380
+ Flags: `--instagram-account-id` (required), `--name`, `--daily-cap`, `--timezone`, `--paused`, `--no-paused`, `--data`, `--each`, `--concurrency`.
4381
+
4274
4382
  ## intake-settings
4275
4383
 
4276
4384
  ### kenso intake-settings get
@@ -5013,6 +5121,12 @@ Preview a Sales Navigator search or list. `POST /v1/linkedin-accounts/{linkedinA
5013
5121
 
5014
5122
  Flags: `--linkedin-account-id` (required), `--url`, `--data`, `--each`, `--concurrency`.
5015
5123
 
5124
+ ### kenso linkedin-accounts reset-ramp
5125
+
5126
+ Restart a LinkedIn account's ramp. `POST /v1/linkedin-accounts/{linkedinAccountId}/ramp/reset`.
5127
+
5128
+ Flags: `--linkedin-account-id` (required), `--each`, `--concurrency`.
5129
+
5016
5130
  ### kenso linkedin-accounts update
5017
5131
 
5018
5132
  Update a LinkedIn account. `PATCH /v1/linkedin-accounts/{linkedinAccountId}`.
@@ -5903,6 +6017,20 @@ Change a member's role. `PATCH /v1/members/{memberId}`.
5903
6017
 
5904
6018
  Flags: `--member-id` (required), `--role`, `--data`, `--each`, `--concurrency`.
5905
6019
 
6020
+ ## message-media
6021
+
6022
+ ### kenso message-media create
6023
+
6024
+ Upload an image for messages. `POST /v1/message-media`. Beta: needs `whatsapp`.
6025
+
6026
+ Flags: `--file`, `--data`, `--each`, `--concurrency`.
6027
+
6028
+ ### kenso message-media get
6029
+
6030
+ Get an uploaded image. `GET /v1/message-media/{mediaId}`. Beta: needs `whatsapp`.
6031
+
6032
+ Flags: `--media-id` (required), `--each`, `--concurrency`.
6033
+
5906
6034
  ## microsoft-teams-admin-consent-sessions
5907
6035
 
5908
6036
  ### kenso microsoft-teams-admin-consent-sessions create
@@ -6637,11 +6765,17 @@ Flags: `--person-id` (required), `--each`, `--concurrency`.
6637
6765
 
6638
6766
  ## placement-tests
6639
6767
 
6768
+ ### kenso placement-tests availability
6769
+
6770
+ Return what the start dialog needs to offer a Kenso placement test. `GET /v1/placement-tests/availability`.
6771
+
6772
+ Flags: `--each`, `--concurrency`.
6773
+
6640
6774
  ### kenso placement-tests create
6641
6775
 
6642
6776
  Start a placement test. `POST /v1/placement-tests`.
6643
6777
 
6644
- Flags: `--campaign-id`, `--inbox-id`, `--domain-id`, `--sequence-version-id`, `--campaign-segment-id`, `--contact-id`, `--random-segment`, `--random-lead`, `--random-scope`, `--random-copy-version`, `--open-pixel`, `--no-random-segment`, `--no-random-lead`, `--no-random-scope`, `--no-random-copy-version`, `--no-open-pixel`, `--data`, `--each`, `--concurrency`.
6778
+ Flags: `--campaign-id`, `--inbox-id`, `--domain-id`, `--sequence-version-id`, `--campaign-segment-id`, `--contact-id`, `--random-segment`, `--random-lead`, `--random-scope`, `--random-copy-version`, `--open-pixel`, `--control`, `--subject`, `--body`, `--no-random-segment`, `--no-random-lead`, `--no-random-scope`, `--no-random-copy-version`, `--no-open-pixel`, `--no-control`, `--data`, `--each`, `--concurrency`.
6645
6779
 
6646
6780
  ### kenso placement-tests get
6647
6781
 
@@ -6653,7 +6787,7 @@ Flags: `--placement-test-id` (required), `--each`, `--concurrency`.
6653
6787
 
6654
6788
  List placement tests. `GET /v1/placement-tests` (a list).
6655
6789
 
6656
- Flags: `--campaign-id`, `--cursor`, `--limit`, `--all`, `--each`, `--concurrency`.
6790
+ Flags: `--campaign-id`, `--cursor`, `--domain-id`, `--inbox-id`, `--limit`, `--all`, `--each`, `--concurrency`.
6657
6791
 
6658
6792
  ## portal-sessions
6659
6793
 
@@ -8207,7 +8341,7 @@ Flags: `--touch-id` (required), `--updated-at`, `--recipient-version`, `--data`,
8207
8341
 
8208
8342
  Plan a touch on an account. `POST /v1/touches`. Beta: needs `accounts`.
8209
8343
 
8210
- Flags: `--account-id`, `--stakeholder-id`, `--channel`, `--due-at`, `--reason`, `--title`, `--subject`, `--body`, `--rationale`, `--judge-score`, `--asset-link-id`, `--data`, `--each`, `--concurrency`.
8344
+ Flags: `--account-id`, `--stakeholder-id`, `--channel`, `--due-at`, `--reason`, `--title`, `--subject`, `--body`, `--rationale`, `--judge-score`, `--asset-link-id`, `--whatsapp-account-id`, `--find-number`, `--no-find-number`, `--data`, `--each`, `--concurrency`.
8211
8345
 
8212
8346
  ### kenso touches delete
8213
8347
 
@@ -8273,7 +8407,7 @@ Flags: `--touch-id` (required), `--action`, `--updated-at`, `--data`, `--each`,
8273
8407
 
8274
8408
  Edit a touch's title, channel, content or due time. `PATCH /v1/touches/{touchId}`. Beta: needs `accounts`.
8275
8409
 
8276
- Flags: `--touch-id` (required), `--title`, `--channel`, `--subject`, `--body`, `--rationale`, `--due-at`, `--stakeholder-id`, `--asset-link-id`, `--data`, `--each`, `--concurrency`.
8410
+ Flags: `--touch-id` (required), `--title`, `--channel`, `--subject`, `--body`, `--rationale`, `--due-at`, `--stakeholder-id`, `--asset-link-id`, `--whatsapp-account-id`, `--find-number`, `--no-find-number`, `--data`, `--each`, `--concurrency`.
8277
8411
 
8278
8412
  ## tracking-links
8279
8413
 
@@ -8681,6 +8815,52 @@ List the human visits to the website. `GET /v1/website/visits` (a list). Beta: n
8681
8815
 
8682
8816
  Flags: `--account-id`, `--cursor`, `--known`, `--limit`, `--page-id`, `--person-id`, `--since`, `--no-known`, `--all`, `--each`, `--concurrency`.
8683
8817
 
8818
+ ## whatsapp-accounts
8819
+
8820
+ ### kenso whatsapp-accounts create-connect-session
8821
+
8822
+ Start a hosted WhatsApp connect or reconnect session. `POST /v1/whatsapp-accounts/connect-sessions`. Beta: needs `whatsapp`.
8823
+
8824
+ Flags: `--whatsapp-account-id`, `--data`, `--each`, `--concurrency`.
8825
+
8826
+ ### kenso whatsapp-accounts delete
8827
+
8828
+ Delete a WhatsApp account. `DELETE /v1/whatsapp-accounts/{whatsappAccountId}`. Beta: needs `whatsapp`.
8829
+
8830
+ Flags: `--whatsapp-account-id` (required), `--each`, `--concurrency`.
8831
+
8832
+ ### kenso whatsapp-accounts get
8833
+
8834
+ Return one WhatsApp account in the current workspace. `GET /v1/whatsapp-accounts/{whatsappAccountId}`. Beta: needs `whatsapp`.
8835
+
8836
+ Flags: `--whatsapp-account-id` (required), `--each`, `--concurrency`.
8837
+
8838
+ ### kenso whatsapp-accounts list
8839
+
8840
+ List WhatsApp accounts in the current workspace. `GET /v1/whatsapp-accounts` (a list). Beta: needs `whatsapp`.
8841
+
8842
+ Flags: `--cursor`, `--limit`, `--all`, `--each`, `--concurrency`.
8843
+
8844
+ ### kenso whatsapp-accounts update
8845
+
8846
+ Update a WhatsApp account. Absent fields stay unchanged. `PATCH /v1/whatsapp-accounts/{whatsappAccountId}`. Beta: needs `whatsapp`.
8847
+
8848
+ Flags: `--whatsapp-account-id` (required), `--daily-new-chat-cap`, `--daily-message-cap`, `--reset-caps`, `--timezone`, `--reset-working-hours`, `--paused`, `--no-reset-caps`, `--no-reset-working-hours`, `--no-paused`, `--data`, `--each`, `--concurrency`.
8849
+
8850
+ ## whatsapp-settings
8851
+
8852
+ ### kenso whatsapp-settings get
8853
+
8854
+ Return the workspace's WhatsApp setting. `GET /v1/whatsapp-settings`. Beta: needs `whatsapp`.
8855
+
8856
+ Flags: `--each`, `--concurrency`.
8857
+
8858
+ ### kenso whatsapp-settings update
8859
+
8860
+ Change the workspace's WhatsApp setting. `PATCH /v1/whatsapp-settings`. Beta: needs `whatsapp`.
8861
+
8862
+ Flags: `--allow-eu-eea-uk`, `--no-allow-eu-eea-uk`, `--data`, `--each`, `--concurrency`.
8863
+
8684
8864
  ## white-label
8685
8865
 
8686
8866
  ### kenso white-label get
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "kenso",
3
- "version": "0.1.17",
3
+ "version": "0.1.19",
4
4
  "description": "The Kenso CLI: bulk lead, CRM and Studio work for people and coding agents",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -44,5 +44,5 @@
44
44
  "typescript-eslint": "8.71.1",
45
45
  "vitest": "5.0.3"
46
46
  },
47
- "gitHead": "4b7b6d671753dee817768174b36add31a0a6897e"
47
+ "gitHead": "85fa76e053149f11545406c1fc480a72a913d06f"
48
48
  }