@zapier/zapier-sdk 0.97.1 → 0.98.1

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/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.98.1
4
+
5
+ ### Patch Changes
6
+
7
+ - cd0616e: _This release contains no user-facing changes._
8
+
9
+ ## 0.98.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 9a5ae37: Added `status` to `listConnections`, `findFirstConnection`, and `findUniqueConnection` to filter connections by expiry: `active` (the default, and the existing behaviour), `expired`, or `all` for both. Previously only non-expired connections were returned by default and `expired: true` returned only expired ones, so a single call could never cover both. `expired` and `isExpired` are now deprecated in favour of `status` and still work; combining `status` with either throws a validation error.
14
+
3
15
  ## 0.97.1
4
16
 
5
17
  ### Patch Changes
package/README.md CHANGED
@@ -2254,16 +2254,16 @@ Find the first connection matching the criteria
2254
2254
 
2255
2255
  **Parameters:**
2256
2256
 
2257
- | Name | Type | Required | Default | Possible Values | Description |
2258
- | ------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2259
- | `options` | `object` | ✅ | — | — | |
2260
- | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
2261
- | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
2262
- | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
2263
- | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
2264
- | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
2265
- | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
2266
- | ​ ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
2257
+ | Name | Type | Required | Default | Possible Values | Description |
2258
+ | ------------------- | --------- | -------- | ------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2259
+ | `options` | `object` | ✅ | — | — | |
2260
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
2261
+ | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
2262
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
2263
+ | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
2264
+ | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
2265
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
2266
+ | ​ ↳ `status` | `string` | ❌ | — | `active`, `expired`, `all` | Filter connections by expiry: 'active' (default) returns only non-expired connections, 'expired' only expired ones, and 'all' returns both. |
2267
2267
 
2268
2268
  **Returns:** `Promise<ConnectionItem>`
2269
2269
 
@@ -2311,16 +2311,16 @@ Find a unique connection matching the criteria
2311
2311
 
2312
2312
  **Parameters:**
2313
2313
 
2314
- | Name | Type | Required | Default | Possible Values | Description |
2315
- | ------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2316
- | `options` | `object` | ✅ | — | — | |
2317
- | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
2318
- | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
2319
- | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
2320
- | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
2321
- | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
2322
- | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
2323
- | ​ ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
2314
+ | Name | Type | Required | Default | Possible Values | Description |
2315
+ | ------------------- | --------- | -------- | ------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2316
+ | `options` | `object` | ✅ | — | — | |
2317
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
2318
+ | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
2319
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
2320
+ | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
2321
+ | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
2322
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
2323
+ | ​ ↳ `status` | `string` | ❌ | — | `active`, `expired`, `all` | Filter connections by expiry: 'active' (default) returns only non-expired connections, 'expired' only expired ones, and 'all' returns both. |
2324
2324
 
2325
2325
  **Returns:** `Promise<ConnectionItem>`
2326
2326
 
@@ -2462,20 +2462,20 @@ List available connections with optional filtering
2462
2462
 
2463
2463
  **Parameters:**
2464
2464
 
2465
- | Name | Type | Required | Default | Possible Values | Description |
2466
- | ------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2467
- | `options` | `object` | ✅ | — | — | |
2468
- | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
2469
- | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
2470
- | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
2471
- | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
2472
- | ​ ↳ `connections` | `array` | ❌ | — | — | List of connection IDs to filter by |
2473
- | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
2474
- | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
2475
- | ​ ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
2476
- | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of connections per page |
2477
- | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
2478
- | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
2465
+ | Name | Type | Required | Default | Possible Values | Description |
2466
+ | ------------------- | --------- | -------- | ------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2467
+ | `options` | `object` | ✅ | — | — | |
2468
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
2469
+ | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
2470
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
2471
+ | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
2472
+ | ​ ↳ `connections` | `array` | ❌ | — | — | List of connection IDs to filter by |
2473
+ | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
2474
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
2475
+ | ​ ↳ `status` | `string` | ❌ | — | `active`, `expired`, `all` | Filter connections by expiry: 'active' (default) returns only non-expired connections, 'expired' only expired ones, and 'all' returns both. |
2476
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of connections per page |
2477
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
2478
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
2479
2479
 
2480
2480
  **Returns:** `Promise<PaginatedResult<ConnectionItem>>`
2481
2481