@myapihq/cli 2.16.3 → 2.16.4
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.
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: my-api-hq
|
|
3
|
-
version: 1.2.
|
|
3
|
+
version: 1.2.1
|
|
4
4
|
description: >
|
|
5
5
|
Auth, organizations, and billing hub. Start here to get an api_key and org_id — every other service depends on both.
|
|
6
6
|
triggers: [api key, account, organization, org, billing, balance, topup, credits, setup, defaults, brand, sync brand, doctor, health check, is my org healthy]
|
|
7
|
-
checksum: sha256-
|
|
7
|
+
checksum: sha256-b4eef3d505e92f2b9fe8dfa45b74d4221e3c646947ebfe8961aa5a2445bfa139
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# MyApiHQ
|
|
@@ -34,27 +34,29 @@ An anonymous account can upgrade at any time via `myapi account link <email>`
|
|
|
34
34
|
| Command | What it does |
|
|
35
35
|
|---|---|
|
|
36
36
|
| `myapi account setup` | Interactive setup: creates account, generates api_key, sets defaults |
|
|
37
|
-
| `myapi status` | Single-screen orientation: account + every resource in the default org. Start here when you don't know what
|
|
37
|
+
| `myapi status` | Single-screen orientation: account + every resource in the default org. Start here when you don't know what exists |
|
|
38
38
|
| `myapi account whoami` | Show current account, default org/funnel, balance, free-tier usage |
|
|
39
|
-
| `myapi account link [email]` | Upgrade anonymous account to registered (or add a
|
|
39
|
+
| `myapi account link [email]` | Upgrade anonymous account to registered (or add a session) |
|
|
40
40
|
| `myapi account switch [index]` | Switch active account |
|
|
41
|
+
| `myapi account import-key` | Import an API key non-interactively (CI, Docker) |
|
|
42
|
+
| `myapi account registrant <set\|get\|clear>` | WHOIS contact info `domain register` requires (ICANN) |
|
|
41
43
|
| `myapi org list` | List all orgs (`*` marks the default) |
|
|
42
44
|
| `myapi org create --name "..."` | Create a new org (`--yes` auto-sets as default) |
|
|
43
45
|
| `myapi org get [id]` | Inspect one org (defaults to current default) |
|
|
44
46
|
| `myapi org update [id]` | Update fields (name, tagline, description, business-sector, logo-url) |
|
|
45
|
-
| `myapi org delete <id>` | Delete an org and cascade (funnels included). Verify
|
|
46
|
-
| `myapi org sync-brand <domain>` | Scrape a live site
|
|
47
|
+
| `myapi org delete <id>` | Delete an org and cascade (funnels included). Verify with `myapi org get <id>` first; `--yes` required non-interactively |
|
|
48
|
+
| `myapi org sync-brand <domain>` | Scrape a live site to auto-fill brand info |
|
|
47
49
|
| `myapi keys list / create / revoke <id>` | Manage API keys (alias `myapi account api-keys`) |
|
|
48
50
|
| `myapi billing balance` | Check balance |
|
|
49
51
|
| `myapi billing topup <amount>` | Top up by dollar amount |
|
|
50
52
|
| `myapi billing history` | Recent transactions |
|
|
51
|
-
| `myapi billing usage [--period month|30d]` | Spend rolled up by service (
|
|
52
|
-
| `myapi billing spend-cap [<amount> | clear] [--period month|day]` | Set/show/clear the account-level spend ceiling
|
|
53
|
-
| `myapi billing auto-recharge [show \| set \| disable]` | Keep the wallet funded
|
|
53
|
+
| `myapi billing usage [--period month|30d]` | Spend rolled up by service (month or trailing 30d) |
|
|
54
|
+
| `myapi billing spend-cap [<amount> | clear] [--period month|day]` | Set/show/clear the account-level spend ceiling |
|
|
55
|
+
| `myapi billing auto-recharge [show \| set \| disable]` | Keep the wallet funded — off-session refill when balance drops below a threshold, capped monthly |
|
|
54
56
|
| `myapi account mailing-address ["<address>"]` | Get or set the account's CAN-SPAM mailing address (required for email send) |
|
|
55
57
|
| `myapi config set-org <id>` / `set-funnel <id>` / `set-domain <name>` | Set CLI defaults |
|
|
56
|
-
| `myapi install-skills` | Install agent
|
|
57
|
-
| `myapi doctor [--verbose] [--json]` | Org-wide health check:
|
|
58
|
+
| `myapi install-skills` | Install agent skills into ~/.claude/, ~/.gemini/, ~/.cursor/ |
|
|
59
|
+
| `myapi doctor [--verbose] [--json]` | Org-wide health check: config/integrity findings + DNS/HTTP probes |
|
|
58
60
|
<!-- generated:end -->
|
|
59
61
|
|
|
60
62
|
## Examples
|
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: my-crm-api
|
|
3
|
-
version: 1.0.
|
|
3
|
+
version: 1.0.1
|
|
4
4
|
description: >
|
|
5
5
|
The canonical store of engaged contacts + companies for an org. Auto-ingests from inbound webhooks via a configurable dot-path. Fixed lifecycle_stage enum (cold | warm | qualified | customer | churned). Append-only event timeline with reserved kinds. Soft delete + restore. Promote-from-Goldfox closes the discovery → engagement loop.
|
|
6
6
|
triggers: [crm, contact, company, lead, engagement, pipeline, lifecycle, qualified, customer, webhook ingest, promote]
|
|
7
|
-
checksum: sha256-
|
|
7
|
+
checksum: sha256-285ad94b1266588d103119ec139f11f0d19831bcbfd12779130f9fbeaf7f33f5
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# MyCRMAPI
|
|
11
11
|
|
|
12
|
-
The store that closes the funnel.
|
|
12
|
+
The store that closes the funnel. Without CRM the loop ends nowhere: discover people (Goldfox) → audience → email → pixel → form-fill via webhook → … nothing. People who *engage* live nowhere. CRM is where they land.
|
|
13
13
|
|
|
14
14
|
## Capabilities
|
|
15
15
|
<!-- llm:start -->
|
|
@@ -55,7 +55,7 @@ Agents cannot write events directly — the closed enum is intentional. For cust
|
|
|
55
55
|
### Auto-ingest
|
|
56
56
|
|
|
57
57
|
Today (v1):
|
|
58
|
-
- **Webhook**:
|
|
58
|
+
- **Webhook**: set per endpoint via `crm_email_path`, a JSON dot-path. Default `"email"` ingests `{"email":"x@y.com"}`. For Stripe, set `data.object.customer_email`; for GitHub, `sender.email`. Empty string disables ingest.
|
|
59
59
|
|
|
60
60
|
Coming next (backend wiring in progress):
|
|
61
61
|
- **Email**: every `myapi email message send` writes `email_sent`; opens/clicks fire `email_opened`/`email_clicked`
|
|
@@ -63,19 +63,19 @@ Coming next (backend wiring in progress):
|
|
|
63
63
|
|
|
64
64
|
If a contact doesn't exist for the matched email, it's auto-created with `source=` matching the originating service. The contact's company is auto-linked by email domain (creates the company on first sight).
|
|
65
65
|
|
|
66
|
-
**Missing lead? Check `myapi webhook deliveries` before concluding it never arrived.** A deadlock under concurrent ingest could drop the contact *after* the form returned success
|
|
66
|
+
**Missing lead? Check `myapi webhook deliveries` before concluding it never arrived.** A deadlock under concurrent ingest could drop the contact *after* the form returned success (fixed 2026-07-27). Raw payloads are always stored, so the delivery is there even when the contact isn't.
|
|
67
67
|
|
|
68
68
|
### Soft delete + restore
|
|
69
69
|
|
|
70
|
-
`myapi crm contacts delete <id>` sets `deleted_at` but **
|
|
70
|
+
`myapi crm contacts delete <id>` sets `deleted_at` but **keeps the event timeline**. By default soft-deleted contacts are excluded from search — pass `--include-deleted` to see them. Restore with `myapi crm contacts restore <id>`.
|
|
71
71
|
|
|
72
72
|
### Goldfox enrichment (deferred)
|
|
73
73
|
|
|
74
|
-
A contact promoted from Goldfox carries a `goldfox_person_id`. In v2 the GET response will
|
|
74
|
+
A contact promoted from Goldfox carries a `goldfox_person_id`. In v2 the GET response will embed the row as `goldfox_person`; today it is null. Goldfox-only fields are not yet searchable.
|
|
75
75
|
|
|
76
76
|
### Search filter — re-engagement semantics
|
|
77
77
|
|
|
78
|
-
`--max-last-engagement-days N` returns contacts last engaged *more than* N days ago, and intentionally **includes contacts with no engagement at all** (promoted-but-never-emailed Goldfox leads) — the natural targets of a re-engagement campaign. To separate "never tried" from "tried and went cold," layer `--origin goldfox
|
|
78
|
+
`--max-last-engagement-days N` returns contacts last engaged *more than* N days ago, and intentionally **includes contacts with no engagement at all** (promoted-but-never-emailed Goldfox leads) — the natural targets of a re-engagement campaign. `--min-last-engagement-days N` is its complement: engaged *within* N days. `--company-id <id>` narrows to one company. To separate "never tried" from "tried and went cold," layer `--origin goldfox`.
|
|
79
79
|
|
|
80
80
|
### Failure modes
|
|
81
81
|
|
|
@@ -98,13 +98,13 @@ A contact promoted from Goldfox carries a `goldfox_person_id`. In v2 the GET res
|
|
|
98
98
|
| `myapi crm contacts update <id> [--stage ...] [...]` | Patch fields. Stage change emits `stage_changed` event |
|
|
99
99
|
| `myapi crm contacts delete <id>` | Soft delete (events retained) |
|
|
100
100
|
| `myapi crm contacts restore <id>` | Restore a soft-deleted contact |
|
|
101
|
-
| `myapi crm contacts promote <goldfox_person_id>` | Idempotent Goldfox → CRM
|
|
101
|
+
| `myapi crm contacts promote <goldfox_person_id>` | Idempotent Goldfox → CRM promote |
|
|
102
102
|
| `myapi crm contacts events <id> [--kind ...]` | Timeline (newest first), filter by kind |
|
|
103
103
|
|
|
104
104
|
### Companies
|
|
105
105
|
| Command | What it does |
|
|
106
106
|
|---|---|
|
|
107
|
-
| `myapi crm companies list / search / create / get / update / delete / restore` | Same shape as contacts |
|
|
107
|
+
| `myapi crm companies list / search / create / get / update / delete / restore` | Same shape as contacts. `--domain` filters search, `--name` sets display name |
|
|
108
108
|
| `myapi crm companies promote <domain>` | Goldfox company id IS its domain — pass the domain |
|
|
109
109
|
|
|
110
110
|
<!-- generated:end -->
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: my-email-api
|
|
3
|
-
version: 1.0.
|
|
3
|
+
version: 1.0.1
|
|
4
4
|
description: >
|
|
5
5
|
Send transactional and bulk email from your own domain. Create mailboxes, send/receive messages, generate AI templates, and manage warmup.
|
|
6
6
|
triggers: [email, mailbox, send email, transactional email, template, warmup, inbox, outbox, ses, sender reputation]
|
|
7
|
-
checksum: sha256-
|
|
7
|
+
checksum: sha256-18f539fc12dd9e9e8f2abecf518aa1ee70741f85cc26ba0a6a941b9c29d537d8
|
|
8
8
|
---
|
|
9
9
|
|
|
10
10
|
# MyEmailAPI
|
|
@@ -24,7 +24,7 @@ A registered domain via **mydomainapi** is the prerequisite — mailboxes need a
|
|
|
24
24
|
<!-- generated:start -->
|
|
25
25
|
| Namespace | Subcommands | Purpose |
|
|
26
26
|
|---|---|---|
|
|
27
|
-
| `email mailbox` | `create`, `list`, `activate-sending` | Create and manage mailboxes |
|
|
27
|
+
| `email mailbox` | `create`, `list`, `delete`, `activate-sending`, `set-forwarding`, `clear-forwarding` | Create and manage mailboxes |
|
|
28
28
|
| `email message` | `send`, `status`, `sent`, `inbox`, `outbox`, `get` | Transactional send + read |
|
|
29
29
|
| `email warmup` | `start`, `stats`, `pause`, `resume`, `stop` | IP/domain warmup for sending reputation |
|
|
30
30
|
| `email template` | `generate`, `list`, `get`, `preview`, `edit`, `send-test`, `delete` | AI-generated HTML templates |
|
|
@@ -60,6 +60,22 @@ myapi email warmup stats --address hello@yourdomain.com
|
|
|
60
60
|
```
|
|
61
61
|
<!-- llm:end -->
|
|
62
62
|
|
|
63
|
+
## Flags worth knowing
|
|
64
|
+
|
|
65
|
+
| Flag | Where | What it does |
|
|
66
|
+
|---|---|---|
|
|
67
|
+
| `--username` + `--domain` | `mailbox create` | Alternative to the positional `<user@domain>` |
|
|
68
|
+
| `--filter unassigned` | `mailbox list` | Orphaned mailboxes — those whose domain is gone |
|
|
69
|
+
| `--html` | `message send` | Send an HTML body instead of `--body` plain text |
|
|
70
|
+
| `--template-id` + `--template-vars` | `message send` | Send a stored template with a JSON var map, instead of a body |
|
|
71
|
+
| `--name` | `template generate` | Alternative to the positional `<name>` |
|
|
72
|
+
| `--per-day` | `warmup start` | Cap the daily volume the ramp climbs to |
|
|
73
|
+
| `--emails`, `--quick` | `verify bulk` | Addresses inline rather than on stdin; skip the catch-all probe |
|
|
74
|
+
|
|
75
|
+
Forwarding keeps the original: `set-forwarding <user@domain> <forward-to@domain>`
|
|
76
|
+
copies every inbound message to an external address and leaves it in the mailbox.
|
|
77
|
+
`clear-forwarding <user@domain>` stops it.
|
|
78
|
+
|
|
63
79
|
## Notes
|
|
64
80
|
|
|
65
81
|
- A mailbox is uniquely identified by its address (`username@domain`).
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@myapihq/cli",
|
|
3
3
|
"license": "Apache-2.0",
|
|
4
|
-
"version": "2.16.
|
|
4
|
+
"version": "2.16.4",
|
|
5
5
|
"description": "MyAPI command-line interface",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"lint:skills:strict": "node scripts/copy-skills.js && node scripts/lint-skills.js --strict"
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@myapihq/sdk": "^2.16.
|
|
49
|
+
"@myapihq/sdk": "^2.16.4"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@types/node": "^25.6.0",
|