@whop/cli 0.16.0 → 0.16.2
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 +17 -3
- package/dist/index.js +6647 -15750
- package/dist/index.js.map +1 -1
- package/dist/vite-devtools-stub.d.ts +22 -0
- package/dist/vite-devtools-stub.js +19 -0
- package/dist/vite-devtools-stub.js.map +1 -0
- package/dist/vite.d.ts +17 -2
- package/dist/vite.js +30 -5
- package/dist/vite.js.map +1 -1
- package/package.json +8 -7
- package/skills/whop/SKILL.md +48 -0
- package/skills/whop/references/ads.md +43 -0
- package/skills/whop/references/formation.md +40 -0
- package/skills/whop/references/websites.md +59 -0
- package/skills/whop-accounts/SKILL.md +0 -228
- package/skills/whop-ad-campaigns/SKILL.md +0 -204
- package/skills/whop-ad-groups/SKILL.md +0 -269
- package/skills/whop-ads/SKILL.md +0 -277
- package/skills/whop-api-keys/SKILL.md +0 -126
- package/skills/whop-app-builds/SKILL.md +0 -81
- package/skills/whop-apps/SKILL.md +0 -161
- package/skills/whop-audiences/SKILL.md +0 -105
- package/skills/whop-bounties/SKILL.md +0 -145
- package/skills/whop-bounty-submissions/SKILL.md +0 -95
- package/skills/whop-cards/SKILL.md +0 -133
- package/skills/whop-checkout-configurations/SKILL.md +0 -77
- package/skills/whop-deposits/SKILL.md +0 -26
- package/skills/whop-dispute-alerts/SKILL.md +0 -42
- package/skills/whop-disputes/SKILL.md +0 -99
- package/skills/whop-events/SKILL.md +0 -105
- package/skills/whop-exports/SKILL.md +0 -379
- package/skills/whop-ledgers/SKILL.md +0 -52
- package/skills/whop-media/SKILL.md +0 -44
- package/skills/whop-members/SKILL.md +0 -64
- package/skills/whop-memberships/SKILL.md +0 -165
- package/skills/whop-notifications/SKILL.md +0 -104
- package/skills/whop-partners/SKILL.md +0 -113
- package/skills/whop-payment-method-domains/SKILL.md +0 -93
- package/skills/whop-payments/SKILL.md +0 -40
- package/skills/whop-payouts/SKILL.md +0 -167
- package/skills/whop-people/SKILL.md +0 -63
- package/skills/whop-permissions/SKILL.md +0 -21
- package/skills/whop-plans/SKILL.md +0 -165
- package/skills/whop-products/SKILL.md +0 -153
- package/skills/whop-recommended-actions/SKILL.md +0 -59
- package/skills/whop-resolution-center-cases/SKILL.md +0 -233
- package/skills/whop-setup-intents/SKILL.md +0 -40
- package/skills/whop-shipments/SKILL.md +0 -79
- package/skills/whop-social-accounts/SKILL.md +0 -128
- package/skills/whop-stats/SKILL.md +0 -65
- package/skills/whop-swaps/SKILL.md +0 -77
- package/skills/whop-team-members/SKILL.md +0 -93
- package/skills/whop-transfers/SKILL.md +0 -80
- package/skills/whop-users/SKILL.md +0 -309
- package/skills/whop-verifications/SKILL.md +0 -67
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-team-members
|
|
3
|
-
description: An account's team members and the roles that scope their access. Run `whop team-members --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop team-members
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard.
|
|
9
|
-
|
|
10
|
-
Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead.
|
|
11
|
-
|
|
12
|
-
# whop team-members create
|
|
13
|
-
|
|
14
|
-
Create Team Member
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` | yes | | Account ID, prefixed `biz_`. |
|
|
21
|
-
| `--email` | `string` | no | | Email address to invite. Mutually exclusive with `user_id`. If the email already belongs to a Whop account it is treated the same as passing that account's `user_id`; otherwise a pending invite is created for the email. |
|
|
22
|
-
| `--role` | `string` | yes | | The system role to grant. |
|
|
23
|
-
| `--user_id` | `string` | no | | The user to add to the team, prefixed `user_`. Mutually exclusive with `email`. |
|
|
24
|
-
| `--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
|
-
|
|
26
|
-
> Confirm with the user before executing this destructive command.
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
|
|
30
|
-
# whop team-members delete
|
|
31
|
-
|
|
32
|
-
Delete Team Member
|
|
33
|
-
|
|
34
|
-
## Arguments
|
|
35
|
-
|
|
36
|
-
| Name | Type | Required | Description |
|
|
37
|
-
|------|------|----------|-------------|
|
|
38
|
-
| `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
|
|
39
|
-
|
|
40
|
-
> Confirm with the user before executing this destructive command.
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
# whop team-members get
|
|
45
|
-
|
|
46
|
-
Retrieve Team Member
|
|
47
|
-
|
|
48
|
-
## Arguments
|
|
49
|
-
|
|
50
|
-
| Name | Type | Required | Description |
|
|
51
|
-
|------|------|----------|-------------|
|
|
52
|
-
| `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
# whop team-members list
|
|
57
|
-
|
|
58
|
-
List Team Members
|
|
59
|
-
|
|
60
|
-
## Options
|
|
61
|
-
|
|
62
|
-
| Flag | Type | Required | Default | Description |
|
|
63
|
-
|------|------|----------|---------|-------------|
|
|
64
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
65
|
-
| `--status` | `string` | no | | Only return members with this status: `joined` (accepted members) or `pending` (pending invites). Both are returned by default. |
|
|
66
|
-
| `--user_id` | `string` | no | | Only return the membership for this user ID, prefixed `user_`. |
|
|
67
|
-
| `--role` | `string` | no | | Only return members with this role. `custom` matches members on a dashboard-managed custom role. |
|
|
68
|
-
| `--created_before` | `string` | no | | Only return members added before this ISO 8601 timestamp. |
|
|
69
|
-
| `--created_after` | `string` | no | | Only return members added after this ISO 8601 timestamp. |
|
|
70
|
-
| `--order` | `string` | no | | Field used to sort members. |
|
|
71
|
-
| `--direction` | `string` | no | | Sort direction. Defaults to `desc`. |
|
|
72
|
-
| `--first` | `number` | no | | Number of members to return. Defaults to 20; maximum 100. |
|
|
73
|
-
| `--after` | `string` | no | | Cursor for the next page of members. |
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
# whop team-members update
|
|
78
|
-
|
|
79
|
-
Update Team Member
|
|
80
|
-
|
|
81
|
-
## Arguments
|
|
82
|
-
|
|
83
|
-
| Name | Type | Required | Description |
|
|
84
|
-
|------|------|----------|-------------|
|
|
85
|
-
| `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
|
|
86
|
-
|
|
87
|
-
## Options
|
|
88
|
-
|
|
89
|
-
| Flag | Type | Required | Default | Description |
|
|
90
|
-
|------|------|----------|---------|-------------|
|
|
91
|
-
| `--role` | `string` | yes | | The system role to grant. |
|
|
92
|
-
|
|
93
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-transfers
|
|
3
|
-
description: Move funds between Whop accounts and users. Run `whop transfers --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop transfers
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type.
|
|
9
|
-
|
|
10
|
-
Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users.
|
|
11
|
-
|
|
12
|
-
# whop transfers create
|
|
13
|
-
|
|
14
|
-
Create Transfer
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--amount` | `number` | yes | | The amount to move, in the transfer currency. For example 25.00. |
|
|
21
|
-
| `--currency` | `string` | no | | Currency, such as `usd`. Required for ledger transfers. |
|
|
22
|
-
| `--destination_id` | `string` | no | | The recipient. Required for ledger and wallet_send (a user_/biz_/ldgr_ ID, or — for sends — an email). Omit for claim_link. |
|
|
23
|
-
| `--expires_at` | `unknown` | no | | claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from creation. |
|
|
24
|
-
| `--idempotence_key` | `unknown` | no | | Ledger transfers and wallet sends. A unique key that makes retries safe. Retrying with the same key returns the original transfer, or attaches to the original wallet send, instead of moving money twice. |
|
|
25
|
-
| `--metadata` | `unknown` | no | | Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50 keys, 100 chars per key, 500 chars per string value. |
|
|
26
|
-
| `--notes` | `unknown` | no | | Ledger transfers only. A short note describing the transfer. |
|
|
27
|
-
| `--origin_id` | `string` | yes | | The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx). |
|
|
28
|
-
| `--redeemable_count` | `number` | no | | claim_link only. How many different users can claim the link. Defaults to 1. |
|
|
29
|
-
| `--type` | `string` | no | | The kind of money movement, which decides what comes back. Defaults to ledger. `ledger` moves credit between two Whop balances and returns a `transfer`; `wallet_send` sends USDT from the origin account's Ethereum wallet and returns a `send`; `claim_link` funds a shareable link anyone with the URL can redeem and returns a `claim_link`. A `ledger` transfer from a stablecoin-rails account settles on-chain when covered, and still returns a `transfer`. |
|
|
30
|
-
| `--idempotency-key` | `string` | yes | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
31
|
-
|
|
32
|
-
> Confirmation policy: For `--type ledger` only, the user's request to execute the transfer counts as confirmation when it includes exact `--origin_id`, `--destination_id`, `--amount`, and `--currency` values and both IDs use a `biz_`, `user_`, or `ldgr_` prefix. Execute that confirmed transfer yourself. This exception does not apply to `wallet_send` or `claim_link`; ask for explicit confirmation before executing those transfer types. Always include a unique `--idempotency-key`. If a result is uncertain, retry the same transfer with the same key.
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
# whop transfers get
|
|
37
|
-
|
|
38
|
-
Retrieve Transfer
|
|
39
|
-
|
|
40
|
-
## Arguments
|
|
41
|
-
|
|
42
|
-
| Name | Type | Required | Description |
|
|
43
|
-
|------|------|----------|-------------|
|
|
44
|
-
| `id` | `string` | yes | The transfer ID. |
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
# whop transfers list
|
|
49
|
-
|
|
50
|
-
List Transfers
|
|
51
|
-
|
|
52
|
-
## Options
|
|
53
|
-
|
|
54
|
-
| Flag | Type | Required | Default | Description |
|
|
55
|
-
|------|------|----------|---------|-------------|
|
|
56
|
-
| `--origin_id` | `string` | no | | Filter to transfers sent from this account. Provide this or destination_id. |
|
|
57
|
-
| `--destination_id` | `string` | no | | Filter to transfers received by this account. Provide this or origin_id. |
|
|
58
|
-
| `--order` | `string` | no | | Sort column. Defaults to created_at. |
|
|
59
|
-
| `--direction` | `string` | no | | Sort direction. Defaults to desc. |
|
|
60
|
-
| `--created_before` | `string` | no | | Only transfers created strictly before this ISO 8601 timestamp. |
|
|
61
|
-
| `--created_after` | `string` | no | | Only transfers created strictly after this ISO 8601 timestamp. |
|
|
62
|
-
| `--first` | `number` | no | `50` | Number of transfers to return from the start of the window. |
|
|
63
|
-
| `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
|
|
64
|
-
| `--last` | `number` | no | | Number of transfers to return from the end of the window. |
|
|
65
|
-
| `--before` | `string` | no | | Cursor to fetch the page before (from page_info.start_cursor). |
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
# whop transfers recipients
|
|
70
|
-
|
|
71
|
-
List Transfer Recipients
|
|
72
|
-
|
|
73
|
-
## Options
|
|
74
|
-
|
|
75
|
-
| Flag | Type | Required | Default | Description |
|
|
76
|
-
|------|------|----------|---------|-------------|
|
|
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
|
-
| `--first` | `number` | no | `20` | Number of recipients per page. Search queries preserve the dashboard's 20-result maximum. |
|
|
80
|
-
| `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
|
|
@@ -1,309 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-users
|
|
3
|
-
description: "A person on Whop: profile and connected identities. Run `whop users --help` for usage details."
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop users
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences.
|
|
9
|
-
|
|
10
|
-
Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience.
|
|
11
|
-
|
|
12
|
-
# whop users access
|
|
13
|
-
|
|
14
|
-
Check User Access
|
|
15
|
-
|
|
16
|
-
## Arguments
|
|
17
|
-
|
|
18
|
-
| Name | Type | Required | Description |
|
|
19
|
-
|------|------|----------|-------------|
|
|
20
|
-
| `id` | `string` | yes | The user_ tag or username to check access for. |
|
|
21
|
-
| `resource_id` | `string` | yes | An account (biz_), product (prod_), or experience (exp_) ID. |
|
|
22
|
-
|
|
23
|
-
---
|
|
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
|
-
|
|
49
|
-
# whop users delete-passkey
|
|
50
|
-
|
|
51
|
-
Delete
|
|
52
|
-
|
|
53
|
-
## Arguments
|
|
54
|
-
|
|
55
|
-
| Name | Type | Required | Description |
|
|
56
|
-
|------|------|----------|-------------|
|
|
57
|
-
| `id` | `string` | yes | Passkey ID, prefixed `wcred_`. |
|
|
58
|
-
|
|
59
|
-
## Options
|
|
60
|
-
|
|
61
|
-
| Flag | Type | Required | Default | Description |
|
|
62
|
-
|------|------|----------|---------|-------------|
|
|
63
|
-
| `--authenticator_data` | `string` | yes | | The `authenticatorData` from the WebAuthn assertion, base64url-encoded. |
|
|
64
|
-
| `--client_data_json` | `string` | yes | | The `clientDataJSON` from the WebAuthn assertion, base64url-encoded. |
|
|
65
|
-
| `--signature` | `string` | yes | | The `signature` from the WebAuthn assertion, base64url-encoded. |
|
|
66
|
-
|
|
67
|
-
> Confirm with the user before executing this destructive command.
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
# whop users experience-notification-preferences
|
|
72
|
-
|
|
73
|
-
List Experiences
|
|
74
|
-
|
|
75
|
-
## Options
|
|
76
|
-
|
|
77
|
-
| Flag | Type | Required | Default | Description |
|
|
78
|
-
|------|------|----------|---------|-------------|
|
|
79
|
-
| `--first` | `number` | no | | The number of preferences to return. |
|
|
80
|
-
| `--after` | `string` | no | | A cursor; returns preferences after this position. |
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
# whop users get
|
|
85
|
-
|
|
86
|
-
Retrieve User
|
|
87
|
-
|
|
88
|
-
## Arguments
|
|
89
|
-
|
|
90
|
-
| Name | Type | Required | Description |
|
|
91
|
-
|------|------|----------|-------------|
|
|
92
|
-
| `id` | `string` | yes | User ID (prefixed `user_`) or username. |
|
|
93
|
-
|
|
94
|
-
## Options
|
|
95
|
-
|
|
96
|
-
| Flag | Type | Required | Default | Description |
|
|
97
|
-
|------|------|----------|---------|-------------|
|
|
98
|
-
| `--account_id` | `string` | no | | When set, returns the user's account-specific profile overrides for this account. |
|
|
99
|
-
|
|
100
|
-
---
|
|
101
|
-
|
|
102
|
-
# whop users list
|
|
103
|
-
|
|
104
|
-
List Users
|
|
105
|
-
|
|
106
|
-
## Options
|
|
107
|
-
|
|
108
|
-
| Flag | Type | Required | Default | Description |
|
|
109
|
-
|------|------|----------|---------|-------------|
|
|
110
|
-
| `--query` | `string` | no | | A search term to filter users by name or username. |
|
|
111
|
-
| `--first` | `number` | no | | The number of users to return (max 50). |
|
|
112
|
-
| `--after` | `string` | no | | A cursor; returns users after this position. |
|
|
113
|
-
| `--last` | `number` | no | | The number of users to return from the end of the range. |
|
|
114
|
-
| `--before` | `string` | no | | A cursor; returns users before this position. |
|
|
115
|
-
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
# whop users me
|
|
119
|
-
|
|
120
|
-
Retrieve Current User
|
|
121
|
-
|
|
122
|
-
## Options
|
|
123
|
-
|
|
124
|
-
| Flag | Type | Required | Default | Description |
|
|
125
|
-
|------|------|----------|---------|-------------|
|
|
126
|
-
| `--account_id` | `string` | no | | When set, returns your account-specific profile overrides for this account. |
|
|
127
|
-
| `--include_balance_history` | `boolean` | no | | Also compute your balance history (opt-in; runs a heavier query). Ignored for callers without balance-read scope. |
|
|
128
|
-
| `--from` | `string` | no | | Balance-history window start, ISO 8601 date or datetime. Defaults to 30 days ago. Only used with `include_balance_history`. |
|
|
129
|
-
| `--to` | `string` | no | | Balance-history window end, ISO 8601 date or datetime. Defaults to now. Only used with `include_balance_history`. |
|
|
130
|
-
| `--interval` | `string` | no | | Balance-history point granularity. Defaults to `day`. Only used with `include_balance_history`. |
|
|
131
|
-
| `--time_zone` | `string` | no | | IANA time zone the balance-history points are bucketed in. Defaults to `UTC`. Only used with `include_balance_history`. |
|
|
132
|
-
|
|
133
|
-
---
|
|
134
|
-
|
|
135
|
-
# whop users me-oauth_grants
|
|
136
|
-
|
|
137
|
-
List OAuth Grants
|
|
138
|
-
|
|
139
|
-
## Options
|
|
140
|
-
|
|
141
|
-
| Flag | Type | Required | Default | Description |
|
|
142
|
-
|------|------|----------|---------|-------------|
|
|
143
|
-
| `--app_id` | `string` | no | | Only return grants for this app, prefixed `app_`. An app the user has never authorized returns an empty list. |
|
|
144
|
-
| `--first` | `number` | no | | The number of grants to return (default 20, max 100). |
|
|
145
|
-
| `--after` | `string` | no | | A cursor; returns grants after this position. |
|
|
146
|
-
| `--last` | `number` | no | | The number of grants to return from the end of the range. |
|
|
147
|
-
| `--before` | `string` | no | | A cursor; returns grants before this position. |
|
|
148
|
-
| `--order` | `string` | no | | The field to sort grants by. |
|
|
149
|
-
| `--direction` | `string` | no | | Sort direction. |
|
|
150
|
-
|
|
151
|
-
---
|
|
152
|
-
|
|
153
|
-
# whop users notification-topic-preferences
|
|
154
|
-
|
|
155
|
-
List Topics
|
|
156
|
-
|
|
157
|
-
## Options
|
|
158
|
-
|
|
159
|
-
| Flag | Type | Required | Default | Description |
|
|
160
|
-
|------|------|----------|---------|-------------|
|
|
161
|
-
| `--channel` | `string` | no | | Only return preferences for this delivery channel (or not narrowed to a channel). |
|
|
162
|
-
| `--account_id` | `string` | no | | Only return preferences scoped to this account's member notifications (`biz_` tag). |
|
|
163
|
-
| `--team_account_id` | `string` | no | | Only return preferences scoped to this account's team notifications (`biz_` tag). |
|
|
164
|
-
| `--experience_id` | `string` | no | | Only return preferences scoped to this experience (`exp_` tag). |
|
|
165
|
-
| `--topic_id` | `string` | no | | Only return preferences scoped to this notification topic (`topic_` tag). |
|
|
166
|
-
| `--first` | `number` | no | | The number of preferences to return. |
|
|
167
|
-
| `--after` | `string` | no | | A cursor; returns preferences after this position. |
|
|
168
|
-
|
|
169
|
-
---
|
|
170
|
-
|
|
171
|
-
# whop users passkey-challenge
|
|
172
|
-
|
|
173
|
-
Create Challenge
|
|
174
|
-
|
|
175
|
-
## Options
|
|
176
|
-
|
|
177
|
-
| Flag | Type | Required | Default | Description |
|
|
178
|
-
|------|------|----------|---------|-------------|
|
|
179
|
-
| `--challenge_type` | `string` | yes | | The ceremony this challenge is for. |
|
|
180
|
-
| `--passkey_id` | `string` | no | | The passkey the ceremony targets, prefixed `wcred_`. Required when `challenge_type` is `deletion`, ignored otherwise. |
|
|
181
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
182
|
-
|
|
183
|
-
> Confirm with the user before executing this destructive command.
|
|
184
|
-
|
|
185
|
-
---
|
|
186
|
-
|
|
187
|
-
# whop users passkeys
|
|
188
|
-
|
|
189
|
-
List
|
|
190
|
-
|
|
191
|
-
## Options
|
|
192
|
-
|
|
193
|
-
| Flag | Type | Required | Default | Description |
|
|
194
|
-
|------|------|----------|---------|-------------|
|
|
195
|
-
| `--first` | `number` | no | | The number of passkeys to return (default 20, max 100). |
|
|
196
|
-
| `--after` | `string` | no | | A cursor; returns passkeys after this position. |
|
|
197
|
-
| `--last` | `number` | no | | The number of passkeys to return from the end of the range. |
|
|
198
|
-
| `--before` | `string` | no | | A cursor; returns passkeys before this position. |
|
|
199
|
-
| `--order` | `string` | no | | The field to sort passkeys by. |
|
|
200
|
-
| `--direction` | `string` | no | | Sort direction. |
|
|
201
|
-
|
|
202
|
-
---
|
|
203
|
-
|
|
204
|
-
# whop users preferences
|
|
205
|
-
|
|
206
|
-
Retrieve
|
|
207
|
-
|
|
208
|
-
---
|
|
209
|
-
|
|
210
|
-
# whop users recommend_actions
|
|
211
|
-
|
|
212
|
-
List Recommended Actions
|
|
213
|
-
|
|
214
|
-
## Arguments
|
|
215
|
-
|
|
216
|
-
| Name | Type | Required | Description |
|
|
217
|
-
|------|------|----------|-------------|
|
|
218
|
-
| `id` | `string` | yes | `me`, or the authenticated user's own `user_` tag or username. |
|
|
219
|
-
|
|
220
|
-
---
|
|
221
|
-
|
|
222
|
-
# whop users register-passkey
|
|
223
|
-
|
|
224
|
-
Register
|
|
225
|
-
|
|
226
|
-
## Options
|
|
227
|
-
|
|
228
|
-
| Flag | Type | Required | Default | Description |
|
|
229
|
-
|------|------|----------|---------|-------------|
|
|
230
|
-
| `--attestation_object` | `string` | yes | | The `attestationObject` from the WebAuthn attestation response, base64url-encoded. |
|
|
231
|
-
| `--client_data_json` | `string` | yes | | The `clientDataJSON` from the WebAuthn attestation response, base64url-encoded. |
|
|
232
|
-
| `--credential_id` | `string` | yes | | The WebAuthn credential ID the authenticator returned, base64url-encoded. |
|
|
233
|
-
| `--nickname` | `string` | yes | | A name for this passkey, usually the device it lives on. 255 characters or fewer. |
|
|
234
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
235
|
-
|
|
236
|
-
> Confirm with the user before executing this destructive command.
|
|
237
|
-
|
|
238
|
-
---
|
|
239
|
-
|
|
240
|
-
# whop users set-notification-preferences
|
|
241
|
-
|
|
242
|
-
Set
|
|
243
|
-
|
|
244
|
-
## Options
|
|
245
|
-
|
|
246
|
-
| Flag | Type | Required | Default | Description |
|
|
247
|
-
|------|------|----------|---------|-------------|
|
|
248
|
-
| `--preferences` | `array` | yes | | The preferences to set, at most 100 per request. |
|
|
249
|
-
|
|
250
|
-
> Confirm with the user before executing this destructive command.
|
|
251
|
-
|
|
252
|
-
---
|
|
253
|
-
|
|
254
|
-
# whop users update
|
|
255
|
-
|
|
256
|
-
Update User
|
|
257
|
-
|
|
258
|
-
## Arguments
|
|
259
|
-
|
|
260
|
-
| Name | Type | Required | Description |
|
|
261
|
-
|------|------|----------|-------------|
|
|
262
|
-
| `id` | `string` | yes | User ID (prefixed `user_`) or username. |
|
|
263
|
-
|
|
264
|
-
## Options
|
|
265
|
-
|
|
266
|
-
| Flag | Type | Required | Default | Description |
|
|
267
|
-
|------|------|----------|---------|-------------|
|
|
268
|
-
| `--account_id` | `string` | no | | The account whose profile override to update. Required for API key callers. |
|
|
269
|
-
| `--banner` | `unknown` | no | | |
|
|
270
|
-
| `--bio` | `string` | no | | |
|
|
271
|
-
| `--name` | `string` | no | | |
|
|
272
|
-
| `--profile_picture` | `object` | no | | |
|
|
273
|
-
| `--username` | `string` | no | | |
|
|
274
|
-
|
|
275
|
-
> Confirm with the user before executing this destructive command.
|
|
276
|
-
|
|
277
|
-
---
|
|
278
|
-
|
|
279
|
-
# whop users update-me
|
|
280
|
-
|
|
281
|
-
Update Current User
|
|
282
|
-
|
|
283
|
-
## Options
|
|
284
|
-
|
|
285
|
-
| Flag | Type | Required | Default | Description |
|
|
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 | | |
|
|
289
|
-
| `--bio` | `string` | no | | |
|
|
290
|
-
| `--name` | `string` | no | | |
|
|
291
|
-
| `--profile_picture` | `object` | no | | |
|
|
292
|
-
| `--username` | `string` | no | | |
|
|
293
|
-
|
|
294
|
-
> Confirm with the user before executing this destructive command.
|
|
295
|
-
|
|
296
|
-
---
|
|
297
|
-
|
|
298
|
-
# whop users update-preferences
|
|
299
|
-
|
|
300
|
-
Update
|
|
301
|
-
|
|
302
|
-
## Options
|
|
303
|
-
|
|
304
|
-
| Flag | Type | Required | Default | Description |
|
|
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. |
|
|
307
|
-
| `--investigation_enabled` | `boolean` | no | | Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access. |
|
|
308
|
-
|
|
309
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-verifications
|
|
3
|
-
description: Legal identity required before payouts and card issuing. Run `whop verifications --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop verifications
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows.
|
|
9
|
-
|
|
10
|
-
Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](https://docs.whop.com/api-reference/beta/verifications/update-verification).
|
|
11
|
-
|
|
12
|
-
# whop verifications create
|
|
13
|
-
|
|
14
|
-
Create Verification
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` | no | | Account or user ID whose identity you want to verify. Use a `biz_` account ID for account verifications, or the caller's `user_` ID for personal verification. |
|
|
21
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
22
|
-
|
|
23
|
-
> Confirm with the user before executing this destructive command.
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
# whop verifications get
|
|
28
|
-
|
|
29
|
-
Retrieve Verification
|
|
30
|
-
|
|
31
|
-
## Arguments
|
|
32
|
-
|
|
33
|
-
| Name | Type | Required | Description |
|
|
34
|
-
|------|------|----------|-------------|
|
|
35
|
-
| `id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
# whop verifications list
|
|
40
|
-
|
|
41
|
-
List Verifications
|
|
42
|
-
|
|
43
|
-
## Options
|
|
44
|
-
|
|
45
|
-
| Flag | Type | Required | Default | Description |
|
|
46
|
-
|------|------|----------|---------|-------------|
|
|
47
|
-
| `--account_id` | `string` | no | | Account or user ID whose verifications you want to list. Use a `biz_` account ID, or the caller's `user_` ID for personal verifications. |
|
|
48
|
-
| `--order` | `string` | no | | Field used to sort returned verifications. |
|
|
49
|
-
| `--direction` | `string` | no | | Sort direction for returned verifications. |
|
|
50
|
-
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
# whop verifications update
|
|
54
|
-
|
|
55
|
-
Update Verification
|
|
56
|
-
|
|
57
|
-
## Arguments
|
|
58
|
-
|
|
59
|
-
| Name | Type | Required | Description |
|
|
60
|
-
|------|------|----------|-------------|
|
|
61
|
-
| `id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
|
|
62
|
-
|
|
63
|
-
> Confirm with the user before executing this destructive command.
|
|
64
|
-
|
|
65
|
-
## Steps that finish in the browser
|
|
66
|
-
|
|
67
|
-
Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`, `checkout_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
|