@zapier/zapier-sdk 0.39.0 → 0.40.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @zapier/zapier-sdk
 
+## 0.40.0
+
+### Minor Changes
+
+- 39e296a: Removing Id or Key suffixes from parameter names to make them flexible to be ID, key, name, alias, etc.
+
+## 0.39.1
+
+### Patch Changes
+
+- b4c0560: Accept UUID authentication IDs without coercion. Stop coercing authentication IDs to numbers, allowing UUIDs and other string identifiers to pass through unchanged. Update Zod schemas to accept string or number for authentication_id fields.
+
 ## 0.39.0
 
 ### Minor Changes

package/CLAUDE.md

@@ -17,7 +17,7 @@ The SDK uses a **plugin-based architecture** where functionality is composed fro
 const zapier = createZapierSdk();
 
 // Methods return wrapped responses
-const { data: app } = await zapier.getApp({ appKey: "slack" });
+const { data: app } = await zapier.getApp({ app: "slack" });
 const { data: apps, nextCursor } = await zapier.listApps();
 ```
 
@@ -140,17 +140,17 @@ The `zapier.apps` proxy provides a type-safe, fluent way to execute actions. Thi
 ```typescript
 // Pattern: zapier.apps.{appKey}.{actionType}.{actionKey}(options)
 const { data: channels } = await zapier.apps.slack.read.channels({
-  connectionId: "123",
+  connection: "123",
 });
 ```
 
 ### Binding Connection
 
-Instead of passing `connectionId` to every call, bind it once:
+Instead of passing `connection` to every call, bind it once:
 
 ```typescript
 // Create a bound app instance
-const mySlack = zapier.apps.slack({ connectionId: "123" });
+const mySlack = zapier.apps.slack({ connection: "123" });
 
 // Now all calls use that auth
 const { data: channels } = await mySlack.read.channels({});
@@ -186,7 +186,7 @@ const { data: results } = await zapier.listApps({ search: "google sheets" });
 // Results show all valid keys: "Google Sheets (GoogleSheetsV2CLIAPI, google-sheets, google_sheets)"
 
 // Get specific app details
-const { data: app } = await zapier.getApp({ appKey: "slack" });
+const { data: app } = await zapier.getApp({ app: "slack" });
 ```
 
 ### The Manifest (`.zapierrc`)
@@ -221,7 +221,7 @@ After generation, the apps proxy becomes fully typed:
 // - Input field names and types
 // - Output field types
 const { data } = await zapier.apps.slack.write.send_message({
-  connectionId: "123",
+  connection: "123",
   inputs: {
     channel: "#general", // TypeScript knows this field exists
     text: "Hello!",
@@ -269,24 +269,22 @@ await slack.read.channels({});
 
 // Lower-level API
 await zapier.runAction({
-  appKey: "slack",
+  app: "slack",
   actionType: "read",
-  actionKey: "channels",
+  action: "channels",
   connection: "slack_work",
 });
 
-// Direct connectionId also works
+// Direct numeric connection ID also works
 await zapier.apps.slack.read.channels({ connection: 12345 });
 ```
 
 ### Resolution Precedence
 
-For `connectionId`: explicit `connectionId` > `connection` alias lookup (strings) or direct use (numbers) > factory binding > deprecated `authenticationId`.
+For `connection`: explicit value > factory binding. String values are resolved from the connections map; numeric values are used directly as connection IDs. `connectionId` and `authenticationId` are deprecated aliases for `connection`.
 
 App version is always resolved from the `.zapierrc` manifest, not from connections.
 
-`connectionId` and `connection` are mutually exclusive in the same call.
-
 ## Error Handling
 
 ### Debugging
@@ -306,9 +304,9 @@ DEBUG=zapier:* node your-script.js
 ### Common Errors
 
 - **"No credentials provided"**: Run `npx zapier-sdk login` or provide credentials explicitly
-- **"Connection not found"**: The `connectionId` doesn't exist or you don't have access
+- **"Connection not found"**: The `connection` doesn't exist or you don't have access
 - **"App not found"**: Check the app key using `listApps({ search: "..." })`
-- **"Action not found"**: Verify the action type and key with `listActions({ appKey: "..." })`
+- **"Action not found"**: Verify the action type and key with `listActions({ app: "..." })`
 
 ## Environment Variables