@zapier/zapier-sdk 0.29.0 → 0.31.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk
 
+## 0.31.0
+
+### Minor Changes
+
+- 4a874c6: Add Zod schema for base SDK options, autodoc generation for SDK factory options and CLI base command options
+
+## 0.30.0
+
+### Minor Changes
+
+- 0055854: Remove internal `_telemetry` property from all method option types
+
 ## 0.29.0
 
 ### Minor Changes

package/README.md

@@ -6,6 +6,7 @@
 - [Documentation](#documentation)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
+- [Factory](#factory)
 - [Available Functions](#available-functions)
 - [Accounts](#accounts)
   - [`getProfile`](#getprofile)
@@ -289,6 +290,19 @@ const emojiData = await emojiResponse.json();
 console.log(emojiData.emoji);
 ```
 
+## Factory
+
+The `createZapierSdk(...)` factory function is the main entry point for the SDK. It provides methods for managing connections, listing apps, running actions, and more.
+
+| Name                     | Type                       | Required | Default | Possible Values | Description                                                                                                                                                                                   |
+| ------------------------ | -------------------------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `credentials`            | `string, object, function` | ❌       | —       | —               | Authentication credentials. Can be a string (token or API key), a client credentials object ({ clientId, clientSecret }), a PKCE object ({ clientId }), or a function returning any of those. |
+| `debug`                  | `boolean`                  | ❌       | —       | —               | Enable debug logging.                                                                                                                                                                         |
+| `baseUrl`                | `string`                   | ❌       | —       | —               | Base URL for Zapier API endpoints.                                                                                                                                                            |
+| `trackingBaseUrl`        | `string`                   | ❌       | —       | —               | Base URL for Zapier tracking endpoints.                                                                                                                                                       |
+| `maxNetworkRetries`      | `number`                   | ❌       | —       | —               | Max retries for rate-limited requests (default: 3).                                                                                                                                           |
+| `maxNetworkRetryDelayMs` | `number`                   | ❌       | —       | —               | Max delay in ms to wait for retry (default: 60000).                                                                                                                                           |
+
 ## Available Functions
 
 ### Accounts
@@ -872,15 +886,15 @@ Make authenticated HTTP requests to any API through Zapier. Pass a connectionId
 
 **Parameters:**
 
-| Name             | Type                             | Required | Default | Possible Values                                            | Description                                                                                         |
-| ---------------- | -------------------------------- | -------- | ------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
-| `url`            | `string, custom`                 | ✅       | —       | —                                                          | The full URL of the API endpoint to call (proxied through Zapier's Relay service)                   |
-| `init`           | `object`                         | ❌       | —       | —                                                          | Request options including method, headers, body, and authentication                                 |
-| ↳ `method`       | `string`                         | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET)                                                       |
-| ↳ `headers`      | `object`                         | ❌       | —       | —                                                          | HTTP headers to include in the request                                                              |
-| ↳ `body`         | `string, custom, custom, record` | ❌       | —       | —                                                          | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
-| ↳ `connectionId` | `string, number`                 | ❌       | —       | —                                                          | Connection ID to use for this action                                                                |
-| ↳ `callbackUrl`  | `string`                         | ❌       | —       | —                                                          | URL to send async response to (makes request async)                                                 |
+| Name             | Type                     | Required | Default | Possible Values                                            | Description                                                                                         |
+| ---------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| `url`            | `string, custom`         | ✅       | —       | —                                                          | The full URL of the API endpoint to call (proxied through Zapier's Relay service)                   |
+| `init`           | `object`                 | ❌       | —       | —                                                          | Request options including method, headers, body, and authentication                                 |
+| ↳ `method`       | `string`                 | ❌       | —       | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET)                                                       |
+| ↳ `headers`      | `object`                 | ❌       | —       | —                                                          | HTTP headers to include in the request                                                              |
+| ↳ `body`         | `string, custom, record` | ❌       | —       | —                                                          | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
+| ↳ `connectionId` | `string, number`         | ❌       | —       | —                                                          | Connection ID to use for this action                                                                |
+| ↳ `callbackUrl`  | `string`                 | ❌       | —       | —                                                          | URL to send async response to (makes request async)                                                 |
 
 **Returns:** `Promise<Response>`
 

package/dist/api/schemas.d.ts

@@ -42,8 +42,8 @@ export declare const NeedSchema: z.ZodObject<{
     type: z.ZodOptional<z.ZodEnum<{
         string: "string";
         boolean: "boolean";
-        filter: "filter";
         file: "file";
+        filter: "filter";
         integer: "integer";
         text: "text";
         datetime: "datetime";
@@ -286,8 +286,8 @@ export declare const NeedsResponseSchema: z.ZodObject<{
         type: z.ZodOptional<z.ZodEnum<{
             string: "string";
             boolean: "boolean";
-            filter: "filter";
             file: "file";
+            filter: "filter";
             integer: "integer";
             text: "text";
             datetime: "datetime";