@whop/cli 0.14.2 → 0.14.3
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 +3356 -1534
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/skills/whop-audiences/SKILL.md +23 -2
- package/skills/whop-exports/SKILL.md +3 -1
- package/skills/whop-payments/SKILL.md +40 -0
- package/skills/whop-setup-intents/SKILL.md +20 -0
- package/skills/whop-users/SKILL.md +24 -0
package/package.json
CHANGED
|
@@ -9,6 +9,27 @@ An Audience represents a customer list uploaded to Whop for ad targeting. Audien
|
|
|
9
9
|
|
|
10
10
|
Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`.
|
|
11
11
|
|
|
12
|
+
# whop audiences add_people
|
|
13
|
+
|
|
14
|
+
Add People
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `audience_id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
21
|
+
|
|
22
|
+
## Options
|
|
23
|
+
|
|
24
|
+
| Flag | Type | Required | Default | Description |
|
|
25
|
+
|------|------|----------|---------|-------------|
|
|
26
|
+
| `--file_id` | `string` | yes | | The new customer CSV — a file id (`file_...`) returned by `POST /files`. Its headers must match the audience's saved column mapping. |
|
|
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
|
+
|
|
12
33
|
# whop audiences create
|
|
13
34
|
|
|
14
35
|
Create Audience
|
|
@@ -78,7 +99,7 @@ Update Audience
|
|
|
78
99
|
|
|
79
100
|
| Flag | Type | Required | Default | Description |
|
|
80
101
|
|------|------|----------|---------|-------------|
|
|
81
|
-
| `--filters` | `object` | no | |
|
|
82
|
-
| `--name` | `string` | no | | New audience display name. |
|
|
102
|
+
| `--filters` | `object` | no | | Replaces the People filters that define membership. The whole definition is replaced rather than merged, so send every filter you want to keep — a filter you leave out stops applying. Keys and values are the ones `GET /people` accepts, such as an `os` of `iOS` or a `country` of `US`, and at least one filter is required. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors every time it rebuilds; fixed dates such as `first_seen_after` are rejected, as is `audience_id`. An array value holds at most 500 items, and each value at most 10 KB. Only an audience with a `source_type` of `people_filter` and `auto_refresh` of `true` accepts filters: an uploaded list has no filters to replace, and with auto refresh off the audience keeps the people it matched when it was built, so create a new audience instead. |
|
|
103
|
+
| `--name` | `string` | no | | New audience display name. A blank value is ignored rather than clearing the name. |
|
|
83
104
|
|
|
84
105
|
> Confirm with the user before executing this destructive command.
|
|
@@ -297,11 +297,13 @@ Mirrors the filtering query params of `GET /api/v1/transfers`.
|
|
|
297
297
|
|
|
298
298
|
</details>
|
|
299
299
|
<details>
|
|
300
|
-
<summary>webhooks (
|
|
300
|
+
<summary>webhooks (3)</summary>
|
|
301
301
|
|
|
302
302
|
Mirrors the filtering query params of `GET /api/v1/webhooks`.
|
|
303
303
|
|
|
304
304
|
- `app_id` `string` — Only return webhooks attached to this app. Omit to list the account's own webhooks.
|
|
305
|
+
- `has_failures` `boolean` — Only return webhooks whose endpoint is currently failing — every delivery since the current failure streak began has been rejected. Clears as soon as a delivery succeeds.
|
|
306
|
+
- `include_app_webhooks` `boolean` — Also return webhooks attached to the account's apps, not just the account's own. Cannot be combined with `app_id`.
|
|
305
307
|
|
|
306
308
|
</details>
|
|
307
309
|
</details> |
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-payments
|
|
3
|
+
description: A charge against a buyer, and the step they still owe. Run `whop payments --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop payments
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Payment is one charge against a buyer. Create it with a payment method already on file, or with a `confirmation_token` describing a method the buyer has just supplied.
|
|
9
|
+
|
|
10
|
+
Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](https://docs.whop.com/api-reference/beta/payments/retrieve-status) for how far the payment has got and, while it is `requires_action`, what the buyer must do next — follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Use the return_url operation to change where they land afterwards, up until they come back.
|
|
11
|
+
|
|
12
|
+
# whop payments return_url
|
|
13
|
+
|
|
14
|
+
Update payment return URL
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `payment_id` | `string` | yes | The unique identifier of the payment. |
|
|
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 payments status
|
|
33
|
+
|
|
34
|
+
Retrieve payment status
|
|
35
|
+
|
|
36
|
+
## Arguments
|
|
37
|
+
|
|
38
|
+
| Name | Type | Required | Description |
|
|
39
|
+
|------|------|----------|-------------|
|
|
40
|
+
| `payment_id` | `string` | yes | The unique identifier of the payment. |
|
|
@@ -0,0 +1,20 @@
|
|
|
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 status
|
|
13
|
+
|
|
14
|
+
Retrieve setup status
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `setup_intent_id` | `string` | yes | The unique identifier of the setup intent. |
|
|
@@ -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
|