@zapier/zapier-sdk 0.11.2 → 0.12.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk
 
+## 0.12.1
+
+### Patch Changes
+
+- c2f88bc: Fix usage examples, add rough apps proxy examples
+
+## 0.12.0
+
+### Minor Changes
+
+- 21d8487: Improved get started README and added more documentation to the add plugin
+
 ## 0.11.2
 
 ### Patch Changes

package/README.md

@@ -14,6 +14,8 @@
   - [`listInputFields`](#listinputfields)
   - [`runAction`](#runaction)
 - [Apps](#apps)
+  - [`apps.{appKey}`](#appsappkey)
+  - [`apps.{appKey}.{actionType}.{actionKey}`](#appsappkeyactiontypeactionkey)
   - [`getApp`](#getapp)
   - [`listApps`](#listapps)
 - [Authentications](#authentications)
@@ -29,29 +31,85 @@
 
 ```bash
 npm install @zapier/zapier-sdk
+npm install -D @types/node typescript
+npx tsc --init
 ```
 
 ## Quick Start
 
+```bash
+# Authenticates through your browser, automatically handling token management
+npx zapier-sdk login
+
+# Generate TypeScript types for the request/response signatures of apps.
+# By default, the types will be generated inside of your `src` folder, if you have one, or the root folder.
+# To use these types, ensure they are added to your `tsconfig.json` file.
+
+# Single app
+npx zapier-sdk add slack --types-output ./types/slack.ts
+
+# Multiple apps
+npx zapier-sdk add slack github trello
+```
+
 ```typescript
 import { createZapierSdk } from "@zapier/zapier-sdk";
 
-const sdk = createZapierSdk({
-  token: "your_zapier_token_here", // or use ZAPIER_TOKEN env var
+// ######## Initialize Zapier SDK ########
+// Running `zapier-sdk login` authenticates through your browser, automatically handling token management
+const zapier = createZapierSdk();
+
+// Option 2: Manually provide a token
+// const zapier = createZapierSdk({
+//   token: "your_zapier_token_here", // or use ZAPIER_TOKEN env var
+// });
+
+// ######## Access Apps ########
+const apps = await zapier.listApps();
+const singleApp = await zapier.getApp({ appKey: "SlackCLIAPI" });
+
+// ######## Authentication Usage ########
+const myAuths = await zapier.listAuthentications({
+  appKey: "SlackCLIAPI",
+  owner: "me",
+});
+
+// ######## Find Actions ########
+// Option 1: List actions
+const actions = await zapier.listActions({ appKey: "SlackCLIAPI" });
+const singleAction = await zapier.getAction({
+  appKey: "SlackCLIAPI",
+  actionType: actions.data[0].action_type,
+  actionKey: actions.data[0].key,
 });
 
-// List all available apps
-const apps = await sdk.listApps();
+// Option 2: Access actions via the `apps` proxy
+// If you've generated TS types for an app using `zapier-sdk add`, you can access the app's actions like this:
+
+// await zapier.apps.slack.read.channles({});
+// await zapier.apps.slack.write.send_message({})
+
+// ######## Run Actions ########
+// Option 1:
+const allChannels = await zapier.runAction({
+  appKey: "SlackCLIAPI",
+  actionType: "read",
+  actionKey: "channels",
+  authenticationId: myAuths.data[0].id,
+});
 
-// Get information about a specific app
-const slackApp = await sdk.getApp({ appKey: "slack" });
+// Option 2:
+const allChannelsResult = await zapier.apps.slack.read.channels({
+  authenticationId: myAuths.data[0].id,
+});
 
-// Run an action
-const result = await sdk.runAction({
-  appKey: "slack",
-  actionType: "write",
-  actionKey: "send_message",
-  inputs: { channel: "#general", message: "Hello World!" },
+console.log({
+  apps: apps.data[0],
+  singleApp,
+  actions: actions.data[0],
+  singleAction,
+  allChannels: allChannels.data[0],
+  allChannelsResult,
 });
 ```
 
@@ -65,16 +123,16 @@ Get current user's profile information
 
 **Parameters:**
 
-| Name      | Type     | Required | Default | Possible Values | Description                            |
-| --------- | -------- | -------- | ------- | --------------- | -------------------------------------- |
-| `options` | `string` | ❌       | —       | —               | Get current user's profile information |
+| Name      | Type     | Required | Default | Possible Values | Description |
+| --------- | -------- | -------- | ------- | --------------- | ----------- |
+| `options` | `object` | ❌       | —       | —               |             |
 
 **Returns:** `Promise<ProfileItem>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.getProfile();
+const { data: profile } = await sdk.getProfile();
 ```
 
 ### Actions
@@ -87,7 +145,7 @@ Get detailed information about a specific action
 
 | Name           | Type     | Required | Default | Possible Values                                                                                | Description                                        |
 | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
-| `options`      | `string` | ✅       | —       | —                                                                                              | Get detailed information about a specific action   |
+| `options`      | `object` | ✅       | —       | —                                                                                              |                                                    |
 | ↳ `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                              |
@@ -97,8 +155,7 @@ Get detailed information about a specific action
 **Example:**
 
 ```typescript
-const result = await sdk.getAction({
-  options: "example-value",
+const { data: action } = await sdk.getAction({
   appKey: "example-key",
   actionType: "read",
   actionKey: "example-key",
@@ -113,7 +170,7 @@ List all actions for a specific app
 
 | Name           | Type     | Required | Default | Possible Values                                                                                | Description                                      |
 | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------ |
-| `options`      | `string` | ✅       | —       | —                                                                                              | List all actions for a specific app              |
+| `options`      | `object` | ✅       | —       | —                                                                                              |                                                  |
 | ↳ `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                       |
@@ -124,10 +181,26 @@ List all actions for a specific app
 **Example:**
 
 ```typescript
-const result = await sdk.listActions({
-  options: "example-value",
+// Get first page and a cursor for the second page
+const { data: actions, nextCursor } = await sdk.listActions({
   appKey: "example-key",
 });
+
+// Or iterate over all pages
+for await (const page of sdk.listActions({
+  appKey: "example-key",
+})) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const action of sdk
+  .listActions({
+    appKey: "example-key",
+  })
+  .items()) {
+  // Do something with each action
+}
 ```
 
 #### `listInputFieldChoices`
@@ -136,31 +209,55 @@ Get the available choices for a dynamic dropdown input field
 
 **Parameters:**
 
-| Name                 | Type     | Required | Default | Possible Values                                                                                | Description                                                  |
-| -------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
-| `options`            | `string` | ✅       | —       | —                                                                                              | Get the available choices for a dynamic dropdown input field |
-| ↳ `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                                        |
-| ↳ `inputFieldKey`    | `string` | ✅       | —       | —                                                                                              | Input field key to get choices for.                          |
-| ↳ `authenticationId` | `string` | ❌       | —       | —                                                                                              | Authentication ID to use for this action                     |
-| ↳ `inputs`           | `object` | ❌       | —       | —                                                                                              | Current input values that may affect available choices       |
-| ↳ `page`             | `number` | ❌       | —       | —                                                                                              | Page number for paginated results                            |
-| ↳ `pageSize`         | `number` | ❌       | —       | —                                                                                              | Number of choices per page                                   |
-| ↳ `maxItems`         | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages               |
+| Name                 | Type     | Required | Default | Possible Values                                                                                | Description                                            |
+| -------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
+| `options`            | `object` | ✅       | —       | —                                                                                              |                                                        |
+| ↳ `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                                  |
+| ↳ `inputFieldKey`    | `string` | ✅       | —       | —                                                                                              | Input field key to get choices for.                    |
+| ↳ `authenticationId` | `string` | ❌       | —       | —                                                                                              | Authentication ID to use for this action               |
+| ↳ `inputs`           | `object` | ❌       | —       | —                                                                                              | Current input values that may affect available choices |
+| ↳ `page`             | `number` | ❌       | —       | —                                                                                              | Page number for paginated results                      |
+| ↳ `pageSize`         | `number` | ❌       | —       | —                                                                                              | Number of choices per page                             |
+| ↳ `maxItems`         | `number` | ❌       | —       | —                                                                                              | Maximum total items to return across all pages         |
 
 **Returns:** `Promise<PaginatedResult<InputFieldChoiceItem>>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.listInputFieldChoices({
-  options: "example-value",
+// Get first page and a cursor for the second page
+const { data: inputFieldChoices, nextCursor } = await sdk.listInputFieldChoices(
+  {
+    appKey: "example-key",
+    actionType: "read",
+    actionKey: "example-key",
+    inputFieldKey: "example-key",
+  },
+);
+
+// Or iterate over all pages
+for await (const page of sdk.listInputFieldChoices({
   appKey: "example-key",
   actionType: "read",
   actionKey: "example-key",
   inputFieldKey: "example-key",
-});
+})) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const inputFieldChoice of sdk
+  .listInputFieldChoices({
+    appKey: "example-key",
+    actionType: "read",
+    actionKey: "example-key",
+    inputFieldKey: "example-key",
+  })
+  .items()) {
+  // Do something with each inputFieldChoice
+}
 ```
 
 #### `listInputFields`
@@ -171,7 +268,7 @@ Get the input fields required for a specific action
 
 | Name                 | Type     | Required | Default | Possible Values                                                                                | Description                                           |
 | -------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------- |
-| `options`            | `string` | ✅       | —       | —                                                                                              | Get the input fields required for a specific action   |
+| `options`            | `object` | ✅       | —       | —                                                                                              |                                                       |
 | ↳ `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                                 |
@@ -185,12 +282,32 @@ Get the input fields required for a specific action
 **Example:**
 
 ```typescript
-const result = await sdk.listInputFields({
-  options: "example-value",
+// Get first page and a cursor for the second page
+const { data: rootFieldItems, nextCursor } = await sdk.listInputFields({
   appKey: "example-key",
   actionType: "read",
   actionKey: "example-key",
 });
+
+// Or iterate over all pages
+for await (const page of sdk.listInputFields({
+  appKey: "example-key",
+  actionType: "read",
+  actionKey: "example-key",
+})) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const rootFieldItem of sdk
+  .listInputFields({
+    appKey: "example-key",
+    actionType: "read",
+    actionKey: "example-key",
+  })
+  .items()) {
+  // Do something with each rootFieldItem
+}
 ```
 
 #### `runAction`
@@ -201,7 +318,7 @@ Execute an action with the given inputs
 
 | Name                 | Type     | Required | Default | Possible Values                                                                                | Description                                        |
 | -------------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------- |
-| `options`            | `string` | ✅       | —       | —                                                                                              | Execute an action with the given inputs            |
+| `options`            | `object` | ✅       | —       | —                                                                                              |                                                    |
 | ↳ `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                              |
@@ -215,16 +332,91 @@ Execute an action with the given inputs
 **Example:**
 
 ```typescript
-const result = await sdk.runAction({
-  options: "example-value",
+// Get first page and a cursor for the second page
+const { data: actionResults, nextCursor } = await sdk.runAction({
   appKey: "example-key",
   actionType: "read",
   actionKey: "example-key",
 });
+
+// Or iterate over all pages
+for await (const page of sdk.runAction({
+  appKey: "example-key",
+  actionType: "read",
+  actionKey: "example-key",
+})) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const actionResult of sdk
+  .runAction({
+    appKey: "example-key",
+    actionType: "read",
+    actionKey: "example-key",
+  })
+  .items()) {
+  // Do something with each actionResult
+}
 ```
 
 ### Apps
 
+#### `apps.{appKey}`
+
+Bind an authentication ID to an app
+
+**Parameters:**
+
+| Name                 | Type     | Required | Default | Possible Values | Description |
+| -------------------- | -------- | -------- | ------- | --------------- | ----------- |
+| `options`            | `object` | ✅       | —       | —               |             |
+| ↳ `authenticationId` | `number` | ✅       | —       | —               |             |
+
+**Returns:** `Promise<AppProxy>`
+
+**Example:**
+
+```typescript
+const result = await sdk.apps.appKey({
+  authenticationId: 12345,
+});
+```
+
+#### `apps.{appKey}.{actionType}.{actionKey}`
+
+Execute an action with the given inputs for the bound app, as an alternative to runAction
+
+**Parameters:**
+
+| Name                 | Type     | Required | Default | Possible Values | Description |
+| -------------------- | -------- | -------- | ------- | --------------- | ----------- |
+| `options`            | `object` | ✅       | —       | —               |             |
+| ↳ `inputs`           | `object` | ❌       | —       | —               |             |
+| ↳ `authenticationId` | `number` | ❌       | —       | —               |             |
+
+**Returns:** `Promise<PaginatedResult<ActionResultItem>>`
+
+**Example:**
+
+```typescript
+// Get first page and a cursor for the second page
+const { data: actionResults, nextCursor } =
+  await sdk.apps.appKey.actionType.actionKey();
+
+// Or iterate over all pages
+for await (const page of sdk.apps.appKey.actionType.actionKey()) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const actionResult of sdk.apps.appKey.actionType
+  .actionKey()
+  .items()) {
+  // Do something with each actionResult
+}
+```
+
 #### `getApp`
 
 Get detailed information about a specific app
@@ -233,7 +425,7 @@ Get detailed information about a specific app
 
 | Name       | Type     | Required | Default | Possible Values | Description                                   |
 | ---------- | -------- | -------- | ------- | --------------- | --------------------------------------------- |
-| `options`  | `string` | ✅       | —       | —               | Get detailed information about a specific app |
+| `options`  | `object` | ✅       | —       | —               |                                               |
 | ↳ `appKey` | `string` | ✅       | —       | —               | App key of app to fetch (e.g., 'SlackCLIAPI') |
 
 **Returns:** `Promise<AppItem>`
@@ -241,8 +433,7 @@ Get detailed information about a specific app
 **Example:**
 
 ```typescript
-const result = await sdk.getApp({
-  options: "example-value",
+const { data: app } = await sdk.getApp({
   appKey: "example-key",
 });
 ```
@@ -255,7 +446,7 @@ List all available apps with optional filtering
 
 | Name         | Type     | Required | Default | Possible Values | Description                                                         |
 | ------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
-| `options`    | `string` | ✅       | —       | —               | List all available apps with optional filtering                     |
+| `options`    | `object` | ✅       | —       | —               |                                                                     |
 | ↳ `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                                             |
@@ -266,9 +457,18 @@ List all available apps with optional filtering
 **Example:**
 
 ```typescript
-const result = await sdk.listApps({
-  options: "example-value",
-});
+// Get first page and a cursor for the second page
+const { data: apps, nextCursor } = await sdk.listApps();
+
+// Or iterate over all pages
+for await (const page of sdk.listApps()) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const app of sdk.listApps().items()) {
+  // Do something with each app
+}
 ```
 
 ### Authentications
@@ -281,7 +481,7 @@ Find the first authentication matching the criteria
 
 | Name          | Type     | Required | Default | Possible Values | Description                                             |
 | ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------- |
-| `options`     | `string` | ✅       | —       | —               | Find the first authentication matching the criteria     |
+| `options`     | `object` | ✅       | —       | —               |                                                         |
 | ↳ `appKey`    | `string` | ❌       | —       | —               | App key of authentication to find (e.g., 'SlackCLIAPI') |
 | ↳ `search`    | `string` | ❌       | —       | —               | Search term to filter authentications by title          |
 | ↳ `title`     | `string` | ❌       | —       | —               | Filter authentications by exact title match             |
@@ -293,9 +493,7 @@ Find the first authentication matching the criteria
 **Example:**
 
 ```typescript
-const result = await sdk.findFirstAuthentication({
-  options: "example-value",
-});
+const { data: authentication } = await sdk.findFirstAuthentication();
 ```
 
 #### `findUniqueAuthentication`
@@ -306,7 +504,7 @@ Find a unique authentication matching the criteria
 
 | Name          | Type     | Required | Default | Possible Values | Description                                             |
 | ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------- |
-| `options`     | `string` | ✅       | —       | —               | Find a unique authentication matching the criteria      |
+| `options`     | `object` | ✅       | —       | —               |                                                         |
 | ↳ `appKey`    | `string` | ❌       | —       | —               | App key of authentication to find (e.g., 'SlackCLIAPI') |
 | ↳ `search`    | `string` | ❌       | —       | —               | Search term to filter authentications by title          |
 | ↳ `title`     | `string` | ❌       | —       | —               | Filter authentications by exact title match             |
@@ -318,9 +516,7 @@ Find a unique authentication matching the criteria
 **Example:**
 
 ```typescript
-const result = await sdk.findUniqueAuthentication({
-  options: "example-value",
-});
+const { data: authentication } = await sdk.findUniqueAuthentication();
 ```
 
 #### `getAuthentication`
@@ -329,18 +525,17 @@ Get a specific authentication by ID
 
 **Parameters:**
 
-| Name                 | Type     | Required | Default | Possible Values | Description                         |
-| -------------------- | -------- | -------- | ------- | --------------- | ----------------------------------- |
-| `options`            | `string` | ✅       | —       | —               | Get a specific authentication by ID |
-| ↳ `authenticationId` | `number` | ✅       | —       | —               | Authentication ID to retrieve       |
+| Name                 | Type     | Required | Default | Possible Values | Description                   |
+| -------------------- | -------- | -------- | ------- | --------------- | ----------------------------- |
+| `options`            | `object` | ✅       | —       | —               |                               |
+| ↳ `authenticationId` | `number` | ✅       | —       | —               | Authentication ID to retrieve |
 
 **Returns:** `Promise<AuthenticationItem>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.getAuthentication({
-  options: "example-value",
+const { data: authentication } = await sdk.getAuthentication({
   authenticationId: 12345,
 });
 ```
@@ -351,26 +546,35 @@ List available authentications with optional filtering
 
 **Parameters:**
 
-| Name                  | Type     | Required | Default | Possible Values | Description                                              |
-| --------------------- | -------- | -------- | ------- | --------------- | -------------------------------------------------------- |
-| `options`             | `string` | ✅       | —       | —               | List available authentications with optional filtering   |
-| ↳ `appKey`            | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI') |
-| ↳ `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              |
-| ↳ `accountId`         | `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                                                              |
+| --------------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------ |
+| `options`             | `object` | ✅       | —       | —               |                                                                          |
+| ↳ `appKey`            | `string` | ❌       | —       | —               | App key of authentications to list (e.g., 'SlackCLIAPI')                 |
+| ↳ `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                              |
+| ↳ `accountId`         | `string` | ❌       | —       | —               | Filter 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                           |
 
 **Returns:** `Promise<PaginatedResult<AuthenticationItem>>`
 
 **Example:**
 
 ```typescript
-const result = await sdk.listAuthentications({
-  options: "example-value",
-});
+// Get first page and a cursor for the second page
+const { data: authentications, nextCursor } = await sdk.listAuthentications();
+
+// Or iterate over all pages
+for await (const page of sdk.listAuthentications()) {
+  // Do something with each page
+}
+
+// Or iterate over individual items across all pages
+for await (const authentication of sdk.listAuthentications().items()) {
+  // Do something with each authentication
+}
 ```
 
 ### HTTP Requests
@@ -384,7 +588,7 @@ Execute fetch
 | Name                       | Type     | Required | Default | Possible Values                                            | Description                                                          |
 | -------------------------- | -------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
 | `url`                      | `string` | ✅       | —       | —                                                          | The URL to fetch                                                     |
-| `init`                     | `string` | ❌       | —       | —                                                          | Fetch options including authentication                               |
+| `init`                     | `object` | ❌       | —       | —                                                          | Fetch options including authentication                               |
 | ↳ `method`                 | `string` | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` |                                                                      |
 | ↳ `headers`                | `object` | ❌       | —       | —                                                          |                                                                      |
 | ↳ `body`                   | `string` | ❌       | —       | —                                                          |                                                                      |
@@ -397,7 +601,7 @@ Execute fetch
 **Example:**
 
 ```typescript
-const result = await sdk.fetch("https://example.com");
+const result = await sdk.fetch("https://example.com", { key: "value" });
 ```
 
 #### `request`
@@ -408,7 +612,7 @@ Make authenticated HTTP requests through Zapier's Relay service
 
 | Name                       | Type     | Required | Default | Possible Values                                            | Description                                                          |
 | -------------------------- | -------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------------------------- |
-| `options`                  | `string` | ✅       | —       | —                                                          | Make authenticated HTTP requests through Zapier's Relay service      |
+| `options`                  | `object` | ✅       | —       | —                                                          |                                                                      |
 | ↳ `url`                    | `string` | ✅       | —       | —                                                          | The URL to request (will be proxied through Relay)                   |
 | ↳ `method`                 | `string` | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method                                                          |
 | ↳ `body`                   | `string` | ❌       | —       | —                                                          | Request body as a string                                             |
@@ -424,7 +628,6 @@ Make authenticated HTTP requests through Zapier's Relay service
 
 ```typescript
 const result = await sdk.request({
-  options: "example-value",
   url: "https://example.com",
 });
 ```