@zapier/zapier-sdk 0.5.2 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @zapier/zapier-sdk
 
+## 0.6.0
+
+### Minor Changes
+
+- c472d6f: Add manifest plugin to consume a supplied manifest, as well as lockVersion plugin to create or update the manifest.
+- c402bcd: Remove \_\_registry in favor of getRegistry that also provides categories for functions.
+
+### Patch Changes
+
+- e08365e: Add support for lock file in generate-types command
+
 ## 0.5.2
 
 ### Patch Changes

package/README.md

@@ -8,22 +8,24 @@
 - [Quick Start](#quick-start)
 - [Available Functions](#available-functions)
 - [Actions](#actions)
-  - [`listActions`](#listactions)
   - [`getAction`](#getaction)
+  - [`listActions`](#listactions)
   - [`listInputFields`](#listinputfields)
   - [`runAction`](#runaction)
 - [Apps](#apps)
-  - [`listApps`](#listapps)
   - [`getApp`](#getapp)
-- [Authentication](#authentication)
-  - [`listAuthentications`](#listauthentications)
-  - [`getAuthentication`](#getauthentication)
+  - [`listApps`](#listapps)
+- [Authentications](#authentications)
   - [`findFirstAuthentication`](#findfirstauthentication)
   - [`findUniqueAuthentication`](#finduniqueauthentication)
+  - [`getAuthentication`](#getauthentication)
+  - [`listAuthentications`](#listauthentications)
 - [HTTP Requests](#http-requests)
   - [`request`](#request)
-- [User & Profile](#user--profile)
+- [Users](#users)
   - [`getProfile`](#getprofile)
+- [Utilities](#utilities)
+  - [`lockVersion`](#lockversion)
 
 ## Installation
 
@@ -59,50 +61,50 @@ const result = await sdk.runAction({
 
 ### Actions
 
-#### `listActions`
+#### `getAction`
 
-List all actions for a specific app
+Get detailed information about a specific action
 
 **Parameters:**
 
-| Name         | Type     | Required | Default | Possible Values                                                                                | Description                                      |
-| ------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------ |
-| `appKey`     | `string` | ✅       | —       | —                                                                                              | App key of actions to list (e.g., 'SlackCLIAPI') |
-| `actionType` | `string` | ❌       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type                           |
-| `pageSize`   | `number` | ❌       | —       | —                                                                                              | Number of actions per page                       |
-| `maxItems`   | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages   |
+| Name         | Type     | Required | Default | Possible Values                                                                                | Description                                        |
+| ------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| `appKey`     | `string` | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI')                      |
+| `actionType` | `string` | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
+| `actionKey`  | `string` | ✅       | —       | —                                                                                              | Action key to execute                              |
 
-**Returns:** `Promise<PaginatedResult<ActionItem>>`
+**Returns:** `Promise<ActionItem>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.listActions({
+const result = await sdk.getAction({
   appKey: "example-key",
+  actionType: "read",
+  actionKey: "example-key",
 });
 ```
 
-#### `getAction`
+#### `listActions`
 
-Get detailed information about a specific action
+List all actions for a specific app
 
 **Parameters:**
 
-| Name         | Type     | Required | Default | Possible Values                                                                                | Description                                        |
-| ------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
-| `appKey`     | `string` | ✅       | —       | —                                                                                              | App key (e.g., 'SlackCLIAPI')                      |
-| `actionType` | `string` | ✅       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
-| `actionKey`  | `string` | ✅       | —       | —                                                                                              | Action key to execute                              |
+| Name         | Type     | Required | Default | Possible Values                                                                                | Description                                      |
+| ------------ | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------ |
+| `appKey`     | `string` | ✅       | —       | —                                                                                              | App key of actions to list (e.g., 'SlackCLIAPI') |
+| `actionType` | `string` | ❌       | —       | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type                           |
+| `pageSize`   | `number` | ❌       | —       | —                                                                                              | Number of actions per page                       |
+| `maxItems`   | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages   |
 
-**Returns:** `Promise<ActionItem>`
+**Returns:** `Promise<PaginatedResult<ActionItem>>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.getAction({
+const result = await sdk.listActions({
   appKey: "example-key",
-  actionType: "read",
-  actionKey: "example-key",
 });
 ```
 
@@ -164,27 +166,6 @@ const result = await sdk.runAction({
 
 ### Apps
 
-#### `listApps`
-
-List all available apps with optional filtering
-
-**Parameters:**
-
-| Name       | Type     | Required | Default | Possible Values | Description                                                         |
-| ---------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
-| `appKeys`  | `array`  | ❌       | —       | —               | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
-| `search`   | `string` | ❌       | —       | —               | Search for apps by name                                             |
-| `pageSize` | `number` | ❌       | —       | —               | Number of apps per page                                             |
-| `maxItems` | `number` | ❌       | —       | —               | Maximum total items to return across all pages                      |
-
-**Returns:** `Promise<PaginatedResult<AppItem>>`
-
-**Example:**
-
-```typescript
-const result = await sdk.listApps();
-```
-
 #### `getApp`
 
 Get detailed information about a specific app
@@ -205,51 +186,28 @@ const result = await sdk.getApp({
 });
 ```
 
-### Authentication
-
-#### `listAuthentications`
+#### `listApps`
 
-List available authentications with optional filtering
+List all available apps with optional filtering
 
 **Parameters:**
 
-| Name         | Type     | Required | Default | Possible Values | Description                                              |
-| ------------ | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
-| `appKey`     | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI') |
-| `search`     | `string` | ❌       | —       | —               | Search term to filter authentications by title           |
-| `title`      | `string` | ❌       | —       | —               | Filter authentications by exact title match              |
-| `account_id` | `string` | ❌       | —       | —               | Filter by account ID                                     |
-| `owner`      | `string` | ❌       | —       | —               | Filter by owner                                          |
-| `pageSize`   | `number` | ❌       | —       | —               | Number of authentications per page                       |
-| `maxItems`   | `number` | ❌       | —       | —               | Maximum total items to return across all pages           |
+| Name       | Type     | Required | Default | Possible Values | Description                                                         |
+| ---------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
+| `appKeys`  | `array`  | ❌       | —       | —               | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
+| `search`   | `string` | ❌       | —       | —               | Search for apps by name                                             |
+| `pageSize` | `number` | ❌       | —       | —               | Number of apps per page                                             |
+| `maxItems` | `number` | ❌       | —       | —               | Maximum total items to return across all pages                      |
 
-**Returns:** `Promise<PaginatedResult<Authentication>>`
+**Returns:** `Promise<PaginatedResult<AppItem>>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.listAuthentications();
+const result = await sdk.listApps();
 ```
 
-#### `getAuthentication`
-
-Get a specific authentication by ID
-
-**Parameters:**
-
-| Name               | Type     | Required | Default | Possible Values | Description                   |
-| ------------------ | -------- | -------- | ------- | --------------- | ----------------------------- |
-| `authenticationId` | `number` | ✅       | —       | —               | Authentication ID to retrieve |
-
-**Returns:** `Promise<Authentication>`
-
-**Example:**
-
-```typescript
-const result = await sdk.getAuthentication({
-  authenticationId: 12345,
-});
-```
+### Authentications
 
 #### `findFirstAuthentication`
 
@@ -295,6 +253,50 @@ Find a unique authentication matching the criteria
 const result = await sdk.findUniqueAuthentication();
 ```
 
+#### `getAuthentication`
+
+Get a specific authentication by ID
+
+**Parameters:**
+
+| Name               | Type     | Required | Default | Possible Values | Description                   |
+| ------------------ | -------- | -------- | ------- | --------------- | ----------------------------- |
+| `authenticationId` | `number` | ✅       | —       | —               | Authentication ID to retrieve |
+
+**Returns:** `Promise<Authentication>`
+
+**Example:**
+
+```typescript
+const result = await sdk.getAuthentication({
+  authenticationId: 12345,
+});
+```
+
+#### `listAuthentications`
+
+List available authentications with optional filtering
+
+**Parameters:**
+
+| Name         | Type     | Required | Default | Possible Values | Description                                              |
+| ------------ | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
+| `appKey`     | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI') |
+| `search`     | `string` | ❌       | —       | —               | Search term to filter authentications by title           |
+| `title`      | `string` | ❌       | —       | —               | Filter authentications by exact title match              |
+| `account_id` | `string` | ❌       | —       | —               | Filter by account ID                                     |
+| `owner`      | `string` | ❌       | —       | —               | Filter by owner                                          |
+| `pageSize`   | `number` | ❌       | —       | —               | Number of authentications per page                       |
+| `maxItems`   | `number` | ❌       | —       | —               | Maximum total items to return across all pages           |
+
+**Returns:** `Promise<PaginatedResult<Authentication>>`
+
+**Example:**
+
+```typescript
+const result = await sdk.listAuthentications();
+```
+
 ### HTTP Requests
 
 #### `request`
@@ -324,7 +326,7 @@ const result = await sdk.request({
 });
 ```
 
-### User & Profile
+### Users
 
 #### `getProfile`
 
@@ -340,4 +342,26 @@ Get current user's profile information
 const result = await sdk.getProfile();
 ```
 
+### Utilities
+
+#### `lockVersion`
+
+Execute lockVersion
+
+**Parameters:**
+
+| Name     | Type     | Required | Default | Possible Values | Description                                              |
+| -------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
+| `appKey` | `string` | ✅       | —       | —               | The app key to lock version for (e.g., 'slack', 'gmail') |
+
+**Returns:** `Promise<any>`
+
+**Example:**
+
+```typescript
+const result = await sdk.lockVersion({
+  appKey: "example-key",
+});
+```
+
 <!-- End Generated API Reference -->