@whop/cli 0.14.3 → 0.15.0

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.
@@ -0,0 +1,41 @@
1
+ ---
2
+ name: whop-recommended-actions
3
+ description: Suggested next-step action chains for an account. Run `whop recommended-actions --help` for usage details.
4
+ requires_bin: whop
5
+ command: whop recommended-actions
6
+ ---
7
+
8
+ A Recommended Action Chain is a short, ordered sequence of dashboard actions — create a product, price it, publish it — suggested for an account based on what it already has. Seeded chains come from hand-written presets; generated chains, produced per account, share the same shape.
9
+
10
+ Use the Recommended Actions API to list the chains recommended for an account and to record that a chain was run. Running a chain executes nothing server-side — the client follows each step's CTA itself; the run endpoint records the `recommended_action_chain.executed` analytics event.
11
+
12
+ # whop recommended-actions create
13
+
14
+ Run Recommended Action
15
+
16
+ ## Arguments
17
+
18
+ | Name | Type | Required | Description |
19
+ |------|------|----------|-------------|
20
+ | `chain_id` | `string` | yes | Chain ID from the list endpoint, e.g. `rac_seed_start_selling_9f2c1a7b04`. |
21
+
22
+ ## Options
23
+
24
+ | Flag | Type | Required | Default | Description |
25
+ |------|------|----------|---------|-------------|
26
+ | `--account_id` | `string` | no | | Account ID, prefixed `biz_`. Defaults to the API key's own account. |
27
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
28
+
29
+ > Confirm with the user before executing this destructive command.
30
+
31
+ ---
32
+
33
+ # whop recommended-actions list
34
+
35
+ List Recommended Actions
36
+
37
+ ## Options
38
+
39
+ | Flag | Type | Required | Default | Description |
40
+ |------|------|----------|---------|-------------|
41
+ | `--account_id` | `string` | no | | Account ID, prefixed `biz_`. Defaults to the API key's own account. |
@@ -9,6 +9,26 @@ A Setup Intent saves a buyer's payment method for later without taking money now
9
9
 
10
10
  Poll [Retrieve status](https://docs.whop.com/api-reference/beta/setup-intents/retrieve-status) for how far the setup has got and what is outstanding. Once it reaches `succeeded` the method is on file and can be charged.
11
11
 
12
+ # whop setup-intents return_url
13
+
14
+ Update setup return URL
15
+
16
+ ## Arguments
17
+
18
+ | Name | Type | Required | Description |
19
+ |------|------|----------|-------------|
20
+ | `setup_intent_id` | `string` | yes | The unique identifier of the setup intent. |
21
+
22
+ ## Options
23
+
24
+ | Flag | Type | Required | Default | Description |
25
+ |------|------|----------|---------|-------------|
26
+ | `--return_url` | `string` | yes | | Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials, at most 2,048 characters. |
27
+
28
+ > Confirm with the user before executing this destructive command.
29
+
30
+ ---
31
+
12
32
  # whop setup-intents status
13
33
 
14
34
  Retrieve setup status
@@ -35,8 +35,8 @@ Create a Social Account
35
35
 
36
36
  | Flag | Type | Required | Default | Description |
37
37
  |------|------|----------|---------|-------------|
38
- | `--account_id` | `string` | no | | The Account (biz_ identifier) to create the social account for. An account-scoped API key may omit this to default to its own account. |
39
- | `--platform` | `string` | yes | | The platform to create the social account on. |
38
+ | `--account_id` | `string` | no | | The Account (biz_ identifier) to create the social account for. An account-scoped API key may omit this to default to its own account. Account API keys cannot update their own account's branding through Update Account; use a user-authenticated path. |
39
+ | `--platform` | `string` | yes | | The platform to create the social account on. `facebook` requires the account's `banner_image`, `logo`, and `description`; configure them with [Update Account](/api-reference/beta/accounts/update-account). |
40
40
  | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
41
41
 
42
42
  > Confirm with the user before executing this destructive command.
@@ -18,10 +18,11 @@ Create Swap
18
18
  | Flag | Type | Required | Default | Description |
19
19
  |------|------|----------|---------|-------------|
20
20
  | `--account_id` | `string` | yes | | Business or user account ID (biz_* / user_*). |
21
- | `--amount` | `unknown` | no | | Source token amount. Required for crypto swaps. Optional for fiat pairs: the portion of the negative to_token balance to repay, which must not exceed the debt; omit to repay the full debt. |
21
+ | `--amount` | `unknown` | no | | Source token amount. Required for crypto swaps. For fiat pairs: the amount of from_token to convert at the mid-market rate; omit (along with to_amount) to repay the full negative to_token balance instead. |
22
22
  | `--from_chain` | `number` | no | | Source chain name or chain ID. Defaults to the source token's chain when omitted. |
23
23
  | `--from_token` | `string` | yes | | Source token contract address or ticker symbol, such as "USDT". |
24
24
  | `--slippage_bps` | `number` | no | | Maximum slippage tolerance in basis points. |
25
+ | `--to_amount` | `unknown` | no | | Fiat pairs only: sizes a partial repayment of the negative to_token balance, denominated in to_token. Must not exceed the debt. Mutually exclusive with amount. |
25
26
  | `--to_chain` | `number` | no | | Destination chain name or chain ID. Defaults to the destination token's chain when omitted. |
26
27
  | `--to_token` | `string` | yes | | Destination token contract address or ticker symbol, such as "XAUT". |
27
28
  | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
@@ -74,7 +74,7 @@ List Transfer Recipients
74
74
 
75
75
  | Flag | Type | Required | Default | Description |
76
76
  |------|------|----------|---------|-------------|
77
- | `--origin_id` | `string` | yes | | The originating account ID, prefixed `biz_`. |
78
- | `--query` | `string` | no | | Search users and accounts by name, username, or ID, in the dashboard's relevance order — this additionally requires the member:basic:read scope. Omit it to get the origin account's team members followed by your own other accounts. Complete email addresses return no matches. |
77
+ | `--origin_id` | `string` | yes | | The account sending the money: a company account ID (`biz_`), or a user ID (`user_`) for that user's own personal balance. |
78
+ | `--query` | `string` | no | | Search anyone on Whop by name or username, plus your own accounts by name or ID. Omit it to get the team around the balance, the people you follow, and your own accounts. The list is the same whether the balance belongs to a company or to you. Searching from a `biz_` origin additionally requires the member:basic:read scope. A credential scoped to a single company is the exception to the search itself: it only ever sees that company's own people. Complete email addresses return no matches. |
79
79
  | `--first` | `number` | no | `20` | Number of recipients per page. Search queries preserve the dashboard's 20-result maximum. |
80
80
  | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
@@ -266,6 +266,7 @@ Update User
266
266
  | Flag | Type | Required | Default | Description |
267
267
  |------|------|----------|---------|-------------|
268
268
  | `--account_id` | `string` | no | | The account whose profile override to update. Required for API key callers. |
269
+ | `--banner` | `unknown` | no | | |
269
270
  | `--bio` | `string` | no | | |
270
271
  | `--name` | `string` | no | | |
271
272
  | `--profile_picture` | `object` | no | | |
@@ -284,6 +285,7 @@ Update Current User
284
285
  | Flag | Type | Required | Default | Description |
285
286
  |------|------|----------|---------|-------------|
286
287
  | `--account_id` | `string` | no | | When set, updates the authenticated user's profile override for this account instead of their global profile. |
288
+ | `--banner` | `unknown` | no | | |
287
289
  | `--bio` | `string` | no | | |
288
290
  | `--name` | `string` | no | | |
289
291
  | `--profile_picture` | `object` | no | | |
@@ -301,6 +303,7 @@ Update
301
303
 
302
304
  | Flag | Type | Required | Default | Description |
303
305
  |------|------|----------|---------|-------------|
306
+ | `--bounty_worker_onboarding_dismissed` | `boolean` | no | | Whether the user has dismissed the first-time bounty worker onboarding. Set to `false` to show it again. |
304
307
  | `--investigation_enabled` | `boolean` | no | | Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access. |
305
308
 
306
309
  > Confirm with the user before executing this destructive command.