@whop/cli 0.14.2 → 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.
- package/README.md +1 -1
- package/dist/index.js +23003 -14233
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/skills/whop-accounts/SKILL.md +14 -8
- package/skills/whop-ad-groups/SKILL.md +8 -8
- package/skills/whop-api-keys/SKILL.md +2 -0
- package/skills/whop-apps/SKILL.md +18 -3
- package/skills/whop-audiences/SKILL.md +23 -2
- package/skills/whop-bounties/SKILL.md +26 -0
- package/skills/whop-dispute-alerts/SKILL.md +42 -0
- package/skills/whop-disputes/SKILL.md +2 -2
- package/skills/whop-events/SKILL.md +1 -1
- package/skills/whop-exports/SKILL.md +40 -3
- package/skills/whop-ledgers/SKILL.md +1 -0
- package/skills/whop-memberships/SKILL.md +18 -1
- package/skills/whop-payment-method-domains/SKILL.md +93 -0
- package/skills/whop-payments/SKILL.md +40 -0
- package/skills/whop-payouts/SKILL.md +33 -8
- package/skills/whop-recommended-actions/SKILL.md +41 -0
- package/skills/whop-setup-intents/SKILL.md +40 -0
- package/skills/whop-social-accounts/SKILL.md +2 -2
- package/skills/whop-swaps/SKILL.md +2 -1
- package/skills/whop-transfers/SKILL.md +2 -2
- package/skills/whop-users/SKILL.md +27 -0
|
@@ -7,7 +7,7 @@ command: whop payouts
|
|
|
7
7
|
|
|
8
8
|
Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method.
|
|
9
9
|
|
|
10
|
-
Use the Payouts API to create
|
|
10
|
+
Use the Payouts API to create and track payouts, manage saved payout methods, and show expected arrival details for funds leaving Whop.
|
|
11
11
|
|
|
12
12
|
# whop payouts create
|
|
13
13
|
|
|
@@ -17,10 +17,16 @@ Create Payout
|
|
|
17
17
|
|
|
18
18
|
| Flag | Type | Required | Default | Description |
|
|
19
19
|
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` |
|
|
20
|
+
| `--account_id` | `string` | no | | Account to pay out from, prefixed `biz_`. Provide exactly one of `account_id` or `user_id`. |
|
|
21
|
+
| `--acknowledge_bank_warning` | `boolean` | no | | Set to `true` to continue when the destination bank could not confirm the payout method account holder's name, or `false` to have the payout refused in that case so the account holder can correct the name or link their bank first. Omitting the field skips the warning gate — a client that cannot show the warning keeps its pre-gate behavior. |
|
|
21
22
|
| `--amount` | `number` | yes | | The amount to pay out in the specified currency. |
|
|
22
|
-
| `--currency` | `string` | no | | The payout currency. Defaults to usd
|
|
23
|
+
| `--currency` | `string` | no | | The currency to pay out. Balances are held per currency and the payout draws only from the balance in this currency, so match the currency the funds arrived in — for example `cad` for an account funded by CAD transfers. Defaults to `usd`. |
|
|
24
|
+
| `--idempotency_key` | `unknown` | no | | A unique key that makes retries safe. Retrying with the same key returns the original payout instead of paying out twice. Also accepted as the `Idempotency-Key` header. |
|
|
25
|
+
| `--notes` | `unknown` | no | | Free-form notes to attach to the payout, with a maximum of 255 characters. Omit or pass `null` for no notes. |
|
|
23
26
|
| `--payout_method_id` | `string` | yes | | The saved payout method to deliver to (a potk_ identifier). |
|
|
27
|
+
| `--platform_covers_fees` | `boolean` | no | | Whether the parent platform covers the payout fee instead of the account being paid out. Omit to use the platform's configured fee coverage policy; pass `false` to opt out of it. `true` is only accepted for accounts that belong to a platform, and requires the platform's policy to cover this payout method's category or a caller authorized to manage the platform's child account fees. |
|
|
28
|
+
| `--speed` | `string` | no | | How fast the funds should arrive. `instant` is only accepted when the account and payout method are eligible; otherwise the payout is rejected. |
|
|
29
|
+
| `--user_id` | `string` | no | | User to pay out from, prefixed `user_`. Provide exactly one of `account_id` or `user_id`. |
|
|
24
30
|
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
25
31
|
|
|
26
32
|
> Confirm with the user before executing this destructive command.
|
|
@@ -35,13 +41,13 @@ Create Saved Payout Method
|
|
|
35
41
|
|
|
36
42
|
| Flag | Type | Required | Default | Description |
|
|
37
43
|
|------|------|----------|---------|-------------|
|
|
38
|
-
| `--account_id` | `string` | no | | The account to add the payout method for
|
|
44
|
+
| `--account_id` | `string` | no | | The account to add the payout method for, prefixed `biz_`. Provide this or `user_id`. |
|
|
39
45
|
| `--destination_currency` | `string` | no | `usd` | Currency the supported payout method delivers payouts in. |
|
|
40
|
-
| `--fields` | `object` |
|
|
46
|
+
| `--fields` | `object` | no | | The supported payout method's required field values, keyed by field id — list them with `GET /payouts/supported_methods?supported_payout_method_id=...`. A Basis Theory token id may be passed in place of a raw value. For a U.S. bank routing-number field, a raw nine-digit value must also pass the ABA checksum. A validation failure returns the method's full required_fields schema alongside the error. Required whenever the account details are supplied directly. |
|
|
41
47
|
| `--is_default` | `boolean` | no | `false` | Whether to make this the account's default payout method. |
|
|
42
|
-
| `--nickname` | `string` |
|
|
48
|
+
| `--nickname` | `string` | no | | A label for the payout method, unique per destination. |
|
|
43
49
|
| `--supported_payout_method_id` | `string` | yes | | The supported payout method to save (a podst_ identifier from a previous listing). |
|
|
44
|
-
| `--user_id` | `string` | no | | The user to add the payout method for
|
|
50
|
+
| `--user_id` | `string` | no | | The user to add the payout method for, prefixed `user_`. Provide this or `account_id`. |
|
|
45
51
|
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
46
52
|
|
|
47
53
|
> Confirm with the user before executing this destructive command.
|
|
@@ -62,6 +68,25 @@ Delete Saved Payout Method
|
|
|
62
68
|
|
|
63
69
|
---
|
|
64
70
|
|
|
71
|
+
# whop payouts get
|
|
72
|
+
|
|
73
|
+
Retrieve Payout
|
|
74
|
+
|
|
75
|
+
## Arguments
|
|
76
|
+
|
|
77
|
+
| Name | Type | Required | Description |
|
|
78
|
+
|------|------|----------|-------------|
|
|
79
|
+
| `payout_id` | `string` | yes | Payout ID, prefixed `wdrl_` for a payout returned by `GET /payouts` or `cofr_` for the payout request returned by `POST /payouts`. |
|
|
80
|
+
|
|
81
|
+
## Options
|
|
82
|
+
|
|
83
|
+
| Flag | Type | Required | Default | Description |
|
|
84
|
+
|------|------|----------|---------|-------------|
|
|
85
|
+
| `--account_id` | `string` | no | | Owning account ID, prefixed `biz_`. Provide exactly one of `account_id` or `user_id`. |
|
|
86
|
+
| `--user_id` | `string` | no | | Owning user ID, prefixed `user_`. Provide exactly one of `account_id` or `user_id`. |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
65
90
|
# whop payouts list
|
|
66
91
|
|
|
67
92
|
List Payouts
|
|
@@ -137,6 +162,6 @@ Rename Saved Payout Method
|
|
|
137
162
|
|
|
138
163
|
| Flag | Type | Required | Default | Description |
|
|
139
164
|
|------|------|----------|---------|-------------|
|
|
140
|
-
| `--nickname` | `string` | yes | | New label for the payout method. |
|
|
165
|
+
| `--nickname` | `string` | yes | | New label for the payout method, with at least one non-whitespace character and a maximum of 100 characters. |
|
|
141
166
|
|
|
142
167
|
> Confirm with the user before executing this destructive command.
|
|
@@ -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. |
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-setup-intents
|
|
3
|
+
description: Saving a buyer's payment method without charging it. Run `whop setup-intents --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop setup-intents
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Setup Intent saves a buyer's payment method for later without taking money now. It runs the same collection flow a payment does, so the buyer may still owe a step — 3D Secure on a card, a hosted enrollment, or linking a bank account.
|
|
9
|
+
|
|
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
|
+
|
|
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
|
+
|
|
32
|
+
# whop setup-intents status
|
|
33
|
+
|
|
34
|
+
Retrieve setup status
|
|
35
|
+
|
|
36
|
+
## Arguments
|
|
37
|
+
|
|
38
|
+
| Name | Type | Required | Description |
|
|
39
|
+
|------|------|----------|-------------|
|
|
40
|
+
| `setup_intent_id` | `string` | yes | The unique identifier of the setup intent. |
|
|
@@ -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.
|
|
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
|
|
78
|
-
| `--query` | `string` | no | | Search
|
|
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). |
|
|
@@ -22,6 +22,30 @@ Check User Access
|
|
|
22
22
|
|
|
23
23
|
---
|
|
24
24
|
|
|
25
|
+
# whop users authorize-app
|
|
26
|
+
|
|
27
|
+
Authorize an App
|
|
28
|
+
|
|
29
|
+
## Options
|
|
30
|
+
|
|
31
|
+
| Flag | Type | Required | Default | Description |
|
|
32
|
+
|------|------|----------|---------|-------------|
|
|
33
|
+
| `--account_id` | `string` | no | | Authorize the app for one of the user's accounts rather than for the user alone, prefixed `biz_`. The user must have access to it. |
|
|
34
|
+
| `--client_id` | `string` | yes | | The app being authorized, prefixed `app_`. |
|
|
35
|
+
| `--code_challenge` | `string` | yes | | The PKCE code challenge: the base64url-encoded SHA-256 of your code verifier, without padding. |
|
|
36
|
+
| `--code_challenge_method` | `string` | yes | | How `code_challenge` was derived. Only `S256` is accepted. |
|
|
37
|
+
| `--consent_shown` | `boolean` | no | `true` | Whether the consent UI listed these scopes for the user. Sending `false` succeeds only when the user has already granted every scope requested. |
|
|
38
|
+
| `--nonce` | `string` | no | | OIDC nonce, echoed into the resulting ID token. Required when `requested_scopes` includes `openid`. |
|
|
39
|
+
| `--redirect_uri` | `string` | yes | | Where to send the user once they have consented. Must match one of the app's registered redirect URIs exactly — it is compared as a string, not normalized. |
|
|
40
|
+
| `--requested_scopes` | `array` | yes | | The permissions the app is asking for, for example `member:basic:read`. `GET /api_keys/permissions` names and describes each one. Granting adds to whatever the user already granted this app rather than replacing it. |
|
|
41
|
+
| `--response_type` | `string` | no | | The OAuth response type. Only `code` is accepted; defaults to `code`. |
|
|
42
|
+
| `--state` | `string` | no | | Opaque value appended to `redirect_url` unchanged, for the client to correlate the response with its request. |
|
|
43
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
44
|
+
|
|
45
|
+
> Confirm with the user before executing this destructive command.
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
25
49
|
# whop users delete-passkey
|
|
26
50
|
|
|
27
51
|
Delete
|
|
@@ -242,6 +266,7 @@ Update User
|
|
|
242
266
|
| Flag | Type | Required | Default | Description |
|
|
243
267
|
|------|------|----------|---------|-------------|
|
|
244
268
|
| `--account_id` | `string` | no | | The account whose profile override to update. Required for API key callers. |
|
|
269
|
+
| `--banner` | `unknown` | no | | |
|
|
245
270
|
| `--bio` | `string` | no | | |
|
|
246
271
|
| `--name` | `string` | no | | |
|
|
247
272
|
| `--profile_picture` | `object` | no | | |
|
|
@@ -260,6 +285,7 @@ Update Current User
|
|
|
260
285
|
| Flag | Type | Required | Default | Description |
|
|
261
286
|
|------|------|----------|---------|-------------|
|
|
262
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 | | |
|
|
263
289
|
| `--bio` | `string` | no | | |
|
|
264
290
|
| `--name` | `string` | no | | |
|
|
265
291
|
| `--profile_picture` | `object` | no | | |
|
|
@@ -277,6 +303,7 @@ Update
|
|
|
277
303
|
|
|
278
304
|
| Flag | Type | Required | Default | Description |
|
|
279
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. |
|
|
280
307
|
| `--investigation_enabled` | `boolean` | no | | Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access. |
|
|
281
308
|
|
|
282
309
|
> Confirm with the user before executing this destructive command.
|