@zapier/zapier-sdk-cli 0.28.0 → 0.29.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.
Files changed (25) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/CLAUDE.md +15 -15
  3. package/README.md +142 -142
  4. package/dist/cli.cjs +61 -55
  5. package/dist/cli.mjs +61 -55
  6. package/dist/index.cjs +49 -49
  7. package/dist/index.d.mts +7 -7
  8. package/dist/index.d.ts +7 -7
  9. package/dist/index.mjs +49 -49
  10. package/dist/package.json +1 -1
  11. package/dist/src/generators/ast-generator.d.ts +1 -1
  12. package/dist/src/generators/ast-generator.js +7 -7
  13. package/dist/src/plugins/add/index.d.ts +2 -2
  14. package/dist/src/plugins/add/index.js +12 -12
  15. package/dist/src/plugins/add/schemas.d.ts +1 -1
  16. package/dist/src/plugins/add/schemas.js +2 -2
  17. package/dist/src/plugins/buildManifest/index.js +2 -2
  18. package/dist/src/plugins/generateAppTypes/index.d.ts +2 -2
  19. package/dist/src/plugins/generateAppTypes/index.js +26 -26
  20. package/dist/src/plugins/generateAppTypes/schemas.d.ts +7 -7
  21. package/dist/src/plugins/generateAppTypes/schemas.js +2 -2
  22. package/dist/src/utils/cli-generator.js +10 -2
  23. package/dist/src/utils/parameter-resolver.js +8 -8
  24. package/dist/tsconfig.tsbuildinfo +1 -1
  25. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @zapier/zapier-sdk-cli
2
2
 
3
+ ## 0.29.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 9fb0b48: Switch from "authentication" to "connection" everywhere.
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [9fb0b48]
12
+ - @zapier/zapier-sdk-mcp@0.9.0
13
+ - @zapier/zapier-sdk@0.27.0
14
+
3
15
  ## 0.28.0
4
16
 
5
17
  ### Minor Changes
package/CLAUDE.md CHANGED
@@ -88,13 +88,13 @@ npx zapier-sdk add slack --types-output ./types/zapier/
88
88
  npx zapier-sdk generate-app-types slack --types-output ./types/
89
89
  ```
90
90
 
91
- ### Dynamic Fields and Authentication
91
+ ### Dynamic Fields and Connections
92
92
 
93
- Some apps have fields that depend on your authentication (e.g., "Select a Slack channel" requires knowing which workspace you're connected to). To generate types for these:
93
+ Some apps have fields that depend on your connection (e.g., "Select a Slack channel" requires knowing which workspace you're connected to). To generate types for these:
94
94
 
95
95
  ```bash
96
- # Provide auth IDs for dynamic field resolution
97
- npx zapier-sdk add slack --authentication-ids 123456
96
+ # Provide connection IDs for dynamic field resolution
97
+ npx zapier-sdk add slack --connection-ids 123456
98
98
  ```
99
99
 
100
100
  ### When to Regenerate
@@ -102,7 +102,7 @@ npx zapier-sdk add slack --authentication-ids 123456
102
102
  Run `add` again when:
103
103
 
104
104
  - You want to update to a newer app version
105
- - You've added a new authentication that reveals new dynamic fields
105
+ - You've added a new connection that reveals new dynamic fields
106
106
  - Your types were accidentally deleted
107
107
 
108
108
  ## App Discovery Workflow
@@ -157,7 +157,7 @@ Execute Zapier actions directly from the command line.
157
157
  ### Basic Usage
158
158
 
159
159
  ```bash
160
- npx zapier-sdk run-action slack read channels --authentication-id 123456
160
+ npx zapier-sdk run-action slack read channels --connection-id 123456
161
161
  ```
162
162
 
163
163
  ### With Inputs
@@ -165,7 +165,7 @@ npx zapier-sdk run-action slack read channels --authentication-id 123456
165
165
  ```bash
166
166
  # Pass inputs as JSON
167
167
  npx zapier-sdk run-action slack write send_channel_message \
168
- --authentication-id 123456 \
168
+ --connection-id 123456 \
169
169
  --inputs '{"channel": "#general", "text": "Hello from CLI!"}'
170
170
  ```
171
171
 
@@ -183,20 +183,20 @@ npx zapier-sdk run-action
183
183
  ```bash
184
184
  # Get raw JSON output for scripting
185
185
  npx zapier-sdk run-action slack read channels \
186
- --authentication-id 123456 \
186
+ --connection-id 123456 \
187
187
  --json
188
188
  ```
189
189
 
190
- ### Multiple Authentications
190
+ ### Multiple Connections
191
191
 
192
192
  If you have multiple Slack connections and don't specify which one:
193
193
 
194
194
  - The CLI shows a list and prompts you to choose
195
- - Or use `list-authentications` to find the right ID first
195
+ - Or use `list-connections` to find the right ID first
196
196
 
197
197
  ```bash
198
- # Find your auth IDs
199
- npx zapier-sdk list-authentications --app-key slack --owner me
198
+ # Find your connection IDs
199
+ npx zapier-sdk list-connections --app-key slack --owner me
200
200
  ```
201
201
 
202
202
  ## MCP Server
@@ -258,11 +258,11 @@ npx zapier-sdk get-login-config-path
258
258
  npx zapier-sdk login
259
259
  ```
260
260
 
261
- **"Authentication not found"**
261
+ **"Connection not found"**
262
262
 
263
263
  ```bash
264
- # List your authentications to find valid IDs
265
- npx zapier-sdk list-authentications --owner me
264
+ # List your connections to find valid IDs
265
+ npx zapier-sdk list-connections --owner me
266
266
  ```
267
267
 
268
268
  **"App not found"**
package/README.md CHANGED
@@ -20,15 +20,15 @@
20
20
  - [Apps](#apps)
21
21
  - [`get-app`](#get-app)
22
22
  - [`list-apps`](#list-apps)
23
- - [Authentications](#authentications)
24
- - [`find-first-authentication`](#find-first-authentication)
25
- - [`find-unique-authentication`](#find-unique-authentication)
26
- - [`get-authentication`](#get-authentication)
27
- - [`list-authentications`](#list-authentications)
28
23
  - [Client Credentials](#client-credentials)
29
24
  - [`create-client-credentials`](#create-client-credentials)
30
25
  - [`delete-client-credentials`](#delete-client-credentials)
31
26
  - [`list-client-credentials`](#list-client-credentials)
27
+ - [Connections](#connections)
28
+ - [`find-first-connection`](#find-first-connection)
29
+ - [`find-unique-connection`](#find-unique-connection)
30
+ - [`get-connection`](#get-connection)
31
+ - [`list-connections`](#list-connections)
32
32
  - [HTTP Requests](#http-requests)
33
33
  - [`fetch`](#fetch)
34
34
  - [Utilities](#utilities)
@@ -64,19 +64,19 @@ npx zapier-sdk list-apps --search "gmail"
64
64
  npx zapier-sdk run-action gmail
65
65
  # This will ask you for the type of action you want to run.
66
66
  # `search` or `write` are typically great for testing.
67
- # Note that you usually need an authentication (connection) to the app to run
67
+ # Note that you usually need a connection to the app to run
68
68
  # the action. If you don't already have one, you can create a new one at:
69
69
  # https://zapier.com/app/assets/connections
70
70
 
71
- # List authentications for an app.
72
- npx zapier-sdk list-authentications gmail
71
+ # List connections for an app.
72
+ npx zapier-sdk list-connections gmail
73
73
  # Or only list the ones you own.
74
- npx zapier-sdk list-authentications gmail --owner me
74
+ npx zapier-sdk list-connections gmail --owner me
75
75
  # Or just grab the first one.
76
- npx zapier-sdk find-first-authentication gmail --owner me
76
+ npx zapier-sdk find-first-connection gmail --owner me
77
77
 
78
- # Make any API request to an app using your authentication (connection).
79
- npx zapier-sdk fetch "https://gmail.googleapis.com/gmail/v1/users/me/labels" --authentication-id 123
78
+ # Make any API request to an app using your connection.
79
+ npx zapier-sdk fetch "https://gmail.googleapis.com/gmail/v1/users/me/labels" --connection-id 123
80
80
  ```
81
81
 
82
82
  ## Global Options
@@ -158,18 +158,18 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
158
158
 
159
159
  **Options:**
160
160
 
161
- | Option | Type | Required | Default | Possible Values | Description |
162
- | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
163
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
164
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
165
- | `<action-key>` | `string` | ✅ | — | — | Action key to get the input schema for |
166
- | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use when fetching the schema. Required if the action needs authentication to determine available fields. |
167
- | `--inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
161
+ | Option | Type | Required | Default | Possible Values | Description |
162
+ | ----------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
163
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
164
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
165
+ | `<action-key>` | `string` | ✅ | — | — | Action key to get the input schema for |
166
+ | `--connection-id` | `string, number` | ❌ | — | — | Connection ID to use when fetching the schema. Required if the action needs a connection to determine available fields. |
167
+ | `--inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
168
168
 
169
169
  **Usage:**
170
170
 
171
171
  ```bash
172
- npx zapier-sdk get-input-fields-schema <app-key> <action-type> <action-key> [--authentication-id] [--inputs]
172
+ npx zapier-sdk get-input-fields-schema <app-key> <action-type> <action-key> [--connection-id] [--inputs]
173
173
  ```
174
174
 
175
175
  #### `list-actions`
@@ -198,23 +198,23 @@ Get the available choices for a dynamic dropdown input field
198
198
 
199
199
  **Options:**
200
200
 
201
- | Option | Type | Required | Default | Possible Values | Description |
202
- | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
203
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
204
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
205
- | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
206
- | `<input-field-key>` | `string` | ✅ | — | — | Input field key to get choices for. |
207
- | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
208
- | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
209
- | `--page` | `number` | ❌ | — | — | Page number for paginated results |
210
- | `--page-size` | `number` | ❌ | — | — | Number of choices per page |
211
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
212
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
201
+ | Option | Type | Required | Default | Possible Values | Description |
202
+ | ------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
203
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
204
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
205
+ | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
206
+ | `<input-field-key>` | `string` | ✅ | — | — | Input field key to get choices for. |
207
+ | `--connection-id` | `string, number` | ❌ | — | — | Connection ID to use for this action |
208
+ | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
209
+ | `--page` | `number` | ❌ | — | — | Page number for paginated results |
210
+ | `--page-size` | `number` | ❌ | — | — | Number of choices per page |
211
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
212
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
213
213
 
214
214
  **Usage:**
215
215
 
216
216
  ```bash
217
- npx zapier-sdk list-input-field-choices <app-key> <action-type> <action-key> <input-field-key> [--authentication-id] [--inputs] [--page] [--page-size] [--max-items] [--cursor]
217
+ npx zapier-sdk list-input-field-choices <app-key> <action-type> <action-key> <input-field-key> [--connection-id] [--inputs] [--page] [--page-size] [--max-items] [--cursor]
218
218
  ```
219
219
 
220
220
  #### `list-input-fields`
@@ -223,21 +223,21 @@ Get the input fields required for a specific action
223
223
 
224
224
  **Options:**
225
225
 
226
- | Option | Type | Required | Default | Possible Values | Description |
227
- | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
228
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
229
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
230
- | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
231
- | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
232
- | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
233
- | `--page-size` | `number` | ❌ | — | — | Number of input fields per page |
234
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
235
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
226
+ | Option | Type | Required | Default | Possible Values | Description |
227
+ | ----------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
228
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
229
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
230
+ | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
231
+ | `--connection-id` | `string, number` | ❌ | — | — | Connection ID to use for this action |
232
+ | `--inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
233
+ | `--page-size` | `number` | ❌ | — | — | Number of input fields per page |
234
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
235
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
236
236
 
237
237
  **Usage:**
238
238
 
239
239
  ```bash
240
- npx zapier-sdk list-input-fields <app-key> <action-type> <action-key> [--authentication-id] [--inputs] [--page-size] [--max-items] [--cursor]
240
+ npx zapier-sdk list-input-fields <app-key> <action-type> <action-key> [--connection-id] [--inputs] [--page-size] [--max-items] [--cursor]
241
241
  ```
242
242
 
243
243
  #### `run-action`
@@ -246,22 +246,22 @@ Execute an action with the given inputs
246
246
 
247
247
  **Options:**
248
248
 
249
- | Option | Type | Required | Default | Possible Values | Description |
250
- | --------------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
251
- | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
252
- | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
253
- | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
254
- | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
255
- | `--inputs` | `object` | ❌ | — | — | Input parameters for the action |
256
- | `--timeout-ms` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
257
- | `--page-size` | `number` | ❌ | — | — | Number of results per page |
258
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
259
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
249
+ | Option | Type | Required | Default | Possible Values | Description |
250
+ | ----------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
251
+ | `<app-key>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
252
+ | `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
253
+ | `<action-key>` | `string` | ✅ | — | — | Action key to execute |
254
+ | `--connection-id` | `string, number` | ❌ | — | — | Connection ID to use for this action |
255
+ | `--inputs` | `object` | ❌ | — | — | Input parameters for the action |
256
+ | `--timeout-ms` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
257
+ | `--page-size` | `number` | ❌ | — | — | Number of results per page |
258
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
259
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
260
260
 
261
261
  **Usage:**
262
262
 
263
263
  ```bash
264
- npx zapier-sdk run-action <app-key> <action-type> <action-key> [--authentication-id] [--inputs] [--timeout-ms] [--page-size] [--max-items] [--cursor]
264
+ npx zapier-sdk run-action <app-key> <action-type> <action-key> [--connection-id] [--inputs] [--timeout-ms] [--page-size] [--max-items] [--cursor]
265
265
  ```
266
266
 
267
267
  ### Apps
@@ -302,165 +302,165 @@ List all available apps with optional filtering
302
302
  npx zapier-sdk list-apps [--app-keys] [--search] [--page-size] [--max-items] [--cursor]
303
303
  ```
304
304
 
305
- ### Authentications
305
+ ### Client Credentials
306
306
 
307
- #### `find-first-authentication`
307
+ #### `create-client-credentials`
308
308
 
309
- Find the first authentication matching the criteria
309
+ Create new client credentials for the authenticated user
310
310
 
311
311
  **Options:**
312
312
 
313
- | Option | Type | Required | Default | Possible Values | Description |
314
- | -------------- | --------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
315
- | `--app-key` | `string` | ❌ | — | — | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github') |
316
- | `--search` | `string` | ❌ | — | — | Search term to filter authentications by title |
317
- | `--title` | `string` | ❌ | — | — | Filter authentications by exact title match (searches first, then filters locally) |
318
- | `--account-id` | `string` | ❌ | — | — | Filter authentications by account ID |
319
- | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own authentications or a specific user ID |
320
- | `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status (true = expired only, false = non-expired only) |
313
+ | Option | Type | Required | Default | Possible Values | Description |
314
+ | ------------------ | -------- | -------- | -------------- | --------------- | ---------------------------------------------- |
315
+ | `<name>` | `string` | ✅ | — | — | Human-readable name for the client credentials |
316
+ | `--allowed-scopes` | `array` | ❌ | `["external"]` | — | Scopes to allow for these credentials |
321
317
 
322
318
  **Usage:**
323
319
 
324
320
  ```bash
325
- npx zapier-sdk find-first-authentication [--app-key] [--search] [--title] [--account-id] [--owner] [--is-expired]
321
+ npx zapier-sdk create-client-credentials <name> [--allowed-scopes]
326
322
  ```
327
323
 
328
- #### `find-unique-authentication`
324
+ #### `delete-client-credentials`
329
325
 
330
- Find a unique authentication matching the criteria
326
+ Delete client credentials by client ID
331
327
 
332
328
  **Options:**
333
329
 
334
- | Option | Type | Required | Default | Possible Values | Description |
335
- | -------------- | --------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
336
- | `--app-key` | `string` | ❌ | — | — | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github') |
337
- | `--search` | `string` | ❌ | — | — | Search term to filter authentications by title |
338
- | `--title` | `string` | ❌ | — | — | Filter authentications by exact title match (searches first, then filters locally) |
339
- | `--account-id` | `string` | ❌ | — | — | Filter authentications by account ID |
340
- | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own authentications or a specific user ID |
341
- | `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status (true = expired only, false = non-expired only) |
330
+ | Option | Type | Required | Default | Possible Values | Description |
331
+ | ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------- |
332
+ | `<client-id>` | `string` | ✅ | — | — | The client ID of the client credentials to delete |
342
333
 
343
334
  **Usage:**
344
335
 
345
336
  ```bash
346
- npx zapier-sdk find-unique-authentication [--app-key] [--search] [--title] [--account-id] [--owner] [--is-expired]
337
+ npx zapier-sdk delete-client-credentials <client-id>
347
338
  ```
348
339
 
349
- #### `get-authentication`
340
+ #### `list-client-credentials`
350
341
 
351
- Get a specific authentication by ID
342
+ List client credentials for the authenticated user
352
343
 
353
344
  **Options:**
354
345
 
355
- | Option | Type | Required | Default | Possible Values | Description |
356
- | --------------------- | -------- | -------- | ------- | --------------- | ----------------------------- |
357
- | `<authentication-id>` | `string` | ✅ | — | — | Authentication ID to retrieve |
346
+ | Option | Type | Required | Default | Possible Values | Description |
347
+ | ------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
348
+ | `--page-size` | `number` | ❌ | — | — | Number of credentials per page |
349
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
350
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
358
351
 
359
352
  **Usage:**
360
353
 
361
354
  ```bash
362
- npx zapier-sdk get-authentication <authentication-id>
355
+ npx zapier-sdk list-client-credentials [--page-size] [--max-items] [--cursor]
363
356
  ```
364
357
 
365
- #### `list-authentications`
358
+ ### Connections
359
+
360
+ #### `find-first-connection`
366
361
 
367
- List available authentications with optional filtering
362
+ Find the first connection matching the criteria
368
363
 
369
364
  **Options:**
370
365
 
371
- | Option | Type | Required | Default | Possible Values | Description |
372
- | ---------------------- | --------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
373
- | `--app-key` | `string` | ❌ | — | — | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github') |
374
- | `--authentication-ids` | `array` | ❌ | — | — | List of authentication IDs to filter by |
375
- | `--search` | `string` | ❌ | — | — | Search term to filter authentications by title |
376
- | `--title` | `string` | ❌ | — | — | Filter authentications by exact title match (searches first, then filters locally) |
377
- | `--account-id` | `string` | ❌ | — | — | Filter authentications by account ID |
378
- | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own authentications or a specific user ID |
379
- | `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status (true = expired only, false = non-expired only) |
380
- | `--page-size` | `number` | ❌ | — | — | Number of authentications per page |
381
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
382
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
366
+ | Option | Type | Required | Default | Possible Values | Description |
367
+ | -------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
368
+ | `--search` | `string` | ❌ | — | — | Search term to filter connections by title |
369
+ | `--title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
370
+ | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
371
+ | `--app-key` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
372
+ | `--account-id` | `string` | ❌ | — | — | Account ID to filter by |
373
+ | `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status |
383
374
 
384
375
  **Usage:**
385
376
 
386
377
  ```bash
387
- npx zapier-sdk list-authentications [--app-key] [--authentication-ids] [--search] [--title] [--account-id] [--owner] [--is-expired] [--page-size] [--max-items] [--cursor]
378
+ npx zapier-sdk find-first-connection [--search] [--title] [--owner] [--app-key] [--account-id] [--is-expired]
388
379
  ```
389
380
 
390
- ### Client Credentials
391
-
392
- #### `create-client-credentials`
381
+ #### `find-unique-connection`
393
382
 
394
- Create new client credentials for the authenticated user
383
+ Find a unique connection matching the criteria
395
384
 
396
385
  **Options:**
397
386
 
398
- | Option | Type | Required | Default | Possible Values | Description |
399
- | ------------------ | -------- | -------- | -------------- | --------------- | ---------------------------------------------- |
400
- | `<name>` | `string` | ✅ | — | — | Human-readable name for the client credentials |
401
- | `--allowed-scopes` | `array` | ❌ | `["external"]` | — | Scopes to allow for these credentials |
387
+ | Option | Type | Required | Default | Possible Values | Description |
388
+ | -------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
389
+ | `--search` | `string` | ❌ | — | — | Search term to filter connections by title |
390
+ | `--title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
391
+ | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
392
+ | `--app-key` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
393
+ | `--account-id` | `string` | ❌ | — | — | Account ID to filter by |
394
+ | `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status |
402
395
 
403
396
  **Usage:**
404
397
 
405
398
  ```bash
406
- npx zapier-sdk create-client-credentials <name> [--allowed-scopes]
399
+ npx zapier-sdk find-unique-connection [--search] [--title] [--owner] [--app-key] [--account-id] [--is-expired]
407
400
  ```
408
401
 
409
- #### `delete-client-credentials`
402
+ #### `get-connection`
410
403
 
411
- Delete client credentials by client ID
404
+ Execute getConnection
412
405
 
413
406
  **Options:**
414
407
 
415
- | Option | Type | Required | Default | Possible Values | Description |
416
- | ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------- |
417
- | `<client-id>` | `string` | ✅ | — | — | The client ID of the client credentials to delete |
408
+ | Option | Type | Required | Default | Possible Values | Description |
409
+ | ----------------- | ---------------- | -------- | ------- | --------------- | ------------------------------------ |
410
+ | `--connection-id` | `string, number` | ❌ | — | — | Connection ID to use for this action |
418
411
 
419
412
  **Usage:**
420
413
 
421
414
  ```bash
422
- npx zapier-sdk delete-client-credentials <client-id>
415
+ npx zapier-sdk get-connection [--connection-id]
423
416
  ```
424
417
 
425
- #### `list-client-credentials`
418
+ #### `list-connections`
426
419
 
427
- List client credentials for the authenticated user
420
+ List available connections with optional filtering
428
421
 
429
422
  **Options:**
430
423
 
431
- | Option | Type | Required | Default | Possible Values | Description |
432
- | ------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
433
- | `--page-size` | `number` | ❌ | — | — | Number of credentials per page |
434
- | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
435
- | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
424
+ | Option | Type | Required | Default | Possible Values | Description |
425
+ | ------------------ | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------ |
426
+ | `--search` | `string` | ❌ | — | — | Search term to filter connections by title |
427
+ | `--title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
428
+ | `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
429
+ | `--app-key` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
430
+ | `--connection-ids` | `array` | ❌ | — | — | List of connection IDs to filter by |
431
+ | `--account-id` | `string` | ❌ | — | — | Account ID to filter by |
432
+ | `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status |
433
+ | `--page-size` | `number` | ❌ | — | — | Number of connections per page |
434
+ | `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
435
+ | `--cursor` | `string` | ❌ | — | — | Cursor to start from |
436
436
 
437
437
  **Usage:**
438
438
 
439
439
  ```bash
440
- npx zapier-sdk list-client-credentials [--page-size] [--max-items] [--cursor]
440
+ npx zapier-sdk list-connections [--search] [--title] [--owner] [--app-key] [--connection-ids] [--account-id] [--is-expired] [--page-size] [--max-items] [--cursor]
441
441
  ```
442
442
 
443
443
  ### HTTP Requests
444
444
 
445
445
  #### `fetch`
446
446
 
447
- Make authenticated HTTP requests to any API through Zapier's Relay service. Pass an authenticationId to automatically inject the user's stored credentials (OAuth tokens, API keys, etc.) into the outgoing request. Mirrors the native fetch(url, init?) signature with additional Zapier-specific options.
447
+ Make authenticated HTTP requests to any API through Zapier's Relay service. Pass a connectionId to automatically inject the user's stored credentials (OAuth tokens, API keys, etc.) into the outgoing request. Mirrors the native fetch(url, init?) signature with additional Zapier-specific options.
448
448
 
449
449
  **Options:**
450
450
 
451
- | Option | Type | Required | Default | Possible Values | Description |
452
- | --------------------- | -------------------------------- | -------- | ------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
453
- | `<url>` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
454
- | `--method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET) |
455
- | `--headers` | `object` | ❌ | — | — | HTTP headers to include in the request |
456
- | `--body` | `string, custom, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
457
- | `--authentication-id` | `string, number` | ❌ | — | — | Authentication ID to use for this action |
458
- | `--callback-url` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
451
+ | Option | Type | Required | Default | Possible Values | Description |
452
+ | ----------------- | -------------------------------- | -------- | ------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
453
+ | `<url>` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
454
+ | `--method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET) |
455
+ | `--headers` | `object` | ❌ | — | — | HTTP headers to include in the request |
456
+ | `--body` | `string, custom, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
457
+ | `--connection-id` | `string, number` | ❌ | — | — | Connection ID to use for this action |
458
+ | `--callback-url` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
459
459
 
460
460
  **Usage:**
461
461
 
462
462
  ```bash
463
- npx zapier-sdk fetch <url> [--method] [--headers] [--body] [--authentication-id] [--callback-url]
463
+ npx zapier-sdk fetch <url> [--method] [--headers] [--body] [--connection-id] [--callback-url]
464
464
  ```
465
465
 
466
466
  ### Utilities
@@ -471,17 +471,17 @@ Add apps with manifest locking and TypeScript type generation - updates .zapierr
471
471
 
472
472
  **Options:**
473
473
 
474
- | Option | Type | Required | Default | Possible Values | Description |
475
- | ---------------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------- |
476
- | `<app-keys>` | `array` | ✅ | — | — | One or more app keys to add (e.g., 'slack', 'github', 'trello') |
477
- | `--authentication-ids` | `array` | ❌ | — | — | Authentication IDs to use for type generation (e.g., ['123', '456']) |
478
- | `--config-path` | `string` | ❌ | — | — | Path to Zapier config file (defaults to '.zapierrc', e.g., './custom/.zapierrc') |
479
- | `--types-output` | `string` | ❌ | — | — | Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/') |
474
+ | Option | Type | Required | Default | Possible Values | Description |
475
+ | ------------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------- |
476
+ | `<app-keys>` | `array` | ✅ | — | — | One or more app keys to add (e.g., 'slack', 'github', 'trello') |
477
+ | `--connection-ids` | `array` | ❌ | — | — | Connection IDs to use for type generation (e.g., ['123', '456']) |
478
+ | `--config-path` | `string` | ❌ | — | — | Path to Zapier config file (defaults to '.zapierrc', e.g., './custom/.zapierrc') |
479
+ | `--types-output` | `string` | ❌ | — | — | Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/') |
480
480
 
481
481
  **Usage:**
482
482
 
483
483
  ```bash
484
- npx zapier-sdk add <app-keys> [--authentication-ids] [--config-path] [--types-output]
484
+ npx zapier-sdk add <app-keys> [--connection-ids] [--config-path] [--types-output]
485
485
  ```
486
486
 
487
487
  #### `build-manifest`
@@ -549,14 +549,14 @@ Generate TypeScript type definitions for apps - can optionally write to disk or
549
549
  | Option | Type | Required | Default | Possible Values | Description |
550
550
  | -------------------------- | --------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------- |
551
551
  | `<app-keys>` | `array` | ✅ | — | — | One or more app keys to generate types for (e.g., 'slack', 'github', 'trello') |
552
- | `--authentication-ids` | `array` | ❌ | — | — | Authentication IDs to use for type generation (e.g., ['123', '456']) |
552
+ | `--connection-ids` | `array` | ❌ | — | — | Connection IDs to use for type generation (e.g., ['123', '456']) |
553
553
  | `--skip-write` | `boolean` | ❌ | — | — | If true, returns type definitions without writing to disk. If false or omitted, writes type files. |
554
554
  | `--types-output-directory` | `string` | ❌ | — | — | Directory for TypeScript type files. Required when skipWrite is false or omitted. |
555
555
 
556
556
  **Usage:**
557
557
 
558
558
  ```bash
559
- npx zapier-sdk generate-app-types <app-keys> [--authentication-ids] [--skip-write] [--types-output-directory]
559
+ npx zapier-sdk generate-app-types <app-keys> [--connection-ids] [--skip-write] [--types-output-directory]
560
560
  ```
561
561
 
562
562
  #### `get-login-config-path`