@primitivedotdev/sdk 0.2.4 → 0.3.0
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 +65 -2
- package/bin/run.js +5 -0
- package/dist/api/generated/client/client.gen.js +235 -0
- package/dist/api/generated/client/index.js +6 -0
- package/dist/api/generated/client/types.gen.js +2 -0
- package/dist/api/generated/client/utils.gen.js +228 -0
- package/dist/api/generated/client.gen.js +3 -0
- package/dist/api/generated/core/auth.gen.js +14 -0
- package/dist/api/generated/core/bodySerializer.gen.js +57 -0
- package/dist/api/generated/core/params.gen.js +100 -0
- package/dist/api/generated/core/pathSerializer.gen.js +106 -0
- package/dist/api/generated/core/queryKeySerializer.gen.js +92 -0
- package/dist/api/generated/core/serverSentEvents.gen.js +132 -0
- package/dist/api/generated/core/types.gen.js +2 -0
- package/dist/api/generated/core/utils.gen.js +87 -0
- package/dist/api/generated/index.js +2 -0
- package/dist/api/generated/sdk.gen.js +344 -0
- package/dist/api/generated/types.gen.js +2 -0
- package/dist/api/index.d.ts +1832 -0
- package/dist/api/index.js +39 -0
- package/dist/chunk-Cl8Af3a2.js +11 -0
- package/dist/contract/index.d.ts +3 -3
- package/dist/contract/index.js +2 -2
- package/dist/{index-BdRIHaXz.d.ts → index-D2OuDGVz.d.ts} +81 -5
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/oclif/api-command.js +154 -0
- package/dist/oclif/fish-completion.js +87 -0
- package/dist/oclif/index.js +42 -0
- package/dist/openapi/index.d.ts +41 -0
- package/dist/openapi/index.js +8 -0
- package/dist/openapi/openapi.generated.js +2644 -0
- package/dist/openapi/operations.generated.js +632 -0
- package/dist/parser/index.d.ts +1 -1
- package/dist/parser/index.js +40 -25
- package/dist/{types-B5IgP-Zx.d.ts → types-C3ms4R0d.d.ts} +4 -0
- package/dist/webhook/index.d.ts +3 -3
- package/dist/webhook/index.js +2 -2
- package/dist/{webhook-Be2vM0F-.js → webhook-uSco6pyX.js} +176 -11
- package/oclif.manifest.json +1255 -0
- package/package.json +81 -13
|
@@ -0,0 +1,1255 @@
|
|
|
1
|
+
{
|
|
2
|
+
"commands": {
|
|
3
|
+
"completion": {
|
|
4
|
+
"aliases": [],
|
|
5
|
+
"args": {
|
|
6
|
+
"shell": {
|
|
7
|
+
"description": "Shell type",
|
|
8
|
+
"name": "shell",
|
|
9
|
+
"options": [
|
|
10
|
+
"bash",
|
|
11
|
+
"zsh",
|
|
12
|
+
"powershell",
|
|
13
|
+
"fish"
|
|
14
|
+
],
|
|
15
|
+
"required": true
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"description": "Show shell completion output or installation instructions for supported shells",
|
|
19
|
+
"flags": {},
|
|
20
|
+
"hasDynamicHelp": false,
|
|
21
|
+
"hiddenAliases": [],
|
|
22
|
+
"id": "completion",
|
|
23
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
24
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
25
|
+
"pluginType": "core",
|
|
26
|
+
"strict": true,
|
|
27
|
+
"summary": "Show shell completion output or installation instructions",
|
|
28
|
+
"enableJsonFlag": false
|
|
29
|
+
},
|
|
30
|
+
"list-operations": {
|
|
31
|
+
"aliases": [],
|
|
32
|
+
"args": {},
|
|
33
|
+
"description": "List all generated API operations",
|
|
34
|
+
"flags": {},
|
|
35
|
+
"hasDynamicHelp": false,
|
|
36
|
+
"hiddenAliases": [],
|
|
37
|
+
"id": "list-operations",
|
|
38
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
39
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
40
|
+
"pluginType": "core",
|
|
41
|
+
"strict": true,
|
|
42
|
+
"summary": "List all generated API operations",
|
|
43
|
+
"enableJsonFlag": false
|
|
44
|
+
},
|
|
45
|
+
"account:get-account": {
|
|
46
|
+
"aliases": [],
|
|
47
|
+
"args": {},
|
|
48
|
+
"description": "GET /account",
|
|
49
|
+
"flags": {
|
|
50
|
+
"api-key": {
|
|
51
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
52
|
+
"env": "PRIMITIVE_API_KEY",
|
|
53
|
+
"name": "api-key",
|
|
54
|
+
"hasDynamicHelp": false,
|
|
55
|
+
"multiple": false,
|
|
56
|
+
"type": "option"
|
|
57
|
+
},
|
|
58
|
+
"base-url": {
|
|
59
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
60
|
+
"env": "PRIMITIVE_API_URL",
|
|
61
|
+
"name": "base-url",
|
|
62
|
+
"hasDynamicHelp": false,
|
|
63
|
+
"multiple": false,
|
|
64
|
+
"type": "option"
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"hasDynamicHelp": false,
|
|
68
|
+
"hiddenAliases": [],
|
|
69
|
+
"id": "account:get-account",
|
|
70
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
71
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
72
|
+
"pluginType": "core",
|
|
73
|
+
"strict": true,
|
|
74
|
+
"summary": "Get account info",
|
|
75
|
+
"enableJsonFlag": false
|
|
76
|
+
},
|
|
77
|
+
"account:get-storage-stats": {
|
|
78
|
+
"aliases": [],
|
|
79
|
+
"args": {},
|
|
80
|
+
"description": "GET /account/storage",
|
|
81
|
+
"flags": {
|
|
82
|
+
"api-key": {
|
|
83
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
84
|
+
"env": "PRIMITIVE_API_KEY",
|
|
85
|
+
"name": "api-key",
|
|
86
|
+
"hasDynamicHelp": false,
|
|
87
|
+
"multiple": false,
|
|
88
|
+
"type": "option"
|
|
89
|
+
},
|
|
90
|
+
"base-url": {
|
|
91
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
92
|
+
"env": "PRIMITIVE_API_URL",
|
|
93
|
+
"name": "base-url",
|
|
94
|
+
"hasDynamicHelp": false,
|
|
95
|
+
"multiple": false,
|
|
96
|
+
"type": "option"
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"hasDynamicHelp": false,
|
|
100
|
+
"hiddenAliases": [],
|
|
101
|
+
"id": "account:get-storage-stats",
|
|
102
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
103
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
104
|
+
"pluginType": "core",
|
|
105
|
+
"strict": true,
|
|
106
|
+
"summary": "Get storage usage",
|
|
107
|
+
"enableJsonFlag": false
|
|
108
|
+
},
|
|
109
|
+
"account:get-webhook-secret": {
|
|
110
|
+
"aliases": [],
|
|
111
|
+
"args": {},
|
|
112
|
+
"description": "Returns the webhook signing secret for your account. If no secret\nexists yet, one is generated automatically on first access.\n",
|
|
113
|
+
"flags": {
|
|
114
|
+
"api-key": {
|
|
115
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
116
|
+
"env": "PRIMITIVE_API_KEY",
|
|
117
|
+
"name": "api-key",
|
|
118
|
+
"hasDynamicHelp": false,
|
|
119
|
+
"multiple": false,
|
|
120
|
+
"type": "option"
|
|
121
|
+
},
|
|
122
|
+
"base-url": {
|
|
123
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
124
|
+
"env": "PRIMITIVE_API_URL",
|
|
125
|
+
"name": "base-url",
|
|
126
|
+
"hasDynamicHelp": false,
|
|
127
|
+
"multiple": false,
|
|
128
|
+
"type": "option"
|
|
129
|
+
}
|
|
130
|
+
},
|
|
131
|
+
"hasDynamicHelp": false,
|
|
132
|
+
"hiddenAliases": [],
|
|
133
|
+
"id": "account:get-webhook-secret",
|
|
134
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
135
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
136
|
+
"pluginType": "core",
|
|
137
|
+
"strict": true,
|
|
138
|
+
"summary": "Get webhook signing secret",
|
|
139
|
+
"enableJsonFlag": false
|
|
140
|
+
},
|
|
141
|
+
"account:rotate-webhook-secret": {
|
|
142
|
+
"aliases": [],
|
|
143
|
+
"args": {},
|
|
144
|
+
"description": "Generates a new webhook signing secret, replacing the current one.\nRate limited to once per 60 minutes.\n",
|
|
145
|
+
"flags": {
|
|
146
|
+
"api-key": {
|
|
147
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
148
|
+
"env": "PRIMITIVE_API_KEY",
|
|
149
|
+
"name": "api-key",
|
|
150
|
+
"hasDynamicHelp": false,
|
|
151
|
+
"multiple": false,
|
|
152
|
+
"type": "option"
|
|
153
|
+
},
|
|
154
|
+
"base-url": {
|
|
155
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
156
|
+
"env": "PRIMITIVE_API_URL",
|
|
157
|
+
"name": "base-url",
|
|
158
|
+
"hasDynamicHelp": false,
|
|
159
|
+
"multiple": false,
|
|
160
|
+
"type": "option"
|
|
161
|
+
}
|
|
162
|
+
},
|
|
163
|
+
"hasDynamicHelp": false,
|
|
164
|
+
"hiddenAliases": [],
|
|
165
|
+
"id": "account:rotate-webhook-secret",
|
|
166
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
167
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
168
|
+
"pluginType": "core",
|
|
169
|
+
"strict": true,
|
|
170
|
+
"summary": "Rotate webhook signing secret",
|
|
171
|
+
"enableJsonFlag": false
|
|
172
|
+
},
|
|
173
|
+
"account:update-account": {
|
|
174
|
+
"aliases": [],
|
|
175
|
+
"args": {},
|
|
176
|
+
"description": "PATCH /account",
|
|
177
|
+
"flags": {
|
|
178
|
+
"api-key": {
|
|
179
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
180
|
+
"env": "PRIMITIVE_API_KEY",
|
|
181
|
+
"name": "api-key",
|
|
182
|
+
"hasDynamicHelp": false,
|
|
183
|
+
"multiple": false,
|
|
184
|
+
"type": "option"
|
|
185
|
+
},
|
|
186
|
+
"base-url": {
|
|
187
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
188
|
+
"env": "PRIMITIVE_API_URL",
|
|
189
|
+
"name": "base-url",
|
|
190
|
+
"hasDynamicHelp": false,
|
|
191
|
+
"multiple": false,
|
|
192
|
+
"type": "option"
|
|
193
|
+
},
|
|
194
|
+
"body": {
|
|
195
|
+
"description": "JSON request body",
|
|
196
|
+
"name": "body",
|
|
197
|
+
"hasDynamicHelp": false,
|
|
198
|
+
"multiple": false,
|
|
199
|
+
"type": "option"
|
|
200
|
+
},
|
|
201
|
+
"body-file": {
|
|
202
|
+
"description": "Path to a JSON file used as the request body",
|
|
203
|
+
"name": "body-file",
|
|
204
|
+
"hasDynamicHelp": false,
|
|
205
|
+
"multiple": false,
|
|
206
|
+
"type": "option"
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
"hasDynamicHelp": false,
|
|
210
|
+
"hiddenAliases": [],
|
|
211
|
+
"id": "account:update-account",
|
|
212
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
213
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
214
|
+
"pluginType": "core",
|
|
215
|
+
"strict": true,
|
|
216
|
+
"summary": "Update account settings",
|
|
217
|
+
"enableJsonFlag": false
|
|
218
|
+
},
|
|
219
|
+
"domains:add-domain": {
|
|
220
|
+
"aliases": [],
|
|
221
|
+
"args": {},
|
|
222
|
+
"description": "Creates an unverified domain claim. You will receive a\n`verification_token` to add as a DNS TXT record before\ncalling the verify endpoint.\n",
|
|
223
|
+
"flags": {
|
|
224
|
+
"api-key": {
|
|
225
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
226
|
+
"env": "PRIMITIVE_API_KEY",
|
|
227
|
+
"name": "api-key",
|
|
228
|
+
"hasDynamicHelp": false,
|
|
229
|
+
"multiple": false,
|
|
230
|
+
"type": "option"
|
|
231
|
+
},
|
|
232
|
+
"base-url": {
|
|
233
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
234
|
+
"env": "PRIMITIVE_API_URL",
|
|
235
|
+
"name": "base-url",
|
|
236
|
+
"hasDynamicHelp": false,
|
|
237
|
+
"multiple": false,
|
|
238
|
+
"type": "option"
|
|
239
|
+
},
|
|
240
|
+
"body": {
|
|
241
|
+
"description": "JSON request body",
|
|
242
|
+
"name": "body",
|
|
243
|
+
"hasDynamicHelp": false,
|
|
244
|
+
"multiple": false,
|
|
245
|
+
"type": "option"
|
|
246
|
+
},
|
|
247
|
+
"body-file": {
|
|
248
|
+
"description": "Path to a JSON file used as the request body",
|
|
249
|
+
"name": "body-file",
|
|
250
|
+
"hasDynamicHelp": false,
|
|
251
|
+
"multiple": false,
|
|
252
|
+
"type": "option"
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
"hasDynamicHelp": false,
|
|
256
|
+
"hiddenAliases": [],
|
|
257
|
+
"id": "domains:add-domain",
|
|
258
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
259
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
260
|
+
"pluginType": "core",
|
|
261
|
+
"strict": true,
|
|
262
|
+
"summary": "Claim a new domain",
|
|
263
|
+
"enableJsonFlag": false
|
|
264
|
+
},
|
|
265
|
+
"domains:delete-domain": {
|
|
266
|
+
"aliases": [],
|
|
267
|
+
"args": {},
|
|
268
|
+
"description": "Deletes a verified or unverified domain claim.",
|
|
269
|
+
"flags": {
|
|
270
|
+
"api-key": {
|
|
271
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
272
|
+
"env": "PRIMITIVE_API_KEY",
|
|
273
|
+
"name": "api-key",
|
|
274
|
+
"hasDynamicHelp": false,
|
|
275
|
+
"multiple": false,
|
|
276
|
+
"type": "option"
|
|
277
|
+
},
|
|
278
|
+
"base-url": {
|
|
279
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
280
|
+
"env": "PRIMITIVE_API_URL",
|
|
281
|
+
"name": "base-url",
|
|
282
|
+
"hasDynamicHelp": false,
|
|
283
|
+
"multiple": false,
|
|
284
|
+
"type": "option"
|
|
285
|
+
},
|
|
286
|
+
"id": {
|
|
287
|
+
"description": "Resource UUID",
|
|
288
|
+
"name": "id",
|
|
289
|
+
"required": true,
|
|
290
|
+
"hasDynamicHelp": false,
|
|
291
|
+
"multiple": false,
|
|
292
|
+
"type": "option"
|
|
293
|
+
}
|
|
294
|
+
},
|
|
295
|
+
"hasDynamicHelp": false,
|
|
296
|
+
"hiddenAliases": [],
|
|
297
|
+
"id": "domains:delete-domain",
|
|
298
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
299
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
300
|
+
"pluginType": "core",
|
|
301
|
+
"strict": true,
|
|
302
|
+
"summary": "Delete a domain",
|
|
303
|
+
"enableJsonFlag": false
|
|
304
|
+
},
|
|
305
|
+
"domains:list-domains": {
|
|
306
|
+
"aliases": [],
|
|
307
|
+
"args": {},
|
|
308
|
+
"description": "Returns all verified and unverified domains for your organization,\nsorted by creation date (newest first). Each domain includes a\n`verified` boolean to distinguish between the two states.\n",
|
|
309
|
+
"flags": {
|
|
310
|
+
"api-key": {
|
|
311
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
312
|
+
"env": "PRIMITIVE_API_KEY",
|
|
313
|
+
"name": "api-key",
|
|
314
|
+
"hasDynamicHelp": false,
|
|
315
|
+
"multiple": false,
|
|
316
|
+
"type": "option"
|
|
317
|
+
},
|
|
318
|
+
"base-url": {
|
|
319
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
320
|
+
"env": "PRIMITIVE_API_URL",
|
|
321
|
+
"name": "base-url",
|
|
322
|
+
"hasDynamicHelp": false,
|
|
323
|
+
"multiple": false,
|
|
324
|
+
"type": "option"
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
"hasDynamicHelp": false,
|
|
328
|
+
"hiddenAliases": [],
|
|
329
|
+
"id": "domains:list-domains",
|
|
330
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
331
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
332
|
+
"pluginType": "core",
|
|
333
|
+
"strict": true,
|
|
334
|
+
"summary": "List all domains",
|
|
335
|
+
"enableJsonFlag": false
|
|
336
|
+
},
|
|
337
|
+
"domains:update-domain": {
|
|
338
|
+
"aliases": [],
|
|
339
|
+
"args": {},
|
|
340
|
+
"description": "Update a verified domain's settings. Only verified domains can be\nupdated. Per-domain spam thresholds require a Pro plan.\n",
|
|
341
|
+
"flags": {
|
|
342
|
+
"api-key": {
|
|
343
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
344
|
+
"env": "PRIMITIVE_API_KEY",
|
|
345
|
+
"name": "api-key",
|
|
346
|
+
"hasDynamicHelp": false,
|
|
347
|
+
"multiple": false,
|
|
348
|
+
"type": "option"
|
|
349
|
+
},
|
|
350
|
+
"base-url": {
|
|
351
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
352
|
+
"env": "PRIMITIVE_API_URL",
|
|
353
|
+
"name": "base-url",
|
|
354
|
+
"hasDynamicHelp": false,
|
|
355
|
+
"multiple": false,
|
|
356
|
+
"type": "option"
|
|
357
|
+
},
|
|
358
|
+
"id": {
|
|
359
|
+
"description": "Resource UUID",
|
|
360
|
+
"name": "id",
|
|
361
|
+
"required": true,
|
|
362
|
+
"hasDynamicHelp": false,
|
|
363
|
+
"multiple": false,
|
|
364
|
+
"type": "option"
|
|
365
|
+
},
|
|
366
|
+
"body": {
|
|
367
|
+
"description": "JSON request body",
|
|
368
|
+
"name": "body",
|
|
369
|
+
"hasDynamicHelp": false,
|
|
370
|
+
"multiple": false,
|
|
371
|
+
"type": "option"
|
|
372
|
+
},
|
|
373
|
+
"body-file": {
|
|
374
|
+
"description": "Path to a JSON file used as the request body",
|
|
375
|
+
"name": "body-file",
|
|
376
|
+
"hasDynamicHelp": false,
|
|
377
|
+
"multiple": false,
|
|
378
|
+
"type": "option"
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"hasDynamicHelp": false,
|
|
382
|
+
"hiddenAliases": [],
|
|
383
|
+
"id": "domains:update-domain",
|
|
384
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
385
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
386
|
+
"pluginType": "core",
|
|
387
|
+
"strict": true,
|
|
388
|
+
"summary": "Update domain settings",
|
|
389
|
+
"enableJsonFlag": false
|
|
390
|
+
},
|
|
391
|
+
"domains:verify-domain": {
|
|
392
|
+
"aliases": [],
|
|
393
|
+
"args": {},
|
|
394
|
+
"description": "Checks DNS records (MX and TXT) to verify domain ownership.\nOn success, the domain is promoted from unverified to verified.\nOn failure, returns which checks passed and which failed.\n",
|
|
395
|
+
"flags": {
|
|
396
|
+
"api-key": {
|
|
397
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
398
|
+
"env": "PRIMITIVE_API_KEY",
|
|
399
|
+
"name": "api-key",
|
|
400
|
+
"hasDynamicHelp": false,
|
|
401
|
+
"multiple": false,
|
|
402
|
+
"type": "option"
|
|
403
|
+
},
|
|
404
|
+
"base-url": {
|
|
405
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
406
|
+
"env": "PRIMITIVE_API_URL",
|
|
407
|
+
"name": "base-url",
|
|
408
|
+
"hasDynamicHelp": false,
|
|
409
|
+
"multiple": false,
|
|
410
|
+
"type": "option"
|
|
411
|
+
},
|
|
412
|
+
"id": {
|
|
413
|
+
"description": "Resource UUID",
|
|
414
|
+
"name": "id",
|
|
415
|
+
"required": true,
|
|
416
|
+
"hasDynamicHelp": false,
|
|
417
|
+
"multiple": false,
|
|
418
|
+
"type": "option"
|
|
419
|
+
}
|
|
420
|
+
},
|
|
421
|
+
"hasDynamicHelp": false,
|
|
422
|
+
"hiddenAliases": [],
|
|
423
|
+
"id": "domains:verify-domain",
|
|
424
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
425
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
426
|
+
"pluginType": "core",
|
|
427
|
+
"strict": true,
|
|
428
|
+
"summary": "Verify domain ownership",
|
|
429
|
+
"enableJsonFlag": false
|
|
430
|
+
},
|
|
431
|
+
"emails:delete-email": {
|
|
432
|
+
"aliases": [],
|
|
433
|
+
"args": {},
|
|
434
|
+
"description": "DELETE /emails/{id}",
|
|
435
|
+
"flags": {
|
|
436
|
+
"api-key": {
|
|
437
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
438
|
+
"env": "PRIMITIVE_API_KEY",
|
|
439
|
+
"name": "api-key",
|
|
440
|
+
"hasDynamicHelp": false,
|
|
441
|
+
"multiple": false,
|
|
442
|
+
"type": "option"
|
|
443
|
+
},
|
|
444
|
+
"base-url": {
|
|
445
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
446
|
+
"env": "PRIMITIVE_API_URL",
|
|
447
|
+
"name": "base-url",
|
|
448
|
+
"hasDynamicHelp": false,
|
|
449
|
+
"multiple": false,
|
|
450
|
+
"type": "option"
|
|
451
|
+
},
|
|
452
|
+
"id": {
|
|
453
|
+
"description": "Resource UUID",
|
|
454
|
+
"name": "id",
|
|
455
|
+
"required": true,
|
|
456
|
+
"hasDynamicHelp": false,
|
|
457
|
+
"multiple": false,
|
|
458
|
+
"type": "option"
|
|
459
|
+
}
|
|
460
|
+
},
|
|
461
|
+
"hasDynamicHelp": false,
|
|
462
|
+
"hiddenAliases": [],
|
|
463
|
+
"id": "emails:delete-email",
|
|
464
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
465
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
466
|
+
"pluginType": "core",
|
|
467
|
+
"strict": true,
|
|
468
|
+
"summary": "Delete an email",
|
|
469
|
+
"enableJsonFlag": false
|
|
470
|
+
},
|
|
471
|
+
"emails:download-attachments": {
|
|
472
|
+
"aliases": [],
|
|
473
|
+
"args": {},
|
|
474
|
+
"description": "Downloads all attachments as a gzip-compressed tar archive.\nAuthenticates via a signed download token (provided in webhook\npayloads) or a valid session.\n",
|
|
475
|
+
"flags": {
|
|
476
|
+
"api-key": {
|
|
477
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
478
|
+
"env": "PRIMITIVE_API_KEY",
|
|
479
|
+
"name": "api-key",
|
|
480
|
+
"hasDynamicHelp": false,
|
|
481
|
+
"multiple": false,
|
|
482
|
+
"type": "option"
|
|
483
|
+
},
|
|
484
|
+
"base-url": {
|
|
485
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
486
|
+
"env": "PRIMITIVE_API_URL",
|
|
487
|
+
"name": "base-url",
|
|
488
|
+
"hasDynamicHelp": false,
|
|
489
|
+
"multiple": false,
|
|
490
|
+
"type": "option"
|
|
491
|
+
},
|
|
492
|
+
"id": {
|
|
493
|
+
"description": "Resource UUID",
|
|
494
|
+
"name": "id",
|
|
495
|
+
"required": true,
|
|
496
|
+
"hasDynamicHelp": false,
|
|
497
|
+
"multiple": false,
|
|
498
|
+
"type": "option"
|
|
499
|
+
},
|
|
500
|
+
"token": {
|
|
501
|
+
"description": "Signed download token from webhook payload",
|
|
502
|
+
"name": "token",
|
|
503
|
+
"required": false,
|
|
504
|
+
"hasDynamicHelp": false,
|
|
505
|
+
"multiple": false,
|
|
506
|
+
"type": "option"
|
|
507
|
+
},
|
|
508
|
+
"output": {
|
|
509
|
+
"description": "Write binary response bytes to a file",
|
|
510
|
+
"name": "output",
|
|
511
|
+
"hasDynamicHelp": false,
|
|
512
|
+
"multiple": false,
|
|
513
|
+
"type": "option"
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
"hasDynamicHelp": false,
|
|
517
|
+
"hiddenAliases": [],
|
|
518
|
+
"id": "emails:download-attachments",
|
|
519
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
520
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
521
|
+
"pluginType": "core",
|
|
522
|
+
"strict": true,
|
|
523
|
+
"summary": "Download email attachments",
|
|
524
|
+
"enableJsonFlag": false
|
|
525
|
+
},
|
|
526
|
+
"emails:download-raw-email": {
|
|
527
|
+
"aliases": [],
|
|
528
|
+
"args": {},
|
|
529
|
+
"description": "Downloads the raw RFC 822 email file (.eml). Authenticates via\na signed download token (provided in webhook payloads) or a\nvalid session.\n",
|
|
530
|
+
"flags": {
|
|
531
|
+
"api-key": {
|
|
532
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
533
|
+
"env": "PRIMITIVE_API_KEY",
|
|
534
|
+
"name": "api-key",
|
|
535
|
+
"hasDynamicHelp": false,
|
|
536
|
+
"multiple": false,
|
|
537
|
+
"type": "option"
|
|
538
|
+
},
|
|
539
|
+
"base-url": {
|
|
540
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
541
|
+
"env": "PRIMITIVE_API_URL",
|
|
542
|
+
"name": "base-url",
|
|
543
|
+
"hasDynamicHelp": false,
|
|
544
|
+
"multiple": false,
|
|
545
|
+
"type": "option"
|
|
546
|
+
},
|
|
547
|
+
"id": {
|
|
548
|
+
"description": "Resource UUID",
|
|
549
|
+
"name": "id",
|
|
550
|
+
"required": true,
|
|
551
|
+
"hasDynamicHelp": false,
|
|
552
|
+
"multiple": false,
|
|
553
|
+
"type": "option"
|
|
554
|
+
},
|
|
555
|
+
"token": {
|
|
556
|
+
"description": "Signed download token from webhook payload",
|
|
557
|
+
"name": "token",
|
|
558
|
+
"required": false,
|
|
559
|
+
"hasDynamicHelp": false,
|
|
560
|
+
"multiple": false,
|
|
561
|
+
"type": "option"
|
|
562
|
+
},
|
|
563
|
+
"output": {
|
|
564
|
+
"description": "Write binary response bytes to a file",
|
|
565
|
+
"name": "output",
|
|
566
|
+
"hasDynamicHelp": false,
|
|
567
|
+
"multiple": false,
|
|
568
|
+
"type": "option"
|
|
569
|
+
}
|
|
570
|
+
},
|
|
571
|
+
"hasDynamicHelp": false,
|
|
572
|
+
"hiddenAliases": [],
|
|
573
|
+
"id": "emails:download-raw-email",
|
|
574
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
575
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
576
|
+
"pluginType": "core",
|
|
577
|
+
"strict": true,
|
|
578
|
+
"summary": "Download raw email",
|
|
579
|
+
"enableJsonFlag": false
|
|
580
|
+
},
|
|
581
|
+
"emails:get-email": {
|
|
582
|
+
"aliases": [],
|
|
583
|
+
"args": {},
|
|
584
|
+
"description": "GET /emails/{id}",
|
|
585
|
+
"flags": {
|
|
586
|
+
"api-key": {
|
|
587
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
588
|
+
"env": "PRIMITIVE_API_KEY",
|
|
589
|
+
"name": "api-key",
|
|
590
|
+
"hasDynamicHelp": false,
|
|
591
|
+
"multiple": false,
|
|
592
|
+
"type": "option"
|
|
593
|
+
},
|
|
594
|
+
"base-url": {
|
|
595
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
596
|
+
"env": "PRIMITIVE_API_URL",
|
|
597
|
+
"name": "base-url",
|
|
598
|
+
"hasDynamicHelp": false,
|
|
599
|
+
"multiple": false,
|
|
600
|
+
"type": "option"
|
|
601
|
+
},
|
|
602
|
+
"id": {
|
|
603
|
+
"description": "Resource UUID",
|
|
604
|
+
"name": "id",
|
|
605
|
+
"required": true,
|
|
606
|
+
"hasDynamicHelp": false,
|
|
607
|
+
"multiple": false,
|
|
608
|
+
"type": "option"
|
|
609
|
+
}
|
|
610
|
+
},
|
|
611
|
+
"hasDynamicHelp": false,
|
|
612
|
+
"hiddenAliases": [],
|
|
613
|
+
"id": "emails:get-email",
|
|
614
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
615
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
616
|
+
"pluginType": "core",
|
|
617
|
+
"strict": true,
|
|
618
|
+
"summary": "Get email details",
|
|
619
|
+
"enableJsonFlag": false
|
|
620
|
+
},
|
|
621
|
+
"emails:list-emails": {
|
|
622
|
+
"aliases": [],
|
|
623
|
+
"args": {},
|
|
624
|
+
"description": "Returns a paginated list of received emails. Supports filtering by\ndomain, status, date range, and free-text search across subject,\nsender, and recipient fields.\n",
|
|
625
|
+
"flags": {
|
|
626
|
+
"api-key": {
|
|
627
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
628
|
+
"env": "PRIMITIVE_API_KEY",
|
|
629
|
+
"name": "api-key",
|
|
630
|
+
"hasDynamicHelp": false,
|
|
631
|
+
"multiple": false,
|
|
632
|
+
"type": "option"
|
|
633
|
+
},
|
|
634
|
+
"base-url": {
|
|
635
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
636
|
+
"env": "PRIMITIVE_API_URL",
|
|
637
|
+
"name": "base-url",
|
|
638
|
+
"hasDynamicHelp": false,
|
|
639
|
+
"multiple": false,
|
|
640
|
+
"type": "option"
|
|
641
|
+
},
|
|
642
|
+
"cursor": {
|
|
643
|
+
"description": "Pagination cursor from a previous response's `meta.cursor` field.\nFormat: `{ISO-datetime}|{id}`\n",
|
|
644
|
+
"name": "cursor",
|
|
645
|
+
"required": false,
|
|
646
|
+
"hasDynamicHelp": false,
|
|
647
|
+
"multiple": false,
|
|
648
|
+
"type": "option"
|
|
649
|
+
},
|
|
650
|
+
"limit": {
|
|
651
|
+
"description": "Number of results per page",
|
|
652
|
+
"name": "limit",
|
|
653
|
+
"required": false,
|
|
654
|
+
"hasDynamicHelp": false,
|
|
655
|
+
"multiple": false,
|
|
656
|
+
"type": "option"
|
|
657
|
+
},
|
|
658
|
+
"domain-id": {
|
|
659
|
+
"description": "Filter by domain ID",
|
|
660
|
+
"name": "domain-id",
|
|
661
|
+
"required": false,
|
|
662
|
+
"hasDynamicHelp": false,
|
|
663
|
+
"multiple": false,
|
|
664
|
+
"type": "option"
|
|
665
|
+
},
|
|
666
|
+
"status": {
|
|
667
|
+
"description": "Filter by email status",
|
|
668
|
+
"name": "status",
|
|
669
|
+
"required": false,
|
|
670
|
+
"hasDynamicHelp": false,
|
|
671
|
+
"multiple": false,
|
|
672
|
+
"type": "option"
|
|
673
|
+
},
|
|
674
|
+
"search": {
|
|
675
|
+
"description": "Search subject, sender, and recipient (case-insensitive)",
|
|
676
|
+
"name": "search",
|
|
677
|
+
"required": false,
|
|
678
|
+
"hasDynamicHelp": false,
|
|
679
|
+
"multiple": false,
|
|
680
|
+
"type": "option"
|
|
681
|
+
},
|
|
682
|
+
"date-from": {
|
|
683
|
+
"description": "Filter emails created on or after this timestamp",
|
|
684
|
+
"name": "date-from",
|
|
685
|
+
"required": false,
|
|
686
|
+
"hasDynamicHelp": false,
|
|
687
|
+
"multiple": false,
|
|
688
|
+
"type": "option"
|
|
689
|
+
},
|
|
690
|
+
"date-to": {
|
|
691
|
+
"description": "Filter emails created on or before this timestamp",
|
|
692
|
+
"name": "date-to",
|
|
693
|
+
"required": false,
|
|
694
|
+
"hasDynamicHelp": false,
|
|
695
|
+
"multiple": false,
|
|
696
|
+
"type": "option"
|
|
697
|
+
}
|
|
698
|
+
},
|
|
699
|
+
"hasDynamicHelp": false,
|
|
700
|
+
"hiddenAliases": [],
|
|
701
|
+
"id": "emails:list-emails",
|
|
702
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
703
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
704
|
+
"pluginType": "core",
|
|
705
|
+
"strict": true,
|
|
706
|
+
"summary": "List emails",
|
|
707
|
+
"enableJsonFlag": false
|
|
708
|
+
},
|
|
709
|
+
"emails:replay-email-webhooks": {
|
|
710
|
+
"aliases": [],
|
|
711
|
+
"args": {},
|
|
712
|
+
"description": "Re-delivers the webhook payload for this email to all active\nendpoints matching the email's domain. Includes rate limiting\nto prevent stampeding.\n",
|
|
713
|
+
"flags": {
|
|
714
|
+
"api-key": {
|
|
715
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
716
|
+
"env": "PRIMITIVE_API_KEY",
|
|
717
|
+
"name": "api-key",
|
|
718
|
+
"hasDynamicHelp": false,
|
|
719
|
+
"multiple": false,
|
|
720
|
+
"type": "option"
|
|
721
|
+
},
|
|
722
|
+
"base-url": {
|
|
723
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
724
|
+
"env": "PRIMITIVE_API_URL",
|
|
725
|
+
"name": "base-url",
|
|
726
|
+
"hasDynamicHelp": false,
|
|
727
|
+
"multiple": false,
|
|
728
|
+
"type": "option"
|
|
729
|
+
},
|
|
730
|
+
"id": {
|
|
731
|
+
"description": "Resource UUID",
|
|
732
|
+
"name": "id",
|
|
733
|
+
"required": true,
|
|
734
|
+
"hasDynamicHelp": false,
|
|
735
|
+
"multiple": false,
|
|
736
|
+
"type": "option"
|
|
737
|
+
}
|
|
738
|
+
},
|
|
739
|
+
"hasDynamicHelp": false,
|
|
740
|
+
"hiddenAliases": [],
|
|
741
|
+
"id": "emails:replay-email-webhooks",
|
|
742
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
743
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
744
|
+
"pluginType": "core",
|
|
745
|
+
"strict": true,
|
|
746
|
+
"summary": "Replay email webhooks",
|
|
747
|
+
"enableJsonFlag": false
|
|
748
|
+
},
|
|
749
|
+
"endpoints:create-endpoint": {
|
|
750
|
+
"aliases": [],
|
|
751
|
+
"args": {},
|
|
752
|
+
"description": "Creates a new webhook endpoint. If a deactivated endpoint with the\nsame URL and domain exists, it is reactivated instead.\nSubject to plan limits on the number of active endpoints.\n",
|
|
753
|
+
"flags": {
|
|
754
|
+
"api-key": {
|
|
755
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
756
|
+
"env": "PRIMITIVE_API_KEY",
|
|
757
|
+
"name": "api-key",
|
|
758
|
+
"hasDynamicHelp": false,
|
|
759
|
+
"multiple": false,
|
|
760
|
+
"type": "option"
|
|
761
|
+
},
|
|
762
|
+
"base-url": {
|
|
763
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
764
|
+
"env": "PRIMITIVE_API_URL",
|
|
765
|
+
"name": "base-url",
|
|
766
|
+
"hasDynamicHelp": false,
|
|
767
|
+
"multiple": false,
|
|
768
|
+
"type": "option"
|
|
769
|
+
},
|
|
770
|
+
"body": {
|
|
771
|
+
"description": "JSON request body",
|
|
772
|
+
"name": "body",
|
|
773
|
+
"hasDynamicHelp": false,
|
|
774
|
+
"multiple": false,
|
|
775
|
+
"type": "option"
|
|
776
|
+
},
|
|
777
|
+
"body-file": {
|
|
778
|
+
"description": "Path to a JSON file used as the request body",
|
|
779
|
+
"name": "body-file",
|
|
780
|
+
"hasDynamicHelp": false,
|
|
781
|
+
"multiple": false,
|
|
782
|
+
"type": "option"
|
|
783
|
+
}
|
|
784
|
+
},
|
|
785
|
+
"hasDynamicHelp": false,
|
|
786
|
+
"hiddenAliases": [],
|
|
787
|
+
"id": "endpoints:create-endpoint",
|
|
788
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
789
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
790
|
+
"pluginType": "core",
|
|
791
|
+
"strict": true,
|
|
792
|
+
"summary": "Create a webhook endpoint",
|
|
793
|
+
"enableJsonFlag": false
|
|
794
|
+
},
|
|
795
|
+
"endpoints:delete-endpoint": {
|
|
796
|
+
"aliases": [],
|
|
797
|
+
"args": {},
|
|
798
|
+
"description": "Soft-deletes a webhook endpoint. The endpoint will no longer\nreceive webhook deliveries.\n",
|
|
799
|
+
"flags": {
|
|
800
|
+
"api-key": {
|
|
801
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
802
|
+
"env": "PRIMITIVE_API_KEY",
|
|
803
|
+
"name": "api-key",
|
|
804
|
+
"hasDynamicHelp": false,
|
|
805
|
+
"multiple": false,
|
|
806
|
+
"type": "option"
|
|
807
|
+
},
|
|
808
|
+
"base-url": {
|
|
809
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
810
|
+
"env": "PRIMITIVE_API_URL",
|
|
811
|
+
"name": "base-url",
|
|
812
|
+
"hasDynamicHelp": false,
|
|
813
|
+
"multiple": false,
|
|
814
|
+
"type": "option"
|
|
815
|
+
},
|
|
816
|
+
"id": {
|
|
817
|
+
"description": "Resource UUID",
|
|
818
|
+
"name": "id",
|
|
819
|
+
"required": true,
|
|
820
|
+
"hasDynamicHelp": false,
|
|
821
|
+
"multiple": false,
|
|
822
|
+
"type": "option"
|
|
823
|
+
}
|
|
824
|
+
},
|
|
825
|
+
"hasDynamicHelp": false,
|
|
826
|
+
"hiddenAliases": [],
|
|
827
|
+
"id": "endpoints:delete-endpoint",
|
|
828
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
829
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
830
|
+
"pluginType": "core",
|
|
831
|
+
"strict": true,
|
|
832
|
+
"summary": "Delete a webhook endpoint",
|
|
833
|
+
"enableJsonFlag": false
|
|
834
|
+
},
|
|
835
|
+
"endpoints:list-endpoints": {
|
|
836
|
+
"aliases": [],
|
|
837
|
+
"args": {},
|
|
838
|
+
"description": "Returns all active (non-deleted) webhook endpoints.",
|
|
839
|
+
"flags": {
|
|
840
|
+
"api-key": {
|
|
841
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
842
|
+
"env": "PRIMITIVE_API_KEY",
|
|
843
|
+
"name": "api-key",
|
|
844
|
+
"hasDynamicHelp": false,
|
|
845
|
+
"multiple": false,
|
|
846
|
+
"type": "option"
|
|
847
|
+
},
|
|
848
|
+
"base-url": {
|
|
849
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
850
|
+
"env": "PRIMITIVE_API_URL",
|
|
851
|
+
"name": "base-url",
|
|
852
|
+
"hasDynamicHelp": false,
|
|
853
|
+
"multiple": false,
|
|
854
|
+
"type": "option"
|
|
855
|
+
}
|
|
856
|
+
},
|
|
857
|
+
"hasDynamicHelp": false,
|
|
858
|
+
"hiddenAliases": [],
|
|
859
|
+
"id": "endpoints:list-endpoints",
|
|
860
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
861
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
862
|
+
"pluginType": "core",
|
|
863
|
+
"strict": true,
|
|
864
|
+
"summary": "List webhook endpoints",
|
|
865
|
+
"enableJsonFlag": false
|
|
866
|
+
},
|
|
867
|
+
"endpoints:test-endpoint": {
|
|
868
|
+
"aliases": [],
|
|
869
|
+
"args": {},
|
|
870
|
+
"description": "Sends a sample `email.received` event to the endpoint. The request\nincludes SSRF protection (private IP rejection and DNS pinning).\nRate limited to 4 per minute and 30 per hour (non-exempt).\nSuccessful deliveries and verified-domain endpoints are exempt\nfrom the rate limit.\n",
|
|
871
|
+
"flags": {
|
|
872
|
+
"api-key": {
|
|
873
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
874
|
+
"env": "PRIMITIVE_API_KEY",
|
|
875
|
+
"name": "api-key",
|
|
876
|
+
"hasDynamicHelp": false,
|
|
877
|
+
"multiple": false,
|
|
878
|
+
"type": "option"
|
|
879
|
+
},
|
|
880
|
+
"base-url": {
|
|
881
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
882
|
+
"env": "PRIMITIVE_API_URL",
|
|
883
|
+
"name": "base-url",
|
|
884
|
+
"hasDynamicHelp": false,
|
|
885
|
+
"multiple": false,
|
|
886
|
+
"type": "option"
|
|
887
|
+
},
|
|
888
|
+
"id": {
|
|
889
|
+
"description": "Resource UUID",
|
|
890
|
+
"name": "id",
|
|
891
|
+
"required": true,
|
|
892
|
+
"hasDynamicHelp": false,
|
|
893
|
+
"multiple": false,
|
|
894
|
+
"type": "option"
|
|
895
|
+
}
|
|
896
|
+
},
|
|
897
|
+
"hasDynamicHelp": false,
|
|
898
|
+
"hiddenAliases": [],
|
|
899
|
+
"id": "endpoints:test-endpoint",
|
|
900
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
901
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
902
|
+
"pluginType": "core",
|
|
903
|
+
"strict": true,
|
|
904
|
+
"summary": "Send a test webhook",
|
|
905
|
+
"enableJsonFlag": false
|
|
906
|
+
},
|
|
907
|
+
"endpoints:update-endpoint": {
|
|
908
|
+
"aliases": [],
|
|
909
|
+
"args": {},
|
|
910
|
+
"description": "Updates an active webhook endpoint. If the URL is changed, the old\nendpoint is deactivated and a new one is created (or an existing\ndeactivated endpoint with the new URL is reactivated).\n",
|
|
911
|
+
"flags": {
|
|
912
|
+
"api-key": {
|
|
913
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
914
|
+
"env": "PRIMITIVE_API_KEY",
|
|
915
|
+
"name": "api-key",
|
|
916
|
+
"hasDynamicHelp": false,
|
|
917
|
+
"multiple": false,
|
|
918
|
+
"type": "option"
|
|
919
|
+
},
|
|
920
|
+
"base-url": {
|
|
921
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
922
|
+
"env": "PRIMITIVE_API_URL",
|
|
923
|
+
"name": "base-url",
|
|
924
|
+
"hasDynamicHelp": false,
|
|
925
|
+
"multiple": false,
|
|
926
|
+
"type": "option"
|
|
927
|
+
},
|
|
928
|
+
"id": {
|
|
929
|
+
"description": "Resource UUID",
|
|
930
|
+
"name": "id",
|
|
931
|
+
"required": true,
|
|
932
|
+
"hasDynamicHelp": false,
|
|
933
|
+
"multiple": false,
|
|
934
|
+
"type": "option"
|
|
935
|
+
},
|
|
936
|
+
"body": {
|
|
937
|
+
"description": "JSON request body",
|
|
938
|
+
"name": "body",
|
|
939
|
+
"hasDynamicHelp": false,
|
|
940
|
+
"multiple": false,
|
|
941
|
+
"type": "option"
|
|
942
|
+
},
|
|
943
|
+
"body-file": {
|
|
944
|
+
"description": "Path to a JSON file used as the request body",
|
|
945
|
+
"name": "body-file",
|
|
946
|
+
"hasDynamicHelp": false,
|
|
947
|
+
"multiple": false,
|
|
948
|
+
"type": "option"
|
|
949
|
+
}
|
|
950
|
+
},
|
|
951
|
+
"hasDynamicHelp": false,
|
|
952
|
+
"hiddenAliases": [],
|
|
953
|
+
"id": "endpoints:update-endpoint",
|
|
954
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
955
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
956
|
+
"pluginType": "core",
|
|
957
|
+
"strict": true,
|
|
958
|
+
"summary": "Update a webhook endpoint",
|
|
959
|
+
"enableJsonFlag": false
|
|
960
|
+
},
|
|
961
|
+
"filters:create-filter": {
|
|
962
|
+
"aliases": [],
|
|
963
|
+
"args": {},
|
|
964
|
+
"description": "Creates a new whitelist or blocklist filter. Per-domain filters\nrequire a Pro plan. Patterns are stored as lowercase.\n",
|
|
965
|
+
"flags": {
|
|
966
|
+
"api-key": {
|
|
967
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
968
|
+
"env": "PRIMITIVE_API_KEY",
|
|
969
|
+
"name": "api-key",
|
|
970
|
+
"hasDynamicHelp": false,
|
|
971
|
+
"multiple": false,
|
|
972
|
+
"type": "option"
|
|
973
|
+
},
|
|
974
|
+
"base-url": {
|
|
975
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
976
|
+
"env": "PRIMITIVE_API_URL",
|
|
977
|
+
"name": "base-url",
|
|
978
|
+
"hasDynamicHelp": false,
|
|
979
|
+
"multiple": false,
|
|
980
|
+
"type": "option"
|
|
981
|
+
},
|
|
982
|
+
"body": {
|
|
983
|
+
"description": "JSON request body",
|
|
984
|
+
"name": "body",
|
|
985
|
+
"hasDynamicHelp": false,
|
|
986
|
+
"multiple": false,
|
|
987
|
+
"type": "option"
|
|
988
|
+
},
|
|
989
|
+
"body-file": {
|
|
990
|
+
"description": "Path to a JSON file used as the request body",
|
|
991
|
+
"name": "body-file",
|
|
992
|
+
"hasDynamicHelp": false,
|
|
993
|
+
"multiple": false,
|
|
994
|
+
"type": "option"
|
|
995
|
+
}
|
|
996
|
+
},
|
|
997
|
+
"hasDynamicHelp": false,
|
|
998
|
+
"hiddenAliases": [],
|
|
999
|
+
"id": "filters:create-filter",
|
|
1000
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
1001
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
1002
|
+
"pluginType": "core",
|
|
1003
|
+
"strict": true,
|
|
1004
|
+
"summary": "Create a filter rule",
|
|
1005
|
+
"enableJsonFlag": false
|
|
1006
|
+
},
|
|
1007
|
+
"filters:delete-filter": {
|
|
1008
|
+
"aliases": [],
|
|
1009
|
+
"args": {},
|
|
1010
|
+
"description": "DELETE /filters/{id}",
|
|
1011
|
+
"flags": {
|
|
1012
|
+
"api-key": {
|
|
1013
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
1014
|
+
"env": "PRIMITIVE_API_KEY",
|
|
1015
|
+
"name": "api-key",
|
|
1016
|
+
"hasDynamicHelp": false,
|
|
1017
|
+
"multiple": false,
|
|
1018
|
+
"type": "option"
|
|
1019
|
+
},
|
|
1020
|
+
"base-url": {
|
|
1021
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
1022
|
+
"env": "PRIMITIVE_API_URL",
|
|
1023
|
+
"name": "base-url",
|
|
1024
|
+
"hasDynamicHelp": false,
|
|
1025
|
+
"multiple": false,
|
|
1026
|
+
"type": "option"
|
|
1027
|
+
},
|
|
1028
|
+
"id": {
|
|
1029
|
+
"description": "Resource UUID",
|
|
1030
|
+
"name": "id",
|
|
1031
|
+
"required": true,
|
|
1032
|
+
"hasDynamicHelp": false,
|
|
1033
|
+
"multiple": false,
|
|
1034
|
+
"type": "option"
|
|
1035
|
+
}
|
|
1036
|
+
},
|
|
1037
|
+
"hasDynamicHelp": false,
|
|
1038
|
+
"hiddenAliases": [],
|
|
1039
|
+
"id": "filters:delete-filter",
|
|
1040
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
1041
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
1042
|
+
"pluginType": "core",
|
|
1043
|
+
"strict": true,
|
|
1044
|
+
"summary": "Delete a filter rule",
|
|
1045
|
+
"enableJsonFlag": false
|
|
1046
|
+
},
|
|
1047
|
+
"filters:list-filters": {
|
|
1048
|
+
"aliases": [],
|
|
1049
|
+
"args": {},
|
|
1050
|
+
"description": "Returns all whitelist and blocklist filter rules.",
|
|
1051
|
+
"flags": {
|
|
1052
|
+
"api-key": {
|
|
1053
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
1054
|
+
"env": "PRIMITIVE_API_KEY",
|
|
1055
|
+
"name": "api-key",
|
|
1056
|
+
"hasDynamicHelp": false,
|
|
1057
|
+
"multiple": false,
|
|
1058
|
+
"type": "option"
|
|
1059
|
+
},
|
|
1060
|
+
"base-url": {
|
|
1061
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
1062
|
+
"env": "PRIMITIVE_API_URL",
|
|
1063
|
+
"name": "base-url",
|
|
1064
|
+
"hasDynamicHelp": false,
|
|
1065
|
+
"multiple": false,
|
|
1066
|
+
"type": "option"
|
|
1067
|
+
}
|
|
1068
|
+
},
|
|
1069
|
+
"hasDynamicHelp": false,
|
|
1070
|
+
"hiddenAliases": [],
|
|
1071
|
+
"id": "filters:list-filters",
|
|
1072
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
1073
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
1074
|
+
"pluginType": "core",
|
|
1075
|
+
"strict": true,
|
|
1076
|
+
"summary": "List filter rules",
|
|
1077
|
+
"enableJsonFlag": false
|
|
1078
|
+
},
|
|
1079
|
+
"filters:update-filter": {
|
|
1080
|
+
"aliases": [],
|
|
1081
|
+
"args": {},
|
|
1082
|
+
"description": "Toggle a filter's enabled state.",
|
|
1083
|
+
"flags": {
|
|
1084
|
+
"api-key": {
|
|
1085
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
1086
|
+
"env": "PRIMITIVE_API_KEY",
|
|
1087
|
+
"name": "api-key",
|
|
1088
|
+
"hasDynamicHelp": false,
|
|
1089
|
+
"multiple": false,
|
|
1090
|
+
"type": "option"
|
|
1091
|
+
},
|
|
1092
|
+
"base-url": {
|
|
1093
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
1094
|
+
"env": "PRIMITIVE_API_URL",
|
|
1095
|
+
"name": "base-url",
|
|
1096
|
+
"hasDynamicHelp": false,
|
|
1097
|
+
"multiple": false,
|
|
1098
|
+
"type": "option"
|
|
1099
|
+
},
|
|
1100
|
+
"id": {
|
|
1101
|
+
"description": "Resource UUID",
|
|
1102
|
+
"name": "id",
|
|
1103
|
+
"required": true,
|
|
1104
|
+
"hasDynamicHelp": false,
|
|
1105
|
+
"multiple": false,
|
|
1106
|
+
"type": "option"
|
|
1107
|
+
},
|
|
1108
|
+
"body": {
|
|
1109
|
+
"description": "JSON request body",
|
|
1110
|
+
"name": "body",
|
|
1111
|
+
"hasDynamicHelp": false,
|
|
1112
|
+
"multiple": false,
|
|
1113
|
+
"type": "option"
|
|
1114
|
+
},
|
|
1115
|
+
"body-file": {
|
|
1116
|
+
"description": "Path to a JSON file used as the request body",
|
|
1117
|
+
"name": "body-file",
|
|
1118
|
+
"hasDynamicHelp": false,
|
|
1119
|
+
"multiple": false,
|
|
1120
|
+
"type": "option"
|
|
1121
|
+
}
|
|
1122
|
+
},
|
|
1123
|
+
"hasDynamicHelp": false,
|
|
1124
|
+
"hiddenAliases": [],
|
|
1125
|
+
"id": "filters:update-filter",
|
|
1126
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
1127
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
1128
|
+
"pluginType": "core",
|
|
1129
|
+
"strict": true,
|
|
1130
|
+
"summary": "Update a filter rule",
|
|
1131
|
+
"enableJsonFlag": false
|
|
1132
|
+
},
|
|
1133
|
+
"webhook-deliveries:list-deliveries": {
|
|
1134
|
+
"aliases": [],
|
|
1135
|
+
"args": {},
|
|
1136
|
+
"description": "Returns a paginated list of webhook delivery attempts. Each delivery\nincludes a nested `email` object with sender, recipient, and subject.\n",
|
|
1137
|
+
"flags": {
|
|
1138
|
+
"api-key": {
|
|
1139
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
1140
|
+
"env": "PRIMITIVE_API_KEY",
|
|
1141
|
+
"name": "api-key",
|
|
1142
|
+
"hasDynamicHelp": false,
|
|
1143
|
+
"multiple": false,
|
|
1144
|
+
"type": "option"
|
|
1145
|
+
},
|
|
1146
|
+
"base-url": {
|
|
1147
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
1148
|
+
"env": "PRIMITIVE_API_URL",
|
|
1149
|
+
"name": "base-url",
|
|
1150
|
+
"hasDynamicHelp": false,
|
|
1151
|
+
"multiple": false,
|
|
1152
|
+
"type": "option"
|
|
1153
|
+
},
|
|
1154
|
+
"cursor": {
|
|
1155
|
+
"description": "Pagination cursor from a previous response's `meta.cursor` field.\nFormat: `{ISO-datetime}|{id}`\n",
|
|
1156
|
+
"name": "cursor",
|
|
1157
|
+
"required": false,
|
|
1158
|
+
"hasDynamicHelp": false,
|
|
1159
|
+
"multiple": false,
|
|
1160
|
+
"type": "option"
|
|
1161
|
+
},
|
|
1162
|
+
"limit": {
|
|
1163
|
+
"description": "Number of results per page",
|
|
1164
|
+
"name": "limit",
|
|
1165
|
+
"required": false,
|
|
1166
|
+
"hasDynamicHelp": false,
|
|
1167
|
+
"multiple": false,
|
|
1168
|
+
"type": "option"
|
|
1169
|
+
},
|
|
1170
|
+
"email-id": {
|
|
1171
|
+
"description": "Filter by email ID",
|
|
1172
|
+
"name": "email-id",
|
|
1173
|
+
"required": false,
|
|
1174
|
+
"hasDynamicHelp": false,
|
|
1175
|
+
"multiple": false,
|
|
1176
|
+
"type": "option"
|
|
1177
|
+
},
|
|
1178
|
+
"status": {
|
|
1179
|
+
"description": "Filter by delivery status",
|
|
1180
|
+
"name": "status",
|
|
1181
|
+
"required": false,
|
|
1182
|
+
"hasDynamicHelp": false,
|
|
1183
|
+
"multiple": false,
|
|
1184
|
+
"type": "option"
|
|
1185
|
+
},
|
|
1186
|
+
"date-from": {
|
|
1187
|
+
"description": "Filter deliveries created on or after this timestamp",
|
|
1188
|
+
"name": "date-from",
|
|
1189
|
+
"required": false,
|
|
1190
|
+
"hasDynamicHelp": false,
|
|
1191
|
+
"multiple": false,
|
|
1192
|
+
"type": "option"
|
|
1193
|
+
},
|
|
1194
|
+
"date-to": {
|
|
1195
|
+
"description": "Filter deliveries created on or before this timestamp",
|
|
1196
|
+
"name": "date-to",
|
|
1197
|
+
"required": false,
|
|
1198
|
+
"hasDynamicHelp": false,
|
|
1199
|
+
"multiple": false,
|
|
1200
|
+
"type": "option"
|
|
1201
|
+
}
|
|
1202
|
+
},
|
|
1203
|
+
"hasDynamicHelp": false,
|
|
1204
|
+
"hiddenAliases": [],
|
|
1205
|
+
"id": "webhook-deliveries:list-deliveries",
|
|
1206
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
1207
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
1208
|
+
"pluginType": "core",
|
|
1209
|
+
"strict": true,
|
|
1210
|
+
"summary": "List webhook deliveries",
|
|
1211
|
+
"enableJsonFlag": false
|
|
1212
|
+
},
|
|
1213
|
+
"webhook-deliveries:replay-delivery": {
|
|
1214
|
+
"aliases": [],
|
|
1215
|
+
"args": {},
|
|
1216
|
+
"description": "Re-sends the stored webhook payload from a previous delivery attempt.\nIf the original endpoint is still active, it is targeted. If the\noriginal endpoint was deleted, the first active endpoint is used.\nDeactivated endpoints cannot be replayed to.\n",
|
|
1217
|
+
"flags": {
|
|
1218
|
+
"api-key": {
|
|
1219
|
+
"description": "Primitive API key (defaults to PRIMITIVE_API_KEY)",
|
|
1220
|
+
"env": "PRIMITIVE_API_KEY",
|
|
1221
|
+
"name": "api-key",
|
|
1222
|
+
"hasDynamicHelp": false,
|
|
1223
|
+
"multiple": false,
|
|
1224
|
+
"type": "option"
|
|
1225
|
+
},
|
|
1226
|
+
"base-url": {
|
|
1227
|
+
"description": "API base URL (defaults to PRIMITIVE_API_URL or production)",
|
|
1228
|
+
"env": "PRIMITIVE_API_URL",
|
|
1229
|
+
"name": "base-url",
|
|
1230
|
+
"hasDynamicHelp": false,
|
|
1231
|
+
"multiple": false,
|
|
1232
|
+
"type": "option"
|
|
1233
|
+
},
|
|
1234
|
+
"id": {
|
|
1235
|
+
"description": "Delivery ID (numeric)",
|
|
1236
|
+
"name": "id",
|
|
1237
|
+
"required": true,
|
|
1238
|
+
"hasDynamicHelp": false,
|
|
1239
|
+
"multiple": false,
|
|
1240
|
+
"type": "option"
|
|
1241
|
+
}
|
|
1242
|
+
},
|
|
1243
|
+
"hasDynamicHelp": false,
|
|
1244
|
+
"hiddenAliases": [],
|
|
1245
|
+
"id": "webhook-deliveries:replay-delivery",
|
|
1246
|
+
"pluginAlias": "@primitivedotdev/sdk",
|
|
1247
|
+
"pluginName": "@primitivedotdev/sdk",
|
|
1248
|
+
"pluginType": "core",
|
|
1249
|
+
"strict": true,
|
|
1250
|
+
"summary": "Replay a webhook delivery",
|
|
1251
|
+
"enableJsonFlag": false
|
|
1252
|
+
}
|
|
1253
|
+
},
|
|
1254
|
+
"version": "0.3.0"
|
|
1255
|
+
}
|