@whop/cli 0.13.1 → 0.14.1
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 +18 -0
- package/dist/index.js +16291 -5630
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/skills/whop-accounts/SKILL.md +1 -1
- package/skills/whop-api-keys/SKILL.md +2 -2
- package/skills/whop-audiences/SKILL.md +1 -0
- package/skills/whop-cards/SKILL.md +2 -0
- package/skills/whop-disputes/SKILL.md +22 -0
- package/skills/whop-events/SKILL.md +5 -1
- package/skills/whop-exports/SKILL.md +20 -0
- package/skills/whop-members/SKILL.md +19 -0
- package/skills/whop-memberships/SKILL.md +24 -0
- package/skills/whop-notifications/SKILL.md +25 -0
- package/skills/whop-permissions/SKILL.md +18 -0
- package/skills/whop-products/SKILL.md +2 -0
- package/skills/whop-resolution-center-cases/SKILL.md +28 -0
- package/skills/whop-shipments/SKILL.md +21 -0
- package/skills/whop-transfers/SKILL.md +1 -0
- package/skills/whop-users/SKILL.md +5 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@whop/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.1",
|
|
4
4
|
"description": "The Whop CLI — build and manage Whop apps from your terminal. Human and agent friendly.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agent",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@types/node": "25.3.5",
|
|
46
46
|
"fflate": "0.8.2",
|
|
47
|
-
"incur": "github:whopio/incur#
|
|
47
|
+
"incur": "github:whopio/incur#6962ec46a0fbc5d070df5e8cd4c8cf09efa91bdc",
|
|
48
48
|
"tsup": "8.5.0",
|
|
49
49
|
"tsx": "4.19.4",
|
|
50
50
|
"typescript": "5.9.3",
|
|
@@ -18,7 +18,7 @@ Use the Accounts API to create accounts, list accounts visible to your credentia
|
|
|
18
18
|
| `whop accounts me` | Retrieve Requesting Account |
|
|
19
19
|
| `whop accounts get` | Retrieve Account |
|
|
20
20
|
| `whop accounts update` | Update Account |
|
|
21
|
-
| `whop accounts
|
|
21
|
+
| `whop accounts form_company` | Form Company |
|
|
22
22
|
| `whop accounts preferences` | Retrieve Account Preferences |
|
|
23
23
|
| `whop accounts update-preferences` | Update Account Preferences |
|
|
24
24
|
| `whop accounts recommend_actions` | List Recommended Actions |
|
|
@@ -7,7 +7,7 @@ command: whop api-keys
|
|
|
7
7
|
|
|
8
8
|
An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist.
|
|
9
9
|
|
|
10
|
-
Use the API Keys API to list
|
|
10
|
+
Use the API Keys API to list an account or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key.
|
|
11
11
|
|
|
12
12
|
## Commands
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ Use the API Keys API to list a company or app's keys, create a key (the full sec
|
|
|
15
15
|
|---------|-------------|
|
|
16
16
|
| `whop api-keys list` | List API Keys |
|
|
17
17
|
| `whop api-keys create` | Create API Key |
|
|
18
|
-
| `whop api-keys permissions` | List
|
|
18
|
+
| `whop api-keys permissions` | List the Permission Catalog |
|
|
19
19
|
| `whop api-keys delete` | Delete API Key |
|
|
20
20
|
| `whop api-keys get` | Retrieve API Key |
|
|
21
21
|
| `whop api-keys update` | Update API Key |
|
|
@@ -16,5 +16,6 @@ Use the Audiences API to create audiences from CSV uploads, monitor processing s
|
|
|
16
16
|
| `whop audiences list` | List Audiences |
|
|
17
17
|
| `whop audiences create` | Create Audience |
|
|
18
18
|
| `whop audiences delete` | Delete Audience |
|
|
19
|
+
| `whop audiences update` | Update Audience |
|
|
19
20
|
|
|
20
21
|
Run `whop audiences <command> --help` for options, or `whop audiences <command> --schema` for full argument details.
|
|
@@ -13,6 +13,8 @@ Use the Cards API to issue cards, list cards for an account or user, and retriev
|
|
|
13
13
|
|
|
14
14
|
| Command | Description |
|
|
15
15
|
|---------|-------------|
|
|
16
|
+
| `whop cards transactions` | List Card Transactions |
|
|
17
|
+
| `whop cards get-transaction` | Retrieve Card Transaction |
|
|
16
18
|
| `whop cards list` | List Cards |
|
|
17
19
|
| `whop cards create` | Create Card |
|
|
18
20
|
| `whop cards get` | Retrieve Card |
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-disputes
|
|
3
|
+
description: Chargebacks filed against an account, with evidence and outcomes. Run `whop disputes --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop disputes
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Dispute is a chargeback a customer files against a payment through their bank, or a pre-dispute inquiry that may become one. It carries the disputed payment, a deadline to respond, the evidence packet you send to the payment processor, and the outcome once the processor rules.
|
|
9
|
+
|
|
10
|
+
Disputes are opened by the customer's bank, never through the API, so you can read them but not create or delete them. Use the Disputes API to list and filter disputes, summarize them by status and currency for a queue view, edit the evidence packet while the dispute is still contestable, and submit that evidence for review.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop disputes list` | List Disputes |
|
|
17
|
+
| `whop disputes summary` | Retrieve Dispute Summary |
|
|
18
|
+
| `whop disputes get` | Retrieve Dispute |
|
|
19
|
+
| `whop disputes update` | Update Dispute |
|
|
20
|
+
| `whop disputes submit` | Submit Dispute |
|
|
21
|
+
|
|
22
|
+
Run `whop disputes <command> --help` for options, or `whop disputes <command> --schema` for full argument details.
|
|
@@ -7,7 +7,9 @@ command: whop events
|
|
|
7
7
|
|
|
8
8
|
An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](https://docs.whop.com/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it.
|
|
9
9
|
|
|
10
|
-
Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person.
|
|
10
|
+
Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. The resource also exposes an anonymized read mode — the pulse feed — a platform-wide snapshot of recent purchases that carries nothing identifying. The pulse feed is public; other Events endpoints require authentication and are scoped to an account.
|
|
11
|
+
|
|
12
|
+
Events are only as good as the pixel sending them, so [Validate Pixel](https://docs.whop.com/api-reference/beta/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.
|
|
11
13
|
|
|
12
14
|
## Commands
|
|
13
15
|
|
|
@@ -15,5 +17,7 @@ Use the Events API to send new tracking events, list recent identity-linked even
|
|
|
15
17
|
|---------|-------------|
|
|
16
18
|
| `whop events list` | List Events |
|
|
17
19
|
| `whop events create` | Create Event |
|
|
20
|
+
| `whop events pulse` | Retrieve the pulse feed |
|
|
21
|
+
| `whop events validate_pixel` | Validate Pixel |
|
|
18
22
|
|
|
19
23
|
Run `whop events <command> --help` for options, or `whop events <command> --schema` for full argument details.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-exports
|
|
3
|
+
description: Asynchronous CSV dumps of an account's dashboard data. Run `whop exports --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop exports
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
An Export is an asynchronous CSV of one resource for one account — members, payments, disputes, ads, and the other tables the Whop dashboard can export. Generating a full table takes longer than a request, so an export is created in `pending`, moves through `processing`, and lands on `completed` with a download link. Each resource requires that resource's own export scope.
|
|
9
|
+
|
|
10
|
+
Use the Exports API to start an export, poll it until `download_url` is set, and list the exports already requested for an account. Finished CSVs are retained for 30 days, after which the file is deleted and the export moves to `expired`.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop exports list` | List Exports |
|
|
17
|
+
| `whop exports create` | Create Export |
|
|
18
|
+
| `whop exports get` | Retrieve Export |
|
|
19
|
+
|
|
20
|
+
Run `whop exports <command> --help` for options, or `whop exports <command> --schema` for full argument details.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-members
|
|
3
|
+
description: One buyer's relationship with an account, across all their purchases. Run `whop members --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop members
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Member is one buyer's relationship with an account — one record per customer regardless of how many memberships they hold. It carries relationship-level state: whether they have joined or left, their access level (`customer`, `admin`, or `no_access`), when they joined, and when they last opened the account's content.
|
|
9
|
+
|
|
10
|
+
Use the Members API to list an account's members with filtering by access level, status, join date, and name or username search, and to retrieve a single member. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop members list` | List Members |
|
|
17
|
+
| `whop members get` | Retrieve Member |
|
|
18
|
+
|
|
19
|
+
Run `whop members <command> --help` for options, or `whop members <command> --schema` for full argument details.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-memberships
|
|
3
|
+
description: A customer's purchase of a plan, from checkout through cancellation. Run `whop memberships --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop memberships
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Membership is a customer's purchase of a plan: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing.
|
|
9
|
+
|
|
10
|
+
Use the Memberships API to list an account's memberships or the caller's own, retrieve one by ID or license key, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled period-end cancellation, pause and resume payment collection, extend with free days, and update metadata.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop memberships list` | List Memberships |
|
|
17
|
+
| `whop memberships get` | Retrieve Membership |
|
|
18
|
+
| `whop memberships update` | Update Membership |
|
|
19
|
+
| `whop memberships cancel` | Cancel Membership |
|
|
20
|
+
| `whop memberships extend` | Extend Membership |
|
|
21
|
+
| `whop memberships pause` | Pause Membership |
|
|
22
|
+
| `whop memberships resume` | Resume Membership |
|
|
23
|
+
|
|
24
|
+
Run `whop memberships <command> --help` for options, or `whop memberships <command> --schema` for full argument details.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-notifications
|
|
3
|
+
description: "The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. Run `whop notifications --help` for usage details."
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop notifications
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Notification is a message delivered to a user — a new post, a payment, a mention. Every notification comes from an experience the user belongs to or a team they are on, and users control what they receive with notification preferences.
|
|
9
|
+
|
|
10
|
+
Every notification belongs to a topic: the category it falls under, such as new sales or account activity. Topics carry a default, so a user only needs a preference row where they diverge from it. `GET /notifications/topics` lists the platform's visible topics, and a topic's `id` is what the notification preference endpoints take as `topic_id` — the catalog is the only place those ids come from, so read it rather than hardcoding. Each topic also carries an `identifier` such as `new-follower`, which is stable across environments and is the value to match on in code.
|
|
11
|
+
|
|
12
|
+
Use the Notifications API to list the authenticated user's feed, read per-experience unread badges, mark an experience (or everything) as read, send notifications from your app to an experience's users or an account's team, and list the topic catalog.
|
|
13
|
+
|
|
14
|
+
## Commands
|
|
15
|
+
|
|
16
|
+
| Command | Description |
|
|
17
|
+
|---------|-------------|
|
|
18
|
+
| `whop notifications list` | List Notifications |
|
|
19
|
+
| `whop notifications create` | Send Notification |
|
|
20
|
+
| `whop notifications badges` | List Notification Badges |
|
|
21
|
+
| `whop notifications mark_read` | Mark Notifications Read |
|
|
22
|
+
| `whop notifications topics` | List Notification Topics |
|
|
23
|
+
| `whop notifications get` | Retrieve Notification |
|
|
24
|
+
|
|
25
|
+
Run `whop notifications <command> --help` for options, or `whop notifications <command> --schema` for full argument details.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-permissions
|
|
3
|
+
description: What your credential is allowed to do on a resource. Run `whop permissions --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop permissions
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Permission is one action, such as `stats:read`, paired with whether your credential is granted it on a given resource. It answers for whatever you authenticated with, so you can decide what to show or attempt instead of discovering a `403`.
|
|
9
|
+
|
|
10
|
+
Use the Permissions API to check an account, product, experience, or app, narrowing to the actions you care about. It reports only your own access — to manage who else can reach an account, use the Team Members API.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop permissions check` | Check Permissions |
|
|
17
|
+
|
|
18
|
+
Run `whop permissions <command> --help` for options, or `whop permissions <command> --schema` for full argument details.
|
|
@@ -18,5 +18,7 @@ Use the Products API to create products, list products visible to your credentia
|
|
|
18
18
|
| `whop products delete` | Delete Product |
|
|
19
19
|
| `whop products get` | Retrieve Product |
|
|
20
20
|
| `whop products update` | Update Product |
|
|
21
|
+
| `whop products publish` | Publish Product |
|
|
22
|
+
| `whop products unpublish` | Unpublish Product |
|
|
21
23
|
|
|
22
24
|
Run `whop products <command> --help` for options, or `whop products <command> --schema` for full argument details.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-resolution-center-cases
|
|
3
|
+
description: File or respond to a case against a payment, as the buyer or the merchant. Run `whop resolution-center-cases --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop resolution-center-cases
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Resolution Center Case is opened by a buyer when something is wrong with a purchase — an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the two sides work it out directly, and Whop decides the case if they can't. Each case carries a reason, a status naming which side it is waiting on, a timeline of events, and the actions available to whoever is reading it.
|
|
9
|
+
|
|
10
|
+
Use the Resolution Center Cases API from either side: as the buyer, open a case, reply, appeal a decision, or withdraw it; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. Both sides read the same case, page its timeline, and summarize the cases they can see.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop resolution-center-cases list` | List Resolution Center Cases |
|
|
17
|
+
| `whop resolution-center-cases create` | Open a Case as the Customer |
|
|
18
|
+
| `whop resolution-center-cases summary` | Retrieve Resolution Center Case Summary |
|
|
19
|
+
| `whop resolution-center-cases get` | Retrieve Resolution Center Case |
|
|
20
|
+
| `whop resolution-center-cases accept` | Accept a Case |
|
|
21
|
+
| `whop resolution-center-cases appeal` | Appeal a Case |
|
|
22
|
+
| `whop resolution-center-cases deny` | Deny a Case |
|
|
23
|
+
| `whop resolution-center-cases events` | List Resolution Center Case Events |
|
|
24
|
+
| `whop resolution-center-cases reply` | Reply to a Case |
|
|
25
|
+
| `whop resolution-center-cases request_info` | Request Information from the Customer |
|
|
26
|
+
| `whop resolution-center-cases withdraw` | Withdraw a Case |
|
|
27
|
+
|
|
28
|
+
Run `whop resolution-center-cases <command> --help` for options, or `whop resolution-center-cases <command> --schema` for full argument details.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-shipments
|
|
3
|
+
description: Track the delivery of an order by its carrier tracking number. Run `whop shipments --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop shipments
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Shipment attaches a carrier tracking number to a payment and follows the package from label creation to delivery, exposing the current delivery status and a customer-facing tracking URL.
|
|
9
|
+
|
|
10
|
+
Use the Shipments API to list an account's shipments, retrieve one by its id or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment.
|
|
11
|
+
|
|
12
|
+
## Commands
|
|
13
|
+
|
|
14
|
+
| Command | Description |
|
|
15
|
+
|---------|-------------|
|
|
16
|
+
| `whop shipments list` | List Shipments |
|
|
17
|
+
| `whop shipments create` | Create Shipment |
|
|
18
|
+
| `whop shipments get` | Retrieve Shipment |
|
|
19
|
+
| `whop shipments update` | Update Shipment |
|
|
20
|
+
|
|
21
|
+
Run `whop shipments <command> --help` for options, or `whop shipments <command> --schema` for full argument details.
|
|
@@ -15,6 +15,7 @@ Use the Transfers API to create a transfer, list previous transfers, and retriev
|
|
|
15
15
|
|---------|-------------|
|
|
16
16
|
| `whop transfers list` | List Transfers |
|
|
17
17
|
| `whop transfers create` | Create Transfer |
|
|
18
|
+
| `whop transfers recipients` | List Transfer Recipients |
|
|
18
19
|
| `whop transfers get` | Retrieve Transfer |
|
|
19
20
|
|
|
20
21
|
Run `whop transfers <command> --help` for options, or `whop transfers <command> --schema` for full argument details.
|
|
@@ -16,6 +16,11 @@ Use the Users API to search for users, retrieve or update profiles, and check wh
|
|
|
16
16
|
| `whop users list` | List Users |
|
|
17
17
|
| `whop users me` | Retrieve Current User |
|
|
18
18
|
| `whop users update-me` | Update Current User |
|
|
19
|
+
| `whop users preferences` | Retrieve |
|
|
20
|
+
| `whop users update-preferences` | Update |
|
|
21
|
+
| `whop users set-notification-preferences` | Set |
|
|
22
|
+
| `whop users experience-notification-preferences` | List Experiences |
|
|
23
|
+
| `whop users notification-topic-preferences` | List Topics |
|
|
19
24
|
| `whop users get` | Retrieve User |
|
|
20
25
|
| `whop users update` | Update User |
|
|
21
26
|
| `whop users access` | Check User Access |
|