@zapier/zapier-sdk 0.84.3 → 0.85.0

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 (14) hide show
  1. package/AGENTS.md +3 -1
  2. package/CHANGELOG.md +12 -0
  3. package/README.md +205 -177
  4. package/dist/experimental.cjs +31 -33
  5. package/dist/experimental.d.mts +26 -2
  6. package/dist/experimental.d.ts +26 -2
  7. package/dist/experimental.mjs +31 -33
  8. package/dist/{index-B6Hbs-2p.d.mts → index-BxgeAXDh.d.mts} +67 -12
  9. package/dist/{index-B6Hbs-2p.d.ts → index-BxgeAXDh.d.ts} +67 -12
  10. package/dist/index.cjs +31 -33
  11. package/dist/index.d.mts +1 -1
  12. package/dist/index.d.ts +1 -1
  13. package/dist/index.mjs +31 -33
  14. package/package.json +3 -3
package/README.md CHANGED
@@ -215,9 +215,9 @@ console.log({
215
215
  secondPageApps,
216
216
  });
217
217
 
218
- // List methods also return an iterable for all pages.
218
+ // Use `.pages()` to iterate over all pages.
219
219
  // Be careful with lots of pages, note the `search` to filter.
220
- for await (const page of zapier.listApps({ search: "slack" })) {
220
+ for await (const page of zapier.listApps({ search: "slack" }).pages()) {
221
221
  const { data: apps } = page;
222
222
  console.log({
223
223
  apps,
@@ -569,12 +569,14 @@ const { data: inputFieldChoices, nextCursor } =
569
569
  });
570
570
 
571
571
  // Or iterate over all pages
572
- for await (const page of zapier.listActionInputFieldChoices({
573
- app: "example-app",
574
- actionType: "read",
575
- action: "example-action",
576
- inputField: "example-input-field",
577
- })) {
572
+ for await (const page of zapier
573
+ .listActionInputFieldChoices({
574
+ app: "example-app",
575
+ actionType: "read",
576
+ action: "example-action",
577
+ inputField: "example-input-field",
578
+ })
579
+ .pages()) {
578
580
  // Do something with each page
579
581
  }
580
582
 
@@ -663,11 +665,13 @@ const { data: rootFields, nextCursor } = await zapier.listActionInputFields({
663
665
  });
664
666
 
665
667
  // Or iterate over all pages
666
- for await (const page of zapier.listActionInputFields({
667
- app: "example-app",
668
- actionType: "read",
669
- action: "example-action",
670
- })) {
668
+ for await (const page of zapier
669
+ .listActionInputFields({
670
+ app: "example-app",
671
+ actionType: "read",
672
+ action: "example-action",
673
+ })
674
+ .pages()) {
671
675
  // Do something with each page
672
676
  }
673
677
 
@@ -724,9 +728,11 @@ const { data: actions, nextCursor } = await zapier.listActions({
724
728
  });
725
729
 
726
730
  // Or iterate over all pages
727
- for await (const page of zapier.listActions({
728
- app: "example-app",
729
- })) {
731
+ for await (const page of zapier
732
+ .listActions({
733
+ app: "example-app",
734
+ })
735
+ .pages()) {
730
736
  // Do something with each page
731
737
  }
732
738
 
@@ -772,11 +778,13 @@ const { data: actionResults, nextCursor } = await zapier.runAction({
772
778
  });
773
779
 
774
780
  // Or iterate over all pages
775
- for await (const page of zapier.runAction({
776
- app: "example-app",
777
- actionType: "read",
778
- action: "example-action",
779
- })) {
781
+ for await (const page of zapier
782
+ .runAction({
783
+ app: "example-app",
784
+ actionType: "read",
785
+ action: "example-action",
786
+ })
787
+ .pages()) {
780
788
  // Do something with each page
781
789
  }
782
790
 
@@ -836,7 +844,7 @@ const { data: actionResults, nextCursor } =
836
844
  await zapier.apps.appKey.actionType.actionKey();
837
845
 
838
846
  // Or iterate over all pages
839
- for await (const page of zapier.apps.appKey.actionType.actionKey()) {
847
+ for await (const page of zapier.apps.appKey.actionType.actionKey().pages()) {
840
848
  // Do something with each page
841
849
  }
842
850
 
@@ -998,7 +1006,7 @@ List all available apps with optional filtering
998
1006
  const { data: apps, nextCursor } = await zapier.listApps();
999
1007
 
1000
1008
  // Or iterate over all pages
1001
- for await (const page of zapier.listApps()) {
1009
+ for await (const page of zapier.listApps().pages()) {
1002
1010
  // Do something with each page
1003
1011
  }
1004
1012
 
@@ -1093,7 +1101,7 @@ const { data: clientCredentials, nextCursor } =
1093
1101
  await zapier.listClientCredentials();
1094
1102
 
1095
1103
  // Or iterate over all pages
1096
- for await (const page of zapier.listClientCredentials()) {
1104
+ for await (const page of zapier.listClientCredentials().pages()) {
1097
1105
  // Do something with each page
1098
1106
  }
1099
1107
 
@@ -1480,7 +1488,7 @@ List run-once durable runs for the authenticated account, newest first
1480
1488
  const { data: durableRuns, nextCursor } = await zapier.listDurableRuns();
1481
1489
 
1482
1490
  // Or iterate over all pages
1483
- for await (const page of zapier.listDurableRuns()) {
1491
+ for await (const page of zapier.listDurableRuns().pages()) {
1484
1492
  // Do something with each page
1485
1493
  }
1486
1494
 
@@ -1529,9 +1537,11 @@ const { data: workflowRuns, nextCursor } = await zapier.listWorkflowRuns({
1529
1537
  });
1530
1538
 
1531
1539
  // Or iterate over all pages
1532
- for await (const page of zapier.listWorkflowRuns({
1533
- workflow: "example-workflow",
1534
- })) {
1540
+ for await (const page of zapier
1541
+ .listWorkflowRuns({
1542
+ workflow: "example-workflow",
1543
+ })
1544
+ .pages()) {
1535
1545
  // Do something with each page
1536
1546
  }
1537
1547
 
@@ -1585,9 +1595,11 @@ const { data: workflowVersions, nextCursor } =
1585
1595
  });
1586
1596
 
1587
1597
  // Or iterate over all pages
1588
- for await (const page of zapier.listWorkflowVersions({
1589
- workflow: "example-workflow",
1590
- })) {
1598
+ for await (const page of zapier
1599
+ .listWorkflowVersions({
1600
+ workflow: "example-workflow",
1601
+ })
1602
+ .pages()) {
1591
1603
  // Do something with each page
1592
1604
  }
1593
1605
 
@@ -1647,7 +1659,7 @@ List all active durable workflows for the authenticated account
1647
1659
  const { data: workflows, nextCursor } = await zapier.listWorkflows();
1648
1660
 
1649
1661
  // Or iterate over all pages
1650
- for await (const page of zapier.listWorkflows()) {
1662
+ for await (const page of zapier.listWorkflows().pages()) {
1651
1663
  // Do something with each page
1652
1664
  }
1653
1665
 
@@ -1863,36 +1875,37 @@ Find the first connection matching the criteria
1863
1875
 
1864
1876
  **Returns:** `Promise<ConnectionItem>`
1865
1877
 
1866
- | Name | Type | Required | Possible Values | Description |
1867
- | ------------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------- |
1868
- | `data` | `object` | ✅ | — | |
1869
- | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1870
- | ​ ↳ `date` | `string` | ✅ | — | Date created |
1871
- | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1872
- | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1873
- | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1874
- | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1875
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1876
- | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1877
- | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1878
- | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1879
- | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1880
- | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1881
- | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1882
- | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1883
- | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1884
- | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1885
- | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1886
- | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1887
- | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1888
- | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1889
- | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1890
- | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1891
- | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1892
- | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1893
- | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1894
- | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1895
- | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1878
+ | Name | Type | Required | Possible Values | Description |
1879
+ | ------------------------------ | --------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
1880
+ | `data` | `object` | ✅ | — | |
1881
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1882
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1883
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1884
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1885
+ | ​ ↳ `slug` | `string` | ❌ | — | Human-readable app slug for this connection's integration (e.g. 'google-sheets'). Null when no slug is registered for the app. |
1886
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1887
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1888
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1889
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1890
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1891
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1892
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1893
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1894
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1895
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1896
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1897
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1898
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1899
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1900
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1901
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1902
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1903
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1904
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1905
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1906
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1907
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1908
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1896
1909
 
1897
1910
  **Example:**
1898
1911
 
@@ -1919,36 +1932,37 @@ Find a unique connection matching the criteria
1919
1932
 
1920
1933
  **Returns:** `Promise<ConnectionItem>`
1921
1934
 
1922
- | Name | Type | Required | Possible Values | Description |
1923
- | ------------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------- |
1924
- | `data` | `object` | ✅ | — | |
1925
- | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1926
- | ​ ↳ `date` | `string` | ✅ | — | Date created |
1927
- | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1928
- | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1929
- | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1930
- | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1931
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1932
- | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1933
- | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1934
- | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1935
- | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1936
- | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1937
- | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1938
- | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1939
- | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1940
- | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1941
- | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1942
- | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1943
- | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1944
- | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1945
- | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1946
- | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1947
- | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1948
- | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1949
- | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1950
- | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1951
- | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1935
+ | Name | Type | Required | Possible Values | Description |
1936
+ | ------------------------------ | --------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
1937
+ | `data` | `object` | ✅ | — | |
1938
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1939
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1940
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1941
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1942
+ | ​ ↳ `slug` | `string` | ❌ | — | Human-readable app slug for this connection's integration (e.g. 'google-sheets'). Null when no slug is registered for the app. |
1943
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1944
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1945
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1946
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1947
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1948
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1949
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1950
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1951
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1952
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1953
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1954
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1955
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1956
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1957
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1958
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1959
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1960
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1961
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1962
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1963
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1964
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1965
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1952
1966
 
1953
1967
  **Example:**
1954
1968
 
@@ -1969,36 +1983,37 @@ Get details for a specific connection
1969
1983
 
1970
1984
  **Returns:** `Promise<ConnectionItem>`
1971
1985
 
1972
- | Name | Type | Required | Possible Values | Description |
1973
- | ------------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------- |
1974
- | `data` | `object` | ✅ | — | |
1975
- | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1976
- | ​ ↳ `date` | `string` | ✅ | — | Date created |
1977
- | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1978
- | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1979
- | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1980
- | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1981
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1982
- | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1983
- | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1984
- | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1985
- | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1986
- | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1987
- | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1988
- | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1989
- | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1990
- | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1991
- | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1992
- | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1993
- | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1994
- | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1995
- | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1996
- | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1997
- | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1998
- | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1999
- | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
2000
- | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
2001
- | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1986
+ | Name | Type | Required | Possible Values | Description |
1987
+ | ------------------------------ | --------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
1988
+ | `data` | `object` | ✅ | — | |
1989
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1990
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1991
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1992
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1993
+ | ​ ↳ `slug` | `string` | ❌ | — | Human-readable app slug for this connection's integration (e.g. 'google-sheets'). Null when no slug is registered for the app. |
1994
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1995
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1996
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1997
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1998
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1999
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
2000
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
2001
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
2002
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
2003
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
2004
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
2005
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
2006
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
2007
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
2008
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
2009
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
2010
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
2011
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
2012
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
2013
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
2014
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
2015
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
2016
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
2002
2017
 
2003
2018
  **Example:**
2004
2019
 
@@ -2072,37 +2087,38 @@ List available connections with optional filtering
2072
2087
 
2073
2088
  **Returns:** `Promise<PaginatedResult<ConnectionItem>>`
2074
2089
 
2075
- | Name | Type | Required | Possible Values | Description |
2076
- | ------------------------------ | ---------- | -------- | --------------- | -------------------------------------------------------------- |
2077
- | `data[]` | `object[]` | ✅ | — | |
2078
- | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
2079
- | ​ ↳ `date` | `string` | ✅ | — | Date created |
2080
- | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
2081
- | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
2082
- | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
2083
- | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
2084
- | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
2085
- | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
2086
- | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
2087
- | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
2088
- | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
2089
- | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
2090
- | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
2091
- | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
2092
- | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
2093
- | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
2094
- | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
2095
- | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
2096
- | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
2097
- | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
2098
- | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
2099
- | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
2100
- | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
2101
- | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
2102
- | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
2103
- | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
2104
- | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
2105
- | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
2090
+ | Name | Type | Required | Possible Values | Description |
2091
+ | ------------------------------ | ---------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------ |
2092
+ | `data[]` | `object[]` | ✅ | — | |
2093
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
2094
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
2095
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
2096
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
2097
+ | ​ ↳ `slug` | `string` | ❌ | — | Human-readable app slug for this connection's integration (e.g. 'google-sheets'). Null when no slug is registered for the app. |
2098
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
2099
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
2100
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
2101
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
2102
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
2103
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
2104
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
2105
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
2106
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
2107
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
2108
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
2109
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
2110
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
2111
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
2112
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
2113
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
2114
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
2115
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
2116
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
2117
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
2118
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
2119
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
2120
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
2121
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
2106
2122
 
2107
2123
  **Example:**
2108
2124
 
@@ -2111,7 +2127,7 @@ List available connections with optional filtering
2111
2127
  const { data: connections, nextCursor } = await zapier.listConnections();
2112
2128
 
2113
2129
  // Or iterate over all pages
2114
- for await (const page of zapier.listConnections()) {
2130
+ for await (const page of zapier.listConnections().pages()) {
2115
2131
  // Do something with each page
2116
2132
  }
2117
2133
 
@@ -2478,9 +2494,11 @@ const { data: fields, nextCursor } = await zapier.listTableFields({
2478
2494
  });
2479
2495
 
2480
2496
  // Or iterate over all pages
2481
- for await (const page of zapier.listTableFields({
2482
- table: "example-table",
2483
- })) {
2497
+ for await (const page of zapier
2498
+ .listTableFields({
2499
+ table: "example-table",
2500
+ })
2501
+ .pages()) {
2484
2502
  // Do something with each page
2485
2503
  }
2486
2504
 
@@ -2538,9 +2556,11 @@ const { data: records, nextCursor } = await zapier.listTableRecords({
2538
2556
  });
2539
2557
 
2540
2558
  // Or iterate over all pages
2541
- for await (const page of zapier.listTableRecords({
2542
- table: "example-table",
2543
- })) {
2559
+ for await (const page of zapier
2560
+ .listTableRecords({
2561
+ table: "example-table",
2562
+ })
2563
+ .pages()) {
2544
2564
  // Do something with each page
2545
2565
  }
2546
2566
 
@@ -2595,7 +2615,7 @@ List tables available to the authenticated user
2595
2615
  const { data: tables, nextCursor } = await zapier.listTables();
2596
2616
 
2597
2617
  // Or iterate over all pages
2598
- for await (const page of zapier.listTables()) {
2618
+ for await (const page of zapier.listTables().pages()) {
2599
2619
  // Do something with each page
2600
2620
  }
2601
2621
 
@@ -2983,9 +3003,11 @@ const { data: triggerMessages, nextCursor } =
2983
3003
  });
2984
3004
 
2985
3005
  // Or iterate over all pages
2986
- for await (const page of zapier.listTriggerInboxMessages({
2987
- inbox: "example-inbox",
2988
- })) {
3006
+ for await (const page of zapier
3007
+ .listTriggerInboxMessages({
3008
+ inbox: "example-inbox",
3009
+ })
3010
+ .pages()) {
2989
3011
  // Do something with each page
2990
3012
  }
2991
3013
 
@@ -3040,7 +3062,7 @@ List all trigger inboxes for the authenticated user
3040
3062
  const { data: triggerInboxs, nextCursor } = await zapier.listTriggerInboxes();
3041
3063
 
3042
3064
  // Or iterate over all pages
3043
- for await (const page of zapier.listTriggerInboxes()) {
3065
+ for await (const page of zapier.listTriggerInboxes().pages()) {
3044
3066
  // Do something with each page
3045
3067
  }
3046
3068
 
@@ -3092,11 +3114,13 @@ const { data: inputFieldChoices, nextCursor } =
3092
3114
  });
3093
3115
 
3094
3116
  // Or iterate over all pages
3095
- for await (const page of zapier.listTriggerInputFieldChoices({
3096
- app: "example-app",
3097
- action: "example-action",
3098
- inputField: "example-input-field",
3099
- })) {
3117
+ for await (const page of zapier
3118
+ .listTriggerInputFieldChoices({
3119
+ app: "example-app",
3120
+ action: "example-action",
3121
+ inputField: "example-input-field",
3122
+ })
3123
+ .pages()) {
3100
3124
  // Do something with each page
3101
3125
  }
3102
3126
 
@@ -3182,10 +3206,12 @@ const { data: rootFields, nextCursor } = await zapier.listTriggerInputFields({
3182
3206
  });
3183
3207
 
3184
3208
  // Or iterate over all pages
3185
- for await (const page of zapier.listTriggerInputFields({
3186
- app: "example-app",
3187
- action: "example-action",
3188
- })) {
3209
+ for await (const page of zapier
3210
+ .listTriggerInputFields({
3211
+ app: "example-app",
3212
+ action: "example-action",
3213
+ })
3214
+ .pages()) {
3189
3215
  // Do something with each page
3190
3216
  }
3191
3217
 
@@ -3240,9 +3266,11 @@ const { data: actions, nextCursor } = await zapier.listTriggers({
3240
3266
  });
3241
3267
 
3242
3268
  // Or iterate over all pages
3243
- for await (const page of zapier.listTriggers({
3244
- app: "example-app",
3245
- })) {
3269
+ for await (const page of zapier
3270
+ .listTriggers({
3271
+ app: "example-app",
3272
+ })
3273
+ .pages()) {
3246
3274
  // Do something with each page
3247
3275
  }
3248
3276