@zapier/zapier-sdk 0.39.1 → 0.40.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.
Files changed (185) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/CLAUDE.md +12 -14
  3. package/README.md +186 -192
  4. package/dist/formatters/tableRecord.js +1 -1
  5. package/dist/index.cjs +642 -348
  6. package/dist/index.d.mts +460 -45
  7. package/dist/index.mjs +633 -349
  8. package/dist/plugins/apps/index.d.ts +1 -1
  9. package/dist/plugins/apps/index.d.ts.map +1 -1
  10. package/dist/plugins/apps/index.js +4 -8
  11. package/dist/plugins/apps/schemas.d.ts +2 -1
  12. package/dist/plugins/apps/schemas.d.ts.map +1 -1
  13. package/dist/plugins/apps/schemas.js +24 -8
  14. package/dist/plugins/fetch/index.d.ts +4 -2
  15. package/dist/plugins/fetch/index.d.ts.map +1 -1
  16. package/dist/plugins/fetch/index.js +0 -1
  17. package/dist/plugins/fetch/schemas.d.ts.map +1 -1
  18. package/dist/plugins/fetch/schemas.js +11 -4
  19. package/dist/plugins/findFirstConnection/index.d.ts.map +1 -1
  20. package/dist/plugins/findFirstConnection/index.js +0 -1
  21. package/dist/plugins/findFirstConnection/schemas.d.ts +4 -1
  22. package/dist/plugins/findFirstConnection/schemas.d.ts.map +1 -1
  23. package/dist/plugins/findFirstConnection/schemas.js +2 -0
  24. package/dist/plugins/findUniqueConnection/index.d.ts.map +1 -1
  25. package/dist/plugins/findUniqueConnection/index.js +0 -1
  26. package/dist/plugins/findUniqueConnection/schemas.d.ts +4 -1
  27. package/dist/plugins/findUniqueConnection/schemas.d.ts.map +1 -1
  28. package/dist/plugins/findUniqueConnection/schemas.js +2 -0
  29. package/dist/plugins/getAction/index.d.ts.map +1 -1
  30. package/dist/plugins/getAction/index.js +8 -6
  31. package/dist/plugins/getAction/schemas.d.ts +58 -1
  32. package/dist/plugins/getAction/schemas.d.ts.map +1 -1
  33. package/dist/plugins/getAction/schemas.js +16 -4
  34. package/dist/plugins/getApp/index.d.ts.map +1 -1
  35. package/dist/plugins/getApp/index.js +6 -5
  36. package/dist/plugins/getApp/schemas.d.ts +19 -1
  37. package/dist/plugins/getApp/schemas.d.ts.map +1 -1
  38. package/dist/plugins/getApp/schemas.js +14 -4
  39. package/dist/plugins/getConnection/index.d.ts.map +1 -1
  40. package/dist/plugins/getConnection/index.js +3 -5
  41. package/dist/plugins/getConnection/schemas.d.ts +1 -0
  42. package/dist/plugins/getConnection/schemas.d.ts.map +1 -1
  43. package/dist/plugins/getConnection/schemas.js +11 -5
  44. package/dist/plugins/getInputFieldsSchema/index.d.ts +2 -1
  45. package/dist/plugins/getInputFieldsSchema/index.d.ts.map +1 -1
  46. package/dist/plugins/getInputFieldsSchema/index.js +18 -12
  47. package/dist/plugins/getInputFieldsSchema/schemas.d.ts +71 -1
  48. package/dist/plugins/getInputFieldsSchema/schemas.d.ts.map +1 -1
  49. package/dist/plugins/getInputFieldsSchema/schemas.js +39 -10
  50. package/dist/plugins/listActions/index.d.ts.map +1 -1
  51. package/dist/plugins/listActions/index.js +5 -4
  52. package/dist/plugins/listActions/schemas.d.ts +58 -1
  53. package/dist/plugins/listActions/schemas.d.ts.map +1 -1
  54. package/dist/plugins/listActions/schemas.js +25 -12
  55. package/dist/plugins/listApps/index.js +1 -1
  56. package/dist/plugins/listApps/schemas.d.ts +1 -0
  57. package/dist/plugins/listApps/schemas.d.ts.map +1 -1
  58. package/dist/plugins/listApps/schemas.js +6 -1
  59. package/dist/plugins/listConnections/index.d.ts +2 -1
  60. package/dist/plugins/listConnections/index.d.ts.map +1 -1
  61. package/dist/plugins/listConnections/index.js +27 -14
  62. package/dist/plugins/listConnections/schemas.d.ts +5 -0
  63. package/dist/plugins/listConnections/schemas.d.ts.map +1 -1
  64. package/dist/plugins/listConnections/schemas.js +22 -9
  65. package/dist/plugins/listInputFieldChoices/index.d.ts +2 -2
  66. package/dist/plugins/listInputFieldChoices/index.d.ts.map +1 -1
  67. package/dist/plugins/listInputFieldChoices/index.js +21 -15
  68. package/dist/plugins/listInputFieldChoices/schemas.d.ts +92 -1
  69. package/dist/plugins/listInputFieldChoices/schemas.d.ts.map +1 -1
  70. package/dist/plugins/listInputFieldChoices/schemas.js +47 -23
  71. package/dist/plugins/listInputFields/index.d.ts +2 -1
  72. package/dist/plugins/listInputFields/index.d.ts.map +1 -1
  73. package/dist/plugins/listInputFields/index.js +18 -13
  74. package/dist/plugins/listInputFields/schemas.d.ts +80 -1
  75. package/dist/plugins/listInputFields/schemas.d.ts.map +1 -1
  76. package/dist/plugins/listInputFields/schemas.js +40 -11
  77. package/dist/plugins/manifest/schemas.d.ts.map +1 -1
  78. package/dist/plugins/manifest/schemas.js +4 -2
  79. package/dist/plugins/registry/index.d.ts.map +1 -1
  80. package/dist/plugins/registry/index.js +0 -1
  81. package/dist/plugins/request/index.d.ts.map +1 -1
  82. package/dist/plugins/request/index.js +2 -5
  83. package/dist/plugins/request/schemas.d.ts +2 -0
  84. package/dist/plugins/request/schemas.d.ts.map +1 -1
  85. package/dist/plugins/request/schemas.js +13 -5
  86. package/dist/plugins/runAction/index.d.ts.map +1 -1
  87. package/dist/plugins/runAction/index.js +17 -15
  88. package/dist/plugins/runAction/schemas.d.ts +83 -2
  89. package/dist/plugins/runAction/schemas.d.ts.map +1 -1
  90. package/dist/plugins/runAction/schemas.js +41 -17
  91. package/dist/plugins/tables/createTableFields/index.d.ts.map +1 -1
  92. package/dist/plugins/tables/createTableFields/index.js +5 -4
  93. package/dist/plugins/tables/createTableFields/schemas.d.ts +127 -1
  94. package/dist/plugins/tables/createTableFields/schemas.d.ts.map +1 -1
  95. package/dist/plugins/tables/createTableFields/schemas.js +25 -5
  96. package/dist/plugins/tables/createTableRecords/index.d.ts.map +1 -1
  97. package/dist/plugins/tables/createTableRecords/index.js +7 -6
  98. package/dist/plugins/tables/createTableRecords/schemas.d.ts +37 -1
  99. package/dist/plugins/tables/createTableRecords/schemas.d.ts.map +1 -1
  100. package/dist/plugins/tables/createTableRecords/schemas.js +27 -7
  101. package/dist/plugins/tables/deleteTable/index.d.ts.map +1 -1
  102. package/dist/plugins/tables/deleteTable/index.js +5 -4
  103. package/dist/plugins/tables/deleteTable/schemas.d.ts +17 -1
  104. package/dist/plugins/tables/deleteTable/schemas.d.ts.map +1 -1
  105. package/dist/plugins/tables/deleteTable/schemas.js +14 -2
  106. package/dist/plugins/tables/deleteTableFields/index.d.ts.map +1 -1
  107. package/dist/plugins/tables/deleteTableFields/index.js +9 -7
  108. package/dist/plugins/tables/deleteTableFields/schemas.d.ts +22 -1
  109. package/dist/plugins/tables/deleteTableFields/schemas.d.ts.map +1 -1
  110. package/dist/plugins/tables/deleteTableFields/schemas.js +18 -2
  111. package/dist/plugins/tables/deleteTableRecords/index.d.ts.map +1 -1
  112. package/dist/plugins/tables/deleteTableRecords/index.js +7 -5
  113. package/dist/plugins/tables/deleteTableRecords/schemas.d.ts +22 -1
  114. package/dist/plugins/tables/deleteTableRecords/schemas.d.ts.map +1 -1
  115. package/dist/plugins/tables/deleteTableRecords/schemas.js +18 -2
  116. package/dist/plugins/tables/getTable/index.d.ts.map +1 -1
  117. package/dist/plugins/tables/getTable/index.js +6 -5
  118. package/dist/plugins/tables/getTable/schemas.d.ts +16 -1
  119. package/dist/plugins/tables/getTable/schemas.d.ts.map +1 -1
  120. package/dist/plugins/tables/getTable/schemas.js +14 -2
  121. package/dist/plugins/tables/getTableRecord/index.d.ts.map +1 -1
  122. package/dist/plugins/tables/getTableRecord/index.js +9 -7
  123. package/dist/plugins/tables/getTableRecord/schemas.d.ts +38 -1
  124. package/dist/plugins/tables/getTableRecord/schemas.d.ts.map +1 -1
  125. package/dist/plugins/tables/getTableRecord/schemas.js +21 -2
  126. package/dist/plugins/tables/listTableFields/index.d.ts.map +1 -1
  127. package/dist/plugins/tables/listTableFields/index.js +10 -8
  128. package/dist/plugins/tables/listTableFields/schemas.d.ts +26 -1
  129. package/dist/plugins/tables/listTableFields/schemas.d.ts.map +1 -1
  130. package/dist/plugins/tables/listTableFields/schemas.js +25 -5
  131. package/dist/plugins/tables/listTableRecords/index.d.ts.map +1 -1
  132. package/dist/plugins/tables/listTableRecords/index.js +7 -6
  133. package/dist/plugins/tables/listTableRecords/schemas.d.ts +118 -1
  134. package/dist/plugins/tables/listTableRecords/schemas.d.ts.map +1 -1
  135. package/dist/plugins/tables/listTableRecords/schemas.js +27 -7
  136. package/dist/plugins/tables/listTables/index.d.ts.map +1 -1
  137. package/dist/plugins/tables/listTables/index.js +3 -2
  138. package/dist/plugins/tables/listTables/schemas.d.ts +5 -1
  139. package/dist/plugins/tables/listTables/schemas.d.ts.map +1 -1
  140. package/dist/plugins/tables/listTables/schemas.js +4 -1
  141. package/dist/plugins/tables/updateTableRecords/index.d.ts.map +1 -1
  142. package/dist/plugins/tables/updateTableRecords/index.js +7 -6
  143. package/dist/plugins/tables/updateTableRecords/schemas.d.ts +40 -1
  144. package/dist/plugins/tables/updateTableRecords/schemas.d.ts.map +1 -1
  145. package/dist/plugins/tables/updateTableRecords/schemas.js +27 -7
  146. package/dist/resolvers/actionKey.d.ts +1 -1
  147. package/dist/resolvers/actionKey.d.ts.map +1 -1
  148. package/dist/resolvers/actionKey.js +3 -3
  149. package/dist/resolvers/actionType.d.ts +1 -1
  150. package/dist/resolvers/actionType.d.ts.map +1 -1
  151. package/dist/resolvers/actionType.js +2 -2
  152. package/dist/resolvers/connectionId.d.ts +1 -1
  153. package/dist/resolvers/connectionId.d.ts.map +1 -1
  154. package/dist/resolvers/connectionId.js +9 -9
  155. package/dist/resolvers/inputFieldKey.d.ts +3 -3
  156. package/dist/resolvers/inputFieldKey.d.ts.map +1 -1
  157. package/dist/resolvers/inputFieldKey.js +6 -6
  158. package/dist/resolvers/inputs.d.ts +3 -3
  159. package/dist/resolvers/inputs.d.ts.map +1 -1
  160. package/dist/resolvers/inputs.js +8 -8
  161. package/dist/resolvers/tableFieldIds.d.ts +1 -1
  162. package/dist/resolvers/tableFieldIds.d.ts.map +1 -1
  163. package/dist/resolvers/tableFieldIds.js +3 -3
  164. package/dist/resolvers/tableFilters.d.ts +1 -1
  165. package/dist/resolvers/tableFilters.d.ts.map +1 -1
  166. package/dist/resolvers/tableFilters.js +4 -4
  167. package/dist/resolvers/tableId.js +1 -1
  168. package/dist/resolvers/tableRecordId.d.ts +2 -2
  169. package/dist/resolvers/tableRecordId.d.ts.map +1 -1
  170. package/dist/resolvers/tableRecordId.js +5 -5
  171. package/dist/resolvers/tableRecords.d.ts +2 -2
  172. package/dist/resolvers/tableRecords.d.ts.map +1 -1
  173. package/dist/resolvers/tableRecords.js +6 -6
  174. package/dist/resolvers/tableSort.d.ts +1 -1
  175. package/dist/resolvers/tableSort.d.ts.map +1 -1
  176. package/dist/resolvers/tableSort.js +2 -2
  177. package/dist/types/properties.d.ts +30 -0
  178. package/dist/types/properties.d.ts.map +1 -1
  179. package/dist/types/properties.js +34 -1
  180. package/dist/types/sdk.d.ts +0 -2
  181. package/dist/types/sdk.d.ts.map +1 -1
  182. package/dist/utils/domain-utils.d.ts +5 -0
  183. package/dist/utils/domain-utils.d.ts.map +1 -1
  184. package/dist/utils/domain-utils.js +17 -3
  185. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @zapier/zapier-sdk
2
2
 
3
+ ## 0.40.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 5391c65: Fix ordering problem with tables CLI commands.
8
+
9
+ ## 0.40.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 39e296a: Removing Id or Key suffixes from parameter names to make them flexible to be ID, key, name, alias, etc.
14
+
3
15
  ## 0.39.1
4
16
 
5
17
  ### Patch Changes
package/CLAUDE.md CHANGED
@@ -17,7 +17,7 @@ The SDK uses a **plugin-based architecture** where functionality is composed fro
17
17
  const zapier = createZapierSdk();
18
18
 
19
19
  // Methods return wrapped responses
20
- const { data: app } = await zapier.getApp({ appKey: "slack" });
20
+ const { data: app } = await zapier.getApp({ app: "slack" });
21
21
  const { data: apps, nextCursor } = await zapier.listApps();
22
22
  ```
23
23
 
@@ -140,17 +140,17 @@ The `zapier.apps` proxy provides a type-safe, fluent way to execute actions. Thi
140
140
  ```typescript
141
141
  // Pattern: zapier.apps.{appKey}.{actionType}.{actionKey}(options)
142
142
  const { data: channels } = await zapier.apps.slack.read.channels({
143
- connectionId: "123",
143
+ connection: "123",
144
144
  });
145
145
  ```
146
146
 
147
147
  ### Binding Connection
148
148
 
149
- Instead of passing `connectionId` to every call, bind it once:
149
+ Instead of passing `connection` to every call, bind it once:
150
150
 
151
151
  ```typescript
152
152
  // Create a bound app instance
153
- const mySlack = zapier.apps.slack({ connectionId: "123" });
153
+ const mySlack = zapier.apps.slack({ connection: "123" });
154
154
 
155
155
  // Now all calls use that auth
156
156
  const { data: channels } = await mySlack.read.channels({});
@@ -186,7 +186,7 @@ const { data: results } = await zapier.listApps({ search: "google sheets" });
186
186
  // Results show all valid keys: "Google Sheets (GoogleSheetsV2CLIAPI, google-sheets, google_sheets)"
187
187
 
188
188
  // Get specific app details
189
- const { data: app } = await zapier.getApp({ appKey: "slack" });
189
+ const { data: app } = await zapier.getApp({ app: "slack" });
190
190
  ```
191
191
 
192
192
  ### The Manifest (`.zapierrc`)
@@ -221,7 +221,7 @@ After generation, the apps proxy becomes fully typed:
221
221
  // - Input field names and types
222
222
  // - Output field types
223
223
  const { data } = await zapier.apps.slack.write.send_message({
224
- connectionId: "123",
224
+ connection: "123",
225
225
  inputs: {
226
226
  channel: "#general", // TypeScript knows this field exists
227
227
  text: "Hello!",
@@ -269,24 +269,22 @@ await slack.read.channels({});
269
269
 
270
270
  // Lower-level API
271
271
  await zapier.runAction({
272
- appKey: "slack",
272
+ app: "slack",
273
273
  actionType: "read",
274
- actionKey: "channels",
274
+ action: "channels",
275
275
  connection: "slack_work",
276
276
  });
277
277
 
278
- // Direct connectionId also works
278
+ // Direct numeric connection ID also works
279
279
  await zapier.apps.slack.read.channels({ connection: 12345 });
280
280
  ```
281
281
 
282
282
  ### Resolution Precedence
283
283
 
284
- For `connectionId`: explicit `connectionId` > `connection` alias lookup (strings) or direct use (numbers) > factory binding > deprecated `authenticationId`.
284
+ 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`.
285
285
 
286
286
  App version is always resolved from the `.zapierrc` manifest, not from connections.
287
287
 
288
- `connectionId` and `connection` are mutually exclusive in the same call.
289
-
290
288
  ## Error Handling
291
289
 
292
290
  ### Debugging
@@ -306,9 +304,9 @@ DEBUG=zapier:* node your-script.js
306
304
  ### Common Errors
307
305
 
308
306
  - **"No credentials provided"**: Run `npx zapier-sdk login` or provide credentials explicitly
309
- - **"Connection not found"**: The `connectionId` doesn't exist or you don't have access
307
+ - **"Connection not found"**: The `connection` doesn't exist or you don't have access
310
308
  - **"App not found"**: Check the app key using `listApps({ search: "..." })`
311
- - **"Action not found"**: Verify the action type and key with `listActions({ appKey: "..." })`
309
+ - **"Action not found"**: Verify the action type and key with `listActions({ app: "..." })`
312
310
 
313
311
  ## Environment Variables
314
312