@zapier/zapier-sdk 0.18.4 → 0.19.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @zapier/zapier-sdk
 
+## 1.1.0
+
+### Minor Changes
+
+- 4dd27eb: Add isExpired parameter to listAuthentications for filtering authentications by expiration status.
+
+## 1.0.3
+
+### Patch Changes
+
+- e393401: Adds CLAUDE.md documentation files to the zapier-sdk and zapier-sdk-cli packages to help users get up to speed faster when using AI assistants like Claude, Cursor, etc.
+
+## 1.0.2
+
+### Patch Changes
+
+- 00ef417: Resolved confusing "Failed to read manifest from .zapierrc" error
+
+## 1.0.1
+
+### Patch Changes
+
+- aba842a: Updated docs to remove reference to deprecated token option.
+
+## 1.0.0
+
+### Minor Changes
+
+- 97ff6c0: Add support for client credentials.
+
+### Patch Changes
+
+- Updated dependencies [97ff6c0]
+  - @zapier/zapier-sdk-cli-login@0.4.0
+
 ## 0.18.4
 
 ### Patch Changes

package/README.md

@@ -69,12 +69,21 @@ npx zapier-sdk add slack google-sheets --types-output ./types
 import { createZapierSdk } from "@zapier/zapier-sdk";
 
 // ######## Initialize Zapier SDK ########
-// Running `zapier-sdk login` authenticates through your browser, automatically handling token management
+// Option 1: Running `zapier-sdk login` authenticates through your browser,
+// automatically handling token management.
 const zapier = createZapierSdk();
 
-// Option 2: Manually provide a token
+// Option 2: Manually provide a token.
 // const zapier = createZapierSdk({
-//   token: "your_zapier_token_here", // or use ZAPIER_TOKEN env var
+//   credentials: "your_zapier_token_here", // or use ZAPIER_CREDENTIALS env var
+// });
+
+// Option 3: Manually provide a client ID and client secret.
+// const zapier = createZapierSdk({
+//   credentials: {
+//     clientId: "your_client_id_here", // or use ZAPIER_CREDENTIALS_CLIENT_ID env var
+//     clientSecret: "your_client_secret_here", // or use ZAPIER_CREDENTIALS_CLIENT_SECRET env var
+//   },
 // });
 
 // ######## Access Apps ########
@@ -606,14 +615,15 @@ Find the first authentication matching the criteria
 
 **Parameters:**
 
-| Name          | Type     | Required | Default | Possible Values | Description                                                                   |
-| ------------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------- |
-| `options`     | `object` | ✅       | —       | —               |                                                                               |
-| ↳ `appKey`    | `string` | ❌       | —       | —               | App key of authentication to find (e.g., 'SlackCLIAPI' or slug like 'github') |
-| ↳ `search`    | `string` | ❌       | —       | —               | Search term to filter authentications by title                                |
-| ↳ `title`     | `string` | ❌       | —       | —               | Filter authentications by exact title match                                   |
-| ↳ `accountId` | `string` | ❌       | —       | —               | Filter by account ID                                                          |
-| ↳ `owner`     | `string` | ❌       | —       | —               | Filter by owner                                                               |
+| Name          | Type      | Required | Default | Possible Values | Description                                                                        |
+| ------------- | --------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
+| `options`     | `object`  | ✅       | —       | —               |                                                                                    |
+| ↳ `appKey`    | `string`  | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
+| ↳ `search`    | `string`  | ❌       | —       | —               | Search term to filter authentications by title                                     |
+| ↳ `title`     | `string`  | ❌       | —       | —               | Filter authentications by exact title match (searches first, then filters locally) |
+| ↳ `accountId` | `string`  | ❌       | —       | —               | Filter authentications by account ID                                               |
+| ↳ `owner`     | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own authentications or a specific user ID           |
+| ↳ `isExpired` | `boolean` | ❌       | —       | —               | Filter by expired status (true = expired only, false = non-expired only)           |
 
 **Returns:** `Promise<AuthenticationItem>`
 
@@ -629,14 +639,15 @@ Find a unique authentication matching the criteria
 
 **Parameters:**
 
-| Name          | Type     | Required | Default | Possible Values | Description                                                                   |
-| ------------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------- |
-| `options`     | `object` | ✅       | —       | —               |                                                                               |
-| ↳ `appKey`    | `string` | ❌       | —       | —               | App key of authentication to find (e.g., 'SlackCLIAPI' or slug like 'github') |
-| ↳ `search`    | `string` | ❌       | —       | —               | Search term to filter authentications by title                                |
-| ↳ `title`     | `string` | ❌       | —       | —               | Filter authentications by exact title match                                   |
-| ↳ `accountId` | `string` | ❌       | —       | —               | Filter by account ID                                                          |
-| ↳ `owner`     | `string` | ❌       | —       | —               | Filter by owner                                                               |
+| Name          | Type      | Required | Default | Possible Values | Description                                                                        |
+| ------------- | --------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
+| `options`     | `object`  | ✅       | —       | —               |                                                                                    |
+| ↳ `appKey`    | `string`  | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
+| ↳ `search`    | `string`  | ❌       | —       | —               | Search term to filter authentications by title                                     |
+| ↳ `title`     | `string`  | ❌       | —       | —               | Filter authentications by exact title match (searches first, then filters locally) |
+| ↳ `accountId` | `string`  | ❌       | —       | —               | Filter authentications by account ID                                               |
+| ↳ `owner`     | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own authentications or a specific user ID           |
+| ↳ `isExpired` | `boolean` | ❌       | —       | —               | Filter by expired status (true = expired only, false = non-expired only)           |
 
 **Returns:** `Promise<AuthenticationItem>`
 
@@ -673,18 +684,19 @@ List available authentications with optional filtering
 
 **Parameters:**
 
-| Name                  | Type     | Required | Default | Possible Values | Description                                                                        |
-| --------------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
-| `options`             | `object` | ✅       | —       | —               |                                                                                    |
-| ↳ `appKey`            | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
-| ↳ `authenticationIds` | `array`  | ❌       | —       | —               | List of authentication IDs to filter by                                            |
-| ↳ `search`            | `string` | ❌       | —       | —               | Search term to filter authentications by title                                     |
-| ↳ `title`             | `string` | ❌       | —       | —               | Filter authentications by exact title match (searches first, then filters locally) |
-| ↳ `accountId`         | `string` | ❌       | —       | —               | Filter authentications by account ID                                               |
-| ↳ `owner`             | `string` | ❌       | —       | —               | Filter by owner - 'me' for your own authentications or a specific user ID          |
-| ↳ `pageSize`          | `number` | ❌       | —       | —               | Number of authentications per page                                                 |
-| ↳ `maxItems`          | `number` | ❌       | —       | —               | Maximum total items to return across all pages                                     |
-| ↳ `cursor`            | `string` | ❌       | —       | —               | Cursor to start from                                                               |
+| Name                  | Type      | Required | Default | Possible Values | Description                                                                        |
+| --------------------- | --------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------- |
+| `options`             | `object`  | ✅       | —       | —               |                                                                                    |
+| ↳ `appKey`            | `string`  | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI' or slug like 'github')     |
+| ↳ `authenticationIds` | `array`   | ❌       | —       | —               | List of authentication IDs to filter by                                            |
+| ↳ `search`            | `string`  | ❌       | —       | —               | Search term to filter authentications by title                                     |
+| ↳ `title`             | `string`  | ❌       | —       | —               | Filter authentications by exact title match (searches first, then filters locally) |
+| ↳ `accountId`         | `string`  | ❌       | —       | —               | Filter authentications by account ID                                               |
+| ↳ `owner`             | `string`  | ❌       | —       | —               | Filter by owner, 'me' for your own authentications or a specific user ID           |
+| ↳ `isExpired`         | `boolean` | ❌       | —       | —               | Filter by expired status (true = expired only, false = non-expired only)           |
+| ↳ `pageSize`          | `number`  | ❌       | —       | —               | Number of authentications per page                                                 |
+| ↳ `maxItems`          | `number`  | ❌       | —       | —               | Maximum total items to return across all pages                                     |
+| ↳ `cursor`            | `string`  | ❌       | —       | —               | Cursor to start from                                                               |
 
 **Returns:** `Promise<PaginatedResult<AuthenticationItem>>`