@seamapi/types 1.254.0 → 1.256.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 (26) hide show
  1. package/dist/connect.cjs +273 -63
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1314 -0
  4. package/lib/seam/connect/models/acs/acs-entrance.d.ts +48 -0
  5. package/lib/seam/connect/models/acs/acs-entrance.js +2 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  7. package/lib/seam/connect/models/acs/metadata/salto.d.ts +23 -2
  8. package/lib/seam/connect/models/acs/metadata/salto.js +8 -1
  9. package/lib/seam/connect/models/acs/metadata/salto.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +93 -0
  11. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  12. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  13. package/lib/seam/connect/models/action-attempts/encode-card.d.ts +96 -0
  14. package/lib/seam/connect/models/action-attempts/encode-card.js +36 -0
  15. package/lib/seam/connect/models/action-attempts/encode-card.js.map +1 -0
  16. package/lib/seam/connect/openapi.d.ts +114 -0
  17. package/lib/seam/connect/openapi.js +177 -0
  18. package/lib/seam/connect/openapi.js.map +1 -1
  19. package/lib/seam/connect/route-types.d.ts +1086 -27
  20. package/package.json +1 -1
  21. package/src/lib/seam/connect/models/acs/acs-entrance.ts +2 -0
  22. package/src/lib/seam/connect/models/acs/metadata/salto.ts +10 -3
  23. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  24. package/src/lib/seam/connect/models/action-attempts/encode-card.ts +46 -0
  25. package/src/lib/seam/connect/openapi.ts +179 -0
  26. package/src/lib/seam/connect/route-types.ts +1195 -13
package/dist/connect.cjs CHANGED
@@ -1122,6 +1122,16 @@ var acs_entrance_latch_metadata = zod.z.object({
1122
1122
  door_type: zod.z.string(),
1123
1123
  is_connected: zod.z.boolean()
1124
1124
  });
1125
+ var acs_entrance_salto_ks_metadata = zod.z.object({
1126
+ door_name: zod.z.string(),
1127
+ locked_state: zod.z.string(),
1128
+ lock_type: zod.z.string(),
1129
+ online: zod.z.boolean(),
1130
+ battery_level: zod.z.string(),
1131
+ left_open_alarm: zod.z.boolean(),
1132
+ intrusion_alarm: zod.z.boolean(),
1133
+ privacy_mode: zod.z.boolean()
1134
+ });
1125
1135
  var acs_entrance_visionline_metadata = zod.z.object({
1126
1136
  door_name: zod.z.string(),
1127
1137
  door_category: zod.z.enum([
@@ -1218,7 +1228,8 @@ var acs_entrance = zod.z.object({
1218
1228
  })
1219
1229
  ),
1220
1230
  latch_metadata: acs_entrance_latch_metadata.optional(),
1221
- visionline_metadata: acs_entrance_visionline_metadata.optional()
1231
+ visionline_metadata: acs_entrance_visionline_metadata.optional(),
1232
+ salto_ks_metadata: acs_entrance_salto_ks_metadata.optional()
1222
1233
  });
1223
1234
  var acs_system_capability_flags = zod.z.object({
1224
1235
  can_automate_enrollment: zod.z.boolean().optional().describe(
@@ -1652,163 +1663,184 @@ var deprecated_action_attempts = [
1652
1663
  ...delete_noise_threshold_action_attempt.options,
1653
1664
  ...update_noise_threshold_action_attempt.options
1654
1665
  ];
1655
- var action_type2 = zod.z.literal("LOCK_DOOR");
1666
+ var action_type2 = zod.z.literal("ENCODE_CARD");
1656
1667
  var error3 = zod.z.object({
1657
1668
  type: zod.z.string(),
1669
+ // TODO This should be typed properly with the possible errors
1658
1670
  message: zod.z.string()
1659
1671
  });
1660
- var result3 = zod.z.object({});
1661
- var lock_door_action_attempt = zod.z.discriminatedUnion("status", [
1672
+ var result3 = zod.z.object({
1673
+ acs_credential_id: zod.z.string().uuid().nullable().describe("Matching acs_credential currently encoded on this card."),
1674
+ card_number: zod.z.string().nullable().describe("A number or sting that physically identifies this card.")
1675
+ // TODO visionline_metadata: visionline_credential_metadata,
1676
+ });
1677
+ var encode_card_action_attempt = zod.z.discriminatedUnion("status", [
1662
1678
  common_pending_action_attempt.extend({
1663
1679
  action_type: action_type2
1664
- }).describe("Locking door."),
1680
+ }).describe("Encoding card data from physical encoder."),
1665
1681
  common_succeeded_action_attempt.extend({
1666
1682
  action_type: action_type2,
1667
1683
  result: result3
1668
- }).describe("Locking door succeeded."),
1669
- common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Locking door failed.")
1684
+ }).describe("Encoding card data from physical encoder succeeded."),
1685
+ common_failed_action_attempt.extend({ action_type: action_type2, error: error3 }).describe("Encoding card data from physical encoder failed.")
1670
1686
  ]);
1671
- var action_type3 = zod.z.literal("READ_CARD");
1687
+ var action_type3 = zod.z.literal("LOCK_DOOR");
1672
1688
  var error4 = zod.z.object({
1689
+ type: zod.z.string(),
1690
+ message: zod.z.string()
1691
+ });
1692
+ var result4 = zod.z.object({});
1693
+ var lock_door_action_attempt = zod.z.discriminatedUnion("status", [
1694
+ common_pending_action_attempt.extend({
1695
+ action_type: action_type3
1696
+ }).describe("Locking door."),
1697
+ common_succeeded_action_attempt.extend({
1698
+ action_type: action_type3,
1699
+ result: result4
1700
+ }).describe("Locking door succeeded."),
1701
+ common_failed_action_attempt.extend({ action_type: action_type3, error: error4 }).describe("Locking door failed.")
1702
+ ]);
1703
+ var action_type4 = zod.z.literal("READ_CARD");
1704
+ var error5 = zod.z.object({
1673
1705
  type: zod.z.string(),
1674
1706
  // TODO This should be typed properly with the possible errors
1675
1707
  message: zod.z.string()
1676
1708
  });
1677
- var result4 = zod.z.object({
1709
+ var result5 = zod.z.object({
1678
1710
  acs_credential_id: zod.z.string().uuid().nullable().describe("Matching acs_credential currently encoded on this card."),
1679
1711
  card_number: zod.z.string().nullable().describe("A number or sting that physically identifies this card.")
1680
1712
  // TODO visionline_metadata: visionline_credential_metadata,
1681
1713
  });
1682
1714
  var read_card_action_attempt = zod.z.discriminatedUnion("status", [
1683
1715
  common_pending_action_attempt.extend({
1684
- action_type: action_type3
1716
+ action_type: action_type4
1685
1717
  }).describe("Reading card data from physical encoder."),
1686
1718
  common_succeeded_action_attempt.extend({
1687
- action_type: action_type3,
1688
- result: result4
1719
+ action_type: action_type4,
1720
+ result: result5
1689
1721
  }).describe("Reading card data from physical encoder succeeded."),
1690
- common_failed_action_attempt.extend({ action_type: action_type3, error: error4 }).describe("Reading card data from physical encoder failed.")
1722
+ common_failed_action_attempt.extend({ action_type: action_type4, error: error5 }).describe("Reading card data from physical encoder failed.")
1691
1723
  ]);
1692
- var action_type4 = zod.z.literal("RESET_SANDBOX_WORKSPACE");
1693
- var error5 = zod.z.object({
1724
+ var action_type5 = zod.z.literal("RESET_SANDBOX_WORKSPACE");
1725
+ var error6 = zod.z.object({
1694
1726
  type: zod.z.string(),
1695
1727
  message: zod.z.string()
1696
1728
  });
1697
- var result5 = zod.z.object({});
1729
+ var result6 = zod.z.object({});
1698
1730
  var reset_sandbox_workspace_action_attempt = zod.z.discriminatedUnion(
1699
1731
  "status",
1700
1732
  [
1701
1733
  common_pending_action_attempt.extend({
1702
- action_type: action_type4
1734
+ action_type: action_type5
1703
1735
  }).describe("Resetting sandbox workspace."),
1704
1736
  common_succeeded_action_attempt.extend({
1705
- action_type: action_type4,
1706
- result: result5
1737
+ action_type: action_type5,
1738
+ result: result6
1707
1739
  }).describe("Resetting sandbox workspace succeeded."),
1708
1740
  common_failed_action_attempt.extend({
1709
- action_type: action_type4,
1710
- error: error5
1741
+ action_type: action_type5,
1742
+ error: error6
1711
1743
  }).describe("Resetting sandbox workspace failed.")
1712
1744
  ]
1713
1745
  );
1714
- var action_type5 = zod.z.literal("SET_COOL");
1715
- var error6 = zod.z.object({
1746
+ var action_type6 = zod.z.literal("SET_COOL");
1747
+ var error7 = zod.z.object({
1716
1748
  type: zod.z.string(),
1717
1749
  message: zod.z.string()
1718
1750
  });
1719
- var result6 = zod.z.object({});
1751
+ var result7 = zod.z.object({});
1720
1752
  var set_cool_action_attempt = zod.z.discriminatedUnion("status", [
1721
1753
  common_pending_action_attempt.extend({
1722
- action_type: action_type5
1754
+ action_type: action_type6
1723
1755
  }).describe("Setting HVAC to cool."),
1724
1756
  common_succeeded_action_attempt.extend({
1725
- action_type: action_type5,
1726
- result: result6
1757
+ action_type: action_type6,
1758
+ result: result7
1727
1759
  }).describe("Setting HVAC to cool succeeded."),
1728
- common_failed_action_attempt.extend({ action_type: action_type5, error: error6 }).describe("Setting HVAC to cool failed.")
1760
+ common_failed_action_attempt.extend({ action_type: action_type6, error: error7 }).describe("Setting HVAC to cool failed.")
1729
1761
  ]);
1730
- var action_type6 = zod.z.literal("SET_FAN_MODE");
1731
- var error7 = zod.z.object({
1762
+ var action_type7 = zod.z.literal("SET_FAN_MODE");
1763
+ var error8 = zod.z.object({
1732
1764
  type: zod.z.string(),
1733
1765
  message: zod.z.string()
1734
1766
  });
1735
- var result7 = zod.z.object({});
1767
+ var result8 = zod.z.object({});
1736
1768
  var set_fan_mode_action_attempt = zod.z.discriminatedUnion("status", [
1737
1769
  common_pending_action_attempt.extend({
1738
- action_type: action_type6
1770
+ action_type: action_type7
1739
1771
  }).describe("Setting fan mode."),
1740
1772
  common_succeeded_action_attempt.extend({
1741
- action_type: action_type6,
1742
- result: result7
1773
+ action_type: action_type7,
1774
+ result: result8
1743
1775
  }).describe("Setting fan mode succeeded."),
1744
- common_failed_action_attempt.extend({ action_type: action_type6, error: error7 }).describe("Setting fan mode failed.")
1776
+ common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Setting fan mode failed.")
1745
1777
  ]);
1746
- var action_type7 = zod.z.literal("SET_HEAT");
1747
- var error8 = zod.z.object({
1778
+ var action_type8 = zod.z.literal("SET_HEAT");
1779
+ var error9 = zod.z.object({
1748
1780
  type: zod.z.string(),
1749
1781
  message: zod.z.string()
1750
1782
  });
1751
- var result8 = zod.z.object({});
1783
+ var result9 = zod.z.object({});
1752
1784
  var set_heat_action_attempt = zod.z.discriminatedUnion("status", [
1753
1785
  common_pending_action_attempt.extend({
1754
- action_type: action_type7
1786
+ action_type: action_type8
1755
1787
  }).describe("Setting HVAC to heat mode."),
1756
1788
  common_succeeded_action_attempt.extend({
1757
- action_type: action_type7,
1758
- result: result8
1789
+ action_type: action_type8,
1790
+ result: result9
1759
1791
  }).describe("Setting HVAC to heat mode succeeded."),
1760
- common_failed_action_attempt.extend({ action_type: action_type7, error: error8 }).describe("Setting HVAC to heat mode failed.")
1792
+ common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe("Setting HVAC to heat mode failed.")
1761
1793
  ]);
1762
- var action_type8 = zod.z.literal("SET_HEAT_COOL");
1763
- var error9 = zod.z.object({
1794
+ var action_type9 = zod.z.literal("SET_HEAT_COOL");
1795
+ var error10 = zod.z.object({
1764
1796
  type: zod.z.string(),
1765
1797
  message: zod.z.string()
1766
1798
  });
1767
- var result9 = zod.z.object({});
1799
+ var result10 = zod.z.object({});
1768
1800
  var set_heat_cool_action_attempt = zod.z.discriminatedUnion("status", [
1769
1801
  common_pending_action_attempt.extend({
1770
- action_type: action_type8
1802
+ action_type: action_type9
1771
1803
  }).describe("Setting HVAC to heat-cool mode."),
1772
1804
  common_succeeded_action_attempt.extend({
1773
- action_type: action_type8,
1774
- result: result9
1805
+ action_type: action_type9,
1806
+ result: result10
1775
1807
  }).describe("Setting HVAC to heat-cool mode succeeded."),
1776
- common_failed_action_attempt.extend({ action_type: action_type8, error: error9 }).describe("Setting heat-cool mode failed.")
1808
+ common_failed_action_attempt.extend({ action_type: action_type9, error: error10 }).describe("Setting heat-cool mode failed.")
1777
1809
  ]);
1778
- var action_type9 = zod.z.literal("SET_THERMOSTAT_OFF");
1779
- var error10 = zod.z.object({
1810
+ var action_type10 = zod.z.literal("SET_THERMOSTAT_OFF");
1811
+ var error11 = zod.z.object({
1780
1812
  type: zod.z.string(),
1781
1813
  message: zod.z.string()
1782
1814
  });
1783
- var result10 = zod.z.object({});
1815
+ var result11 = zod.z.object({});
1784
1816
  var set_thermostat_off_action_attempt = zod.z.discriminatedUnion(
1785
1817
  "status",
1786
1818
  [
1787
1819
  common_pending_action_attempt.extend({
1788
- action_type: action_type9
1820
+ action_type: action_type10
1789
1821
  }).describe("Turning HVAC off."),
1790
1822
  common_succeeded_action_attempt.extend({
1791
- action_type: action_type9,
1792
- result: result10
1823
+ action_type: action_type10,
1824
+ result: result11
1793
1825
  }).describe("Turning HVAC off succeeded."),
1794
- common_failed_action_attempt.extend({ action_type: action_type9, error: error10 }).describe("Turning HVAC off failed.")
1826
+ common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Turning HVAC off failed.")
1795
1827
  ]
1796
1828
  );
1797
- var action_type10 = zod.z.literal("UNLOCK_DOOR");
1798
- var error11 = zod.z.object({
1829
+ var action_type11 = zod.z.literal("UNLOCK_DOOR");
1830
+ var error12 = zod.z.object({
1799
1831
  type: zod.z.string(),
1800
1832
  message: zod.z.string()
1801
1833
  });
1802
- var result11 = zod.z.object({});
1834
+ var result12 = zod.z.object({});
1803
1835
  var unlock_door_action_attempt = zod.z.discriminatedUnion("status", [
1804
1836
  common_pending_action_attempt.extend({
1805
- action_type: action_type10
1837
+ action_type: action_type11
1806
1838
  }).describe("Unlocking door."),
1807
1839
  common_succeeded_action_attempt.extend({
1808
- action_type: action_type10,
1809
- result: result11
1840
+ action_type: action_type11,
1841
+ result: result12
1810
1842
  }).describe("Unlocking door succeeded."),
1811
- common_failed_action_attempt.extend({ action_type: action_type10, error: error11 }).describe("Unlocking door failed.")
1843
+ common_failed_action_attempt.extend({ action_type: action_type11, error: error12 }).describe("Unlocking door failed.")
1812
1844
  ]);
1813
1845
 
1814
1846
  // src/lib/seam/connect/models/action-attempts/action-attempt.ts
@@ -1816,6 +1848,7 @@ var action_attempt = zod.z.union([
1816
1848
  ...lock_door_action_attempt.options,
1817
1849
  ...unlock_door_action_attempt.options,
1818
1850
  ...read_card_action_attempt.options,
1851
+ ...encode_card_action_attempt.options,
1819
1852
  ...reset_sandbox_workspace_action_attempt.options,
1820
1853
  ...set_cool_action_attempt.options,
1821
1854
  ...set_heat_action_attempt.options,
@@ -2851,6 +2884,29 @@ var openapi_default = {
2851
2884
  ],
2852
2885
  type: "object"
2853
2886
  },
2887
+ salto_ks_metadata: {
2888
+ properties: {
2889
+ battery_level: { type: "string" },
2890
+ door_name: { type: "string" },
2891
+ intrusion_alarm: { type: "boolean" },
2892
+ left_open_alarm: { type: "boolean" },
2893
+ lock_type: { type: "string" },
2894
+ locked_state: { type: "string" },
2895
+ online: { type: "boolean" },
2896
+ privacy_mode: { type: "boolean" }
2897
+ },
2898
+ required: [
2899
+ "door_name",
2900
+ "locked_state",
2901
+ "lock_type",
2902
+ "online",
2903
+ "battery_level",
2904
+ "left_open_alarm",
2905
+ "intrusion_alarm",
2906
+ "privacy_mode"
2907
+ ],
2908
+ type: "object"
2909
+ },
2854
2910
  visionline_metadata: {
2855
2911
  properties: {
2856
2912
  door_category: {
@@ -3653,6 +3709,98 @@ var openapi_default = {
3653
3709
  ],
3654
3710
  type: "object"
3655
3711
  },
3712
+ {
3713
+ description: "Encoding card data from physical encoder.",
3714
+ properties: {
3715
+ action_attempt_id: {
3716
+ description: "The ID of the action attempt.",
3717
+ format: "uuid",
3718
+ type: "string",
3719
+ "x-title": "Action Attempt ID"
3720
+ },
3721
+ action_type: { enum: ["ENCODE_CARD"], type: "string" },
3722
+ error: { nullable: true },
3723
+ result: { nullable: true },
3724
+ status: { enum: ["pending"], type: "string" }
3725
+ },
3726
+ required: [
3727
+ "action_attempt_id",
3728
+ "status",
3729
+ "result",
3730
+ "error",
3731
+ "action_type"
3732
+ ],
3733
+ type: "object"
3734
+ },
3735
+ {
3736
+ description: "Encoding card data from physical encoder succeeded.",
3737
+ properties: {
3738
+ action_attempt_id: {
3739
+ description: "The ID of the action attempt.",
3740
+ format: "uuid",
3741
+ type: "string",
3742
+ "x-title": "Action Attempt ID"
3743
+ },
3744
+ action_type: { enum: ["ENCODE_CARD"], type: "string" },
3745
+ error: { nullable: true },
3746
+ result: {
3747
+ properties: {
3748
+ acs_credential_id: {
3749
+ description: "Matching acs_credential currently encoded on this card.",
3750
+ format: "uuid",
3751
+ nullable: true,
3752
+ type: "string"
3753
+ },
3754
+ card_number: {
3755
+ description: "A number or sting that physically identifies this card.",
3756
+ nullable: true,
3757
+ type: "string"
3758
+ }
3759
+ },
3760
+ required: ["acs_credential_id", "card_number"],
3761
+ type: "object"
3762
+ },
3763
+ status: { enum: ["success"], type: "string" }
3764
+ },
3765
+ required: [
3766
+ "action_attempt_id",
3767
+ "status",
3768
+ "error",
3769
+ "action_type",
3770
+ "result"
3771
+ ],
3772
+ type: "object"
3773
+ },
3774
+ {
3775
+ description: "Encoding card data from physical encoder failed.",
3776
+ properties: {
3777
+ action_attempt_id: {
3778
+ description: "The ID of the action attempt.",
3779
+ format: "uuid",
3780
+ type: "string",
3781
+ "x-title": "Action Attempt ID"
3782
+ },
3783
+ action_type: { enum: ["ENCODE_CARD"], type: "string" },
3784
+ error: {
3785
+ properties: {
3786
+ message: { type: "string" },
3787
+ type: { type: "string" }
3788
+ },
3789
+ required: ["type", "message"],
3790
+ type: "object"
3791
+ },
3792
+ result: { nullable: true },
3793
+ status: { enum: ["error"], type: "string" }
3794
+ },
3795
+ required: [
3796
+ "action_attempt_id",
3797
+ "status",
3798
+ "result",
3799
+ "action_type",
3800
+ "error"
3801
+ ],
3802
+ type: "object"
3803
+ },
3656
3804
  {
3657
3805
  description: "Resetting sandbox workspace.",
3658
3806
  properties: {
@@ -9682,6 +9830,68 @@ var openapi_default = {
9682
9830
  "x-fern-sdk-method-name": "update"
9683
9831
  }
9684
9832
  },
9833
+ "/acs/encoders/encode_card": {
9834
+ post: {
9835
+ operationId: "acsEncodersEncodeCardPost",
9836
+ requestBody: {
9837
+ content: {
9838
+ "application/json": {
9839
+ schema: {
9840
+ oneOf: [
9841
+ {
9842
+ properties: {
9843
+ acs_system_id: { format: "uuid", type: "string" },
9844
+ device_name: { type: "string" }
9845
+ },
9846
+ required: ["acs_system_id", "device_name"],
9847
+ type: "object"
9848
+ },
9849
+ {
9850
+ properties: {
9851
+ device_id: { format: "uuid", type: "string" }
9852
+ },
9853
+ required: ["device_id"],
9854
+ type: "object"
9855
+ }
9856
+ ]
9857
+ }
9858
+ }
9859
+ }
9860
+ },
9861
+ responses: {
9862
+ 200: {
9863
+ content: {
9864
+ "application/json": {
9865
+ schema: {
9866
+ properties: {
9867
+ action_attempt: {
9868
+ $ref: "#/components/schemas/action_attempt"
9869
+ },
9870
+ ok: { type: "boolean" }
9871
+ },
9872
+ required: ["action_attempt", "ok"],
9873
+ type: "object"
9874
+ }
9875
+ }
9876
+ },
9877
+ description: "OK"
9878
+ },
9879
+ 400: { description: "Bad Request" },
9880
+ 401: { description: "Unauthorized" }
9881
+ },
9882
+ security: [
9883
+ { pat_with_workspace: [] },
9884
+ { console_session: [] },
9885
+ { api_key: [] }
9886
+ ],
9887
+ summary: "/acs/encoders/encode_card",
9888
+ tags: ["/acs"],
9889
+ "x-fern-sdk-group-name": ["acs", "encoders"],
9890
+ "x-fern-sdk-method-name": "encode_card",
9891
+ "x-fern-sdk-return-value": "action_attempt",
9892
+ "x-undocumented": "Encoding a card is currently unimplemented."
9893
+ }
9894
+ },
9685
9895
  "/acs/encoders/read_card": {
9686
9896
  post: {
9687
9897
  operationId: "acsEncodersReadCardPost",