@wspc/cli 0.0.9 → 0.0.10
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/dist/cli.js +11 -7
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +17 -3
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/spec/openapi.json +69 -13
package/package.json
CHANGED
package/spec/openapi.json
CHANGED
|
@@ -323,10 +323,8 @@
|
|
|
323
323
|
"description": "Opaque pagination cursor. Pass the `next_cursor` returned by the previous page to fetch the next slice. Omit on the first call."
|
|
324
324
|
},
|
|
325
325
|
"limit": {
|
|
326
|
-
"type": "
|
|
327
|
-
"
|
|
328
|
-
"maximum": 100,
|
|
329
|
-
"description": "Maximum number of members to return in this page (1–100). Defaults to 50. Larger values trade fewer round-trips for more bytes per response."
|
|
326
|
+
"type": "string",
|
|
327
|
+
"description": "Maximum members to return. Clamped to [1, 100]. Defaults to 50."
|
|
330
328
|
}
|
|
331
329
|
}
|
|
332
330
|
},
|
|
@@ -1245,7 +1243,7 @@
|
|
|
1245
1243
|
"email": {
|
|
1246
1244
|
"type": "string",
|
|
1247
1245
|
"format": "email",
|
|
1248
|
-
"description": "Full alias address under
|
|
1246
|
+
"description": "Full alias address under the platform email domain or a fully verified organization custom domain, for example alice-shop@wspc.app or alice-shop@example.com."
|
|
1249
1247
|
}
|
|
1250
1248
|
},
|
|
1251
1249
|
"required": [
|
|
@@ -2688,6 +2686,12 @@
|
|
|
2688
2686
|
"items": {
|
|
2689
2687
|
"$ref": "#/components/schemas/Comment"
|
|
2690
2688
|
}
|
|
2689
|
+
},
|
|
2690
|
+
"children_next_cursor": {
|
|
2691
|
+
"type": "string"
|
|
2692
|
+
},
|
|
2693
|
+
"comments_next_cursor": {
|
|
2694
|
+
"type": "string"
|
|
2691
2695
|
}
|
|
2692
2696
|
},
|
|
2693
2697
|
"required": [
|
|
@@ -2742,6 +2746,10 @@
|
|
|
2742
2746
|
"items": {
|
|
2743
2747
|
"$ref": "#/components/schemas/Todo"
|
|
2744
2748
|
}
|
|
2749
|
+
},
|
|
2750
|
+
"next_cursor": {
|
|
2751
|
+
"type": "string",
|
|
2752
|
+
"description": "Opaque cursor for the next page. Absent on the last page."
|
|
2745
2753
|
}
|
|
2746
2754
|
},
|
|
2747
2755
|
"required": [
|
|
@@ -7153,13 +7161,11 @@
|
|
|
7153
7161
|
},
|
|
7154
7162
|
{
|
|
7155
7163
|
"schema": {
|
|
7156
|
-
"type": "
|
|
7157
|
-
"
|
|
7158
|
-
"maximum": 100,
|
|
7159
|
-
"description": "Maximum number of members to return in this page (1–100). Defaults to 50. Larger values trade fewer round-trips for more bytes per response."
|
|
7164
|
+
"type": "string",
|
|
7165
|
+
"description": "Maximum members to return. Clamped to [1, 100]. Defaults to 50."
|
|
7160
7166
|
},
|
|
7161
7167
|
"required": false,
|
|
7162
|
-
"description": "Maximum
|
|
7168
|
+
"description": "Maximum members to return. Clamped to [1, 100]. Defaults to 50.",
|
|
7163
7169
|
"name": "limit",
|
|
7164
7170
|
"in": "query"
|
|
7165
7171
|
}
|
|
@@ -14737,7 +14743,7 @@
|
|
|
14737
14743
|
"EmailAliases"
|
|
14738
14744
|
],
|
|
14739
14745
|
"summary": "Create a receiving alias",
|
|
14740
|
-
"description": "### Overview\nReserves and provisions a new passwordless/disposable receiving email alias address under the configured WSPC domain. All inbound emails received on this alias will be forwarded into the caller's inbox.\n\n### When to Use\n- Use this endpoint to spin up a fresh, dedicated email address (e.g., `alice-shop@wspc.app`) for specific websites, newsletters, or contexts to prevent spam or categorize incoming mail.\n\n### Constraints\n- Requires a valid Bearer token in the `Authorization` header.\n- **Alias Formatting**: The local part must be between 5 and 32 characters, start with an alphanumeric character, and only contain letters, numbers, dots, underscores, and hyphens.\n- **Limit Check**: Each user is allowed a maximum of 10 active email aliases. Soft-deleted aliases do not count against this quota limit.\n\n### Troubleshooting\n- **401 Unauthorized**: Bearer token is missing, invalid, or expired.\n- **400 Bad Request / INVALID_CHARSET / RESERVED**: The alias local part contains invalid characters, is too short/long, or matches a reserved keyword.\n- **409 Conflict / ALIAS_CONFLICT**: An alias with the exact requested email address already exists globally (whether active or soft-deleted by any user).\n- **429 Too Many Requests / ALIAS_LIMIT_EXCEEDED**: The user has reached the active alias cap limit of 10. A previously deleted alias must be cleaned up or wait for quota availability.",
|
|
14746
|
+
"description": "### Overview\nReserves and provisions a new passwordless/disposable receiving email alias address under the configured WSPC domain or a fully verified organization custom domain. All inbound emails received on this alias will be forwarded into the caller's inbox.\n\n### When to Use\n- Use this endpoint to spin up a fresh, dedicated email address (e.g., `alice-shop@wspc.app`) for specific websites, newsletters, or contexts to prevent spam or categorize incoming mail.\n\n### Constraints\n- Requires a valid Bearer token in the `Authorization` header.\n- **Alias Formatting**: The local part must be between 5 and 32 characters, start with an alphanumeric character, and only contain letters, numbers, dots, underscores, and hyphens.\n- **Custom Domains**: If the address uses a non-platform host, that domain must be registered to the caller's organization and have `status = verified`, `sending_status = verified`, and `receiving_status = verified`.\n- **Limit Check**: Each user is allowed a maximum of 10 active email aliases. Soft-deleted aliases do not count against this quota limit.\n\n### Troubleshooting\n- **401 Unauthorized**: Bearer token is missing, invalid, or expired.\n- **400 Bad Request / INVALID_CHARSET / RESERVED**: The alias local part contains invalid characters, is too short/long, or matches a reserved keyword.\n- **400 Bad Request / DOMAIN_NOT_FOUND**: The custom domain is not registered to the caller's organization.\n- **400 Bad Request / UNVERIFIED_DOMAIN**: The custom domain exists but is not verified yet.\n- **400 Bad Request / CUSTOM_DOMAIN_NOT_READY**: The custom domain exists but has not completed sending or receiving verification.\n- **409 Conflict / ALIAS_CONFLICT**: An alias with the exact requested email address already exists globally (whether active or soft-deleted by any user).\n- **429 Too Many Requests / ALIAS_LIMIT_EXCEEDED**: The user has reached the active alias cap limit of 10. A previously deleted alias must be cleaned up or wait for quota availability.",
|
|
14741
14747
|
"security": [
|
|
14742
14748
|
{
|
|
14743
14749
|
"bearerAuth": []
|
|
@@ -14789,6 +14795,12 @@
|
|
|
14789
14795
|
"value": {
|
|
14790
14796
|
"email": "alice-bills@wspc.app"
|
|
14791
14797
|
}
|
|
14798
|
+
},
|
|
14799
|
+
"customDomain": {
|
|
14800
|
+
"summary": "Fully verified custom domain alias",
|
|
14801
|
+
"value": {
|
|
14802
|
+
"email": "alice-shop@example.com"
|
|
14803
|
+
}
|
|
14792
14804
|
}
|
|
14793
14805
|
}
|
|
14794
14806
|
}
|
|
@@ -14817,7 +14829,7 @@
|
|
|
14817
14829
|
}
|
|
14818
14830
|
},
|
|
14819
14831
|
"400": {
|
|
14820
|
-
"description": "Invalid alias email address, local part,
|
|
14832
|
+
"description": "Invalid alias email address, local part, reserved local part, missing custom domain, unverified custom domain, or custom domain that is not ready for both sending and receiving.",
|
|
14821
14833
|
"content": {
|
|
14822
14834
|
"application/json": {
|
|
14823
14835
|
"schema": {
|
|
@@ -20079,7 +20091,7 @@
|
|
|
20079
20091
|
}
|
|
20080
20092
|
},
|
|
20081
20093
|
"summary": "List comments on a todo",
|
|
20082
|
-
"description": "### 🎯 Overview & Purpose\nList the comments attached to a todo, oldest-first by default.\n\n### 💡 Key Features & Constraints\n* **Ordering**: Defaults to chronological (`asc`). Pass `order=desc` for newest-first.\n* **Soft-deleted**: Hidden by default; pass `include_deleted=true` to include them.\n\n### ⚠️ Common Errors & Troubleshooting\n* **`NOT_FOUND` (HTTP 404)**: Thrown if the target todo does not exist or is soft-deleted.",
|
|
20094
|
+
"description": "### 🎯 Overview & Purpose\nList the comments attached to a todo, oldest-first by default.\n\n### 💡 Key Features & Constraints\n* **Ordering**: Defaults to chronological (`asc`). Pass `order=desc` for newest-first.\n* **Soft-deleted**: Hidden by default; pass `include_deleted=true` to include them.\n* **Pagination**: Use `limit` (max 200, default 50) and `cursor` (the `next_cursor` from a previous response) to page through results. When `next_cursor` is absent in the response, you are on the last page. Returns `{ comments, next_cursor? }`. Changing `order` invalidates a cursor.\n\n### ⚠️ Common Errors & Troubleshooting\n* **`NOT_FOUND` (HTTP 404)**: Thrown if the target todo does not exist or is soft-deleted.\n* **`VALIDATION_ERROR`**: Thrown if a cursor was produced with a different `order` than the current request.",
|
|
20083
20095
|
"security": [
|
|
20084
20096
|
{
|
|
20085
20097
|
"bearerAuth": []
|
|
@@ -20128,6 +20140,26 @@
|
|
|
20128
20140
|
"required": false,
|
|
20129
20141
|
"name": "include_deleted",
|
|
20130
20142
|
"in": "query"
|
|
20143
|
+
},
|
|
20144
|
+
{
|
|
20145
|
+
"schema": {
|
|
20146
|
+
"type": "string",
|
|
20147
|
+
"description": "Max comments to return. Clamped to [1, 200]. Default 50 server-side."
|
|
20148
|
+
},
|
|
20149
|
+
"required": false,
|
|
20150
|
+
"description": "Max comments to return. Clamped to [1, 200]. Default 50 server-side.",
|
|
20151
|
+
"name": "limit",
|
|
20152
|
+
"in": "query"
|
|
20153
|
+
},
|
|
20154
|
+
{
|
|
20155
|
+
"schema": {
|
|
20156
|
+
"type": "string",
|
|
20157
|
+
"description": "Opaque pagination cursor returned in `next_cursor` of a previous response."
|
|
20158
|
+
},
|
|
20159
|
+
"required": false,
|
|
20160
|
+
"description": "Opaque pagination cursor returned in `next_cursor` of a previous response.",
|
|
20161
|
+
"name": "cursor",
|
|
20162
|
+
"in": "query"
|
|
20131
20163
|
}
|
|
20132
20164
|
],
|
|
20133
20165
|
"responses": {
|
|
@@ -20143,6 +20175,10 @@
|
|
|
20143
20175
|
"items": {
|
|
20144
20176
|
"$ref": "#/components/schemas/Comment"
|
|
20145
20177
|
}
|
|
20178
|
+
},
|
|
20179
|
+
"next_cursor": {
|
|
20180
|
+
"type": "string",
|
|
20181
|
+
"description": "Opaque cursor for the next page. Absent on the last page."
|
|
20146
20182
|
}
|
|
20147
20183
|
},
|
|
20148
20184
|
"required": [
|
|
@@ -22843,6 +22879,26 @@
|
|
|
22843
22879
|
"required": false,
|
|
22844
22880
|
"name": "include_orphan_fields",
|
|
22845
22881
|
"in": "query"
|
|
22882
|
+
},
|
|
22883
|
+
{
|
|
22884
|
+
"schema": {
|
|
22885
|
+
"type": "string",
|
|
22886
|
+
"description": "Max todos to return. Clamped to [1, 200]. Default 50 server-side."
|
|
22887
|
+
},
|
|
22888
|
+
"required": false,
|
|
22889
|
+
"description": "Max todos to return. Clamped to [1, 200]. Default 50 server-side.",
|
|
22890
|
+
"name": "limit",
|
|
22891
|
+
"in": "query"
|
|
22892
|
+
},
|
|
22893
|
+
{
|
|
22894
|
+
"schema": {
|
|
22895
|
+
"type": "string",
|
|
22896
|
+
"description": "Opaque pagination cursor returned in `next_cursor` of a previous response."
|
|
22897
|
+
},
|
|
22898
|
+
"required": false,
|
|
22899
|
+
"description": "Opaque pagination cursor returned in `next_cursor` of a previous response.",
|
|
22900
|
+
"name": "cursor",
|
|
22901
|
+
"in": "query"
|
|
22846
22902
|
}
|
|
22847
22903
|
],
|
|
22848
22904
|
"responses": {
|