@seamapi/types 1.427.0 → 1.429.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.
@@ -7,7 +7,7 @@ export declare const access_method: z.ZodObject<{
7
7
  created_at: z.ZodString;
8
8
  issued_at: z.ZodOptional<z.ZodString>;
9
9
  instant_key_url: z.ZodOptional<z.ZodString>;
10
- is_card_encoding_required: z.ZodOptional<z.ZodBoolean>;
10
+ is_encoding_required: z.ZodOptional<z.ZodBoolean>;
11
11
  }, "strip", z.ZodTypeAny, {
12
12
  display_name: string;
13
13
  workspace_id: string;
@@ -16,7 +16,7 @@ export declare const access_method: z.ZodObject<{
16
16
  access_method_id: string;
17
17
  instant_key_url?: string | undefined;
18
18
  issued_at?: string | undefined;
19
- is_card_encoding_required?: boolean | undefined;
19
+ is_encoding_required?: boolean | undefined;
20
20
  }, {
21
21
  display_name: string;
22
22
  workspace_id: string;
@@ -25,6 +25,6 @@ export declare const access_method: z.ZodObject<{
25
25
  access_method_id: string;
26
26
  instant_key_url?: string | undefined;
27
27
  issued_at?: string | undefined;
28
- is_card_encoding_required?: boolean | undefined;
28
+ is_encoding_required?: boolean | undefined;
29
29
  }>;
30
30
  export type AccessMethod = z.infer<typeof access_method>;
@@ -23,10 +23,10 @@ export const access_method = z.object({
23
23
  .url()
24
24
  .optional()
25
25
  .describe('URL of the Instant Key for mobile key access methods.'),
26
- is_card_encoding_required: z
26
+ is_encoding_required: z
27
27
  .boolean()
28
28
  .optional()
29
- .describe('Indicates whether card encoding is required for plastic card access methods.'),
29
+ .describe('Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.'),
30
30
  }).describe(`
31
31
  ---
32
32
  draft: Early access.
@@ -1 +1 @@
1
- {"version":3,"file":"access-method.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/access-grants/access-method.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACxE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IACvE,IAAI,EAAE,CAAC;SACJ,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;SACpC,QAAQ,CACP,qEAAqE,CACtE;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,yBAAyB,EAAE,CAAC;SACzB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,8EAA8E,CAC/E;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;;GAMT,CAAC,CAAA"}
1
+ {"version":3,"file":"access-method.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/access-grants/access-method.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CAAC,6DAA6D,CAAC;IAC1E,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;IACxE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IACvE,IAAI,EAAE,CAAC;SACJ,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;SACpC,QAAQ,CACP,qEAAqE,CACtE;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,QAAQ,CAAC,sDAAsD,CAAC;IACnE,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IACpE,oBAAoB,EAAE,CAAC;SACpB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,qIAAqI,CACtI;CACJ,CAAC,CAAC,QAAQ,CAAC;;;;;;GAMT,CAAC,CAAA"}
@@ -1657,189 +1657,6 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
1657
1657
  status: z.ZodLiteral<"pending">;
1658
1658
  result: z.ZodNull;
1659
1659
  error: z.ZodNull;
1660
- }>, {
1661
- action_type: z.ZodLiteral<"ENCODE_ACCESS_METHOD">;
1662
- }>, "strip", z.ZodTypeAny, {
1663
- error: null;
1664
- status: "pending";
1665
- action_attempt_id: string;
1666
- result: null;
1667
- action_type: "ENCODE_ACCESS_METHOD";
1668
- }, {
1669
- error: null;
1670
- status: "pending";
1671
- action_attempt_id: string;
1672
- result: null;
1673
- action_type: "ENCODE_ACCESS_METHOD";
1674
- }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
1675
- action_attempt_id: z.ZodString;
1676
- status: z.ZodEnum<["pending", "success", "error"]>;
1677
- }, {
1678
- status: z.ZodLiteral<"success">;
1679
- error: z.ZodNull;
1680
- }>, {
1681
- action_type: z.ZodLiteral<"ENCODE_ACCESS_METHOD">;
1682
- result: z.ZodObject<{
1683
- workspace_id: z.ZodString;
1684
- access_method_id: z.ZodString;
1685
- display_name: z.ZodString;
1686
- mode: z.ZodEnum<["code", "card", "mobile_key"]>;
1687
- created_at: z.ZodString;
1688
- issued_at: z.ZodOptional<z.ZodString>;
1689
- instant_key_url: z.ZodOptional<z.ZodString>;
1690
- is_card_encoding_required: z.ZodOptional<z.ZodBoolean>;
1691
- }, "strip", z.ZodTypeAny, {
1692
- display_name: string;
1693
- workspace_id: string;
1694
- created_at: string;
1695
- mode: "code" | "card" | "mobile_key";
1696
- access_method_id: string;
1697
- instant_key_url?: string | undefined;
1698
- issued_at?: string | undefined;
1699
- is_card_encoding_required?: boolean | undefined;
1700
- }, {
1701
- display_name: string;
1702
- workspace_id: string;
1703
- created_at: string;
1704
- mode: "code" | "card" | "mobile_key";
1705
- access_method_id: string;
1706
- instant_key_url?: string | undefined;
1707
- issued_at?: string | undefined;
1708
- is_card_encoding_required?: boolean | undefined;
1709
- }>;
1710
- }>, "strip", z.ZodTypeAny, {
1711
- error: null;
1712
- status: "success";
1713
- action_attempt_id: string;
1714
- result: {
1715
- display_name: string;
1716
- workspace_id: string;
1717
- created_at: string;
1718
- mode: "code" | "card" | "mobile_key";
1719
- access_method_id: string;
1720
- instant_key_url?: string | undefined;
1721
- issued_at?: string | undefined;
1722
- is_card_encoding_required?: boolean | undefined;
1723
- };
1724
- action_type: "ENCODE_ACCESS_METHOD";
1725
- }, {
1726
- error: null;
1727
- status: "success";
1728
- action_attempt_id: string;
1729
- result: {
1730
- display_name: string;
1731
- workspace_id: string;
1732
- created_at: string;
1733
- mode: "code" | "card" | "mobile_key";
1734
- access_method_id: string;
1735
- instant_key_url?: string | undefined;
1736
- issued_at?: string | undefined;
1737
- is_card_encoding_required?: boolean | undefined;
1738
- };
1739
- action_type: "ENCODE_ACCESS_METHOD";
1740
- }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
1741
- action_attempt_id: z.ZodString;
1742
- status: z.ZodEnum<["pending", "success", "error"]>;
1743
- }, {
1744
- status: z.ZodLiteral<"error">;
1745
- result: z.ZodNull;
1746
- }>, {
1747
- action_type: z.ZodLiteral<"ENCODE_ACCESS_METHOD">;
1748
- error: z.ZodUnion<[z.ZodObject<{
1749
- type: z.ZodLiteral<"uncategorized_error">;
1750
- message: z.ZodString;
1751
- }, "strip", z.ZodTypeAny, {
1752
- type: "uncategorized_error";
1753
- message: string;
1754
- }, {
1755
- type: "uncategorized_error";
1756
- message: string;
1757
- }>, z.ZodObject<{
1758
- type: z.ZodLiteral<"action_attempt_expired">;
1759
- message: z.ZodString;
1760
- }, "strip", z.ZodTypeAny, {
1761
- type: "action_attempt_expired";
1762
- message: string;
1763
- }, {
1764
- type: "action_attempt_expired";
1765
- message: string;
1766
- }>, z.ZodObject<{
1767
- type: z.ZodLiteral<"no_credential_on_encoder">;
1768
- message: z.ZodString;
1769
- }, "strip", z.ZodTypeAny, {
1770
- type: "no_credential_on_encoder";
1771
- message: string;
1772
- }, {
1773
- type: "no_credential_on_encoder";
1774
- message: string;
1775
- }>, z.ZodObject<{
1776
- type: z.ZodLiteral<"incompatible_card_format">;
1777
- message: z.ZodString;
1778
- }, "strip", z.ZodTypeAny, {
1779
- type: "incompatible_card_format";
1780
- message: string;
1781
- }, {
1782
- type: "incompatible_card_format";
1783
- message: string;
1784
- }>, z.ZodObject<{
1785
- type: z.ZodLiteral<"credential_cannot_be_reissued">;
1786
- message: z.ZodString;
1787
- }, "strip", z.ZodTypeAny, {
1788
- type: "credential_cannot_be_reissued";
1789
- message: string;
1790
- }, {
1791
- type: "credential_cannot_be_reissued";
1792
- message: string;
1793
- }>]>;
1794
- }>, "strip", z.ZodTypeAny, {
1795
- error: {
1796
- type: "uncategorized_error";
1797
- message: string;
1798
- } | {
1799
- type: "action_attempt_expired";
1800
- message: string;
1801
- } | {
1802
- type: "no_credential_on_encoder";
1803
- message: string;
1804
- } | {
1805
- type: "incompatible_card_format";
1806
- message: string;
1807
- } | {
1808
- type: "credential_cannot_be_reissued";
1809
- message: string;
1810
- };
1811
- status: "error";
1812
- action_attempt_id: string;
1813
- result: null;
1814
- action_type: "ENCODE_ACCESS_METHOD";
1815
- }, {
1816
- error: {
1817
- type: "uncategorized_error";
1818
- message: string;
1819
- } | {
1820
- type: "action_attempt_expired";
1821
- message: string;
1822
- } | {
1823
- type: "no_credential_on_encoder";
1824
- message: string;
1825
- } | {
1826
- type: "incompatible_card_format";
1827
- message: string;
1828
- } | {
1829
- type: "credential_cannot_be_reissued";
1830
- message: string;
1831
- };
1832
- status: "error";
1833
- action_attempt_id: string;
1834
- result: null;
1835
- action_type: "ENCODE_ACCESS_METHOD";
1836
- }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
1837
- action_attempt_id: z.ZodString;
1838
- status: z.ZodEnum<["pending", "success", "error"]>;
1839
- }, {
1840
- status: z.ZodLiteral<"pending">;
1841
- result: z.ZodNull;
1842
- error: z.ZodNull;
1843
1660
  }>, {
1844
1661
  action_type: z.ZodLiteral<"ENCODE_CREDENTIAL">;
1845
1662
  }>, "strip", z.ZodTypeAny, {
@@ -1,7 +1,6 @@
1
1
  import { z } from 'zod';
2
2
  import { activate_climate_preset_action_attempt } from './activate-climate-preset.js';
3
3
  import { deprecated_action_attempts } from './deprecated.js';
4
- import { encode_access_method_action_attempt } from './encode-access-method.js';
5
4
  import { encode_credential_action_attempt } from './encode-credential.js';
6
5
  import { lock_door_action_attempt } from './lock-door.js';
7
6
  import { push_thermostat_programs_action_attempt } from './push-thermostat-programs.js';
@@ -16,7 +15,6 @@ export const action_attempt = z.union([
16
15
  ...lock_door_action_attempt.options,
17
16
  ...unlock_door_action_attempt.options,
18
17
  ...scan_credential_action_attempt.options,
19
- ...encode_access_method_action_attempt.options,
20
18
  ...encode_credential_action_attempt.options,
21
19
  ...reset_sandbox_workspace_action_attempt.options,
22
20
  ...set_fan_mode_action_attempt.options,
@@ -31,7 +29,7 @@ export const action_attempt = z.union([
31
29
  route_path: /action_attempts
32
30
  ---
33
31
  Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
34
-
32
+
35
33
  When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
36
34
 
37
35
  See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).
@@ -1 +1 @@
1
- {"version":3,"file":"action-attempt.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/action-attempt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,sCAAsC,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,mCAAmC,EAAE,MAAM,2BAA2B,CAAA;AAC/E,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,uCAAuC,EAAE,MAAM,+BAA+B,CAAA;AACvF,OAAO,EAAE,sCAAsC,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,yCAAyC,EAAE,MAAM,iCAAiC,CAAA;AAC3F,OAAO,EAAE,8CAA8C,EAAE,MAAM,sCAAsC,CAAA;AACrG,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAA;AAE7D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC;IACpC,GAAG,wBAAwB,CAAC,OAAO;IACnC,GAAG,0BAA0B,CAAC,OAAO;IACrC,GAAG,8BAA8B,CAAC,OAAO;IACzC,GAAG,mCAAmC,CAAC,OAAO;IAC9C,GAAG,gCAAgC,CAAC,OAAO;IAC3C,GAAG,sCAAsC,CAAC,OAAO;IACjD,GAAG,2BAA2B,CAAC,OAAO;IACtC,GAAG,4BAA4B,CAAC,OAAO;IACvC,GAAG,sCAAsC,CAAC,OAAO;IACjD,GAAG,yCAAyC,CAAC,OAAO;IACpD,GAAG,8CAA8C,CAAC,OAAO;IACzD,GAAG,uCAAuC,CAAC,OAAO;IAClD,GAAG,0BAA0B;CAC9B,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;CASX,CAAC,CAAA"}
1
+ {"version":3,"file":"action-attempt.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/action-attempt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,sCAAsC,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,uCAAuC,EAAE,MAAM,+BAA+B,CAAA;AACvF,OAAO,EAAE,sCAAsC,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,EAAE,8BAA8B,EAAE,MAAM,sBAAsB,CAAA;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,yCAAyC,EAAE,MAAM,iCAAiC,CAAA;AAC3F,OAAO,EAAE,8CAA8C,EAAE,MAAM,sCAAsC,CAAA;AACrG,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAA;AAE7D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC;IACpC,GAAG,wBAAwB,CAAC,OAAO;IACnC,GAAG,0BAA0B,CAAC,OAAO;IACrC,GAAG,8BAA8B,CAAC,OAAO;IACzC,GAAG,gCAAgC,CAAC,OAAO;IAC3C,GAAG,sCAAsC,CAAC,OAAO;IACjD,GAAG,2BAA2B,CAAC,OAAO;IACtC,GAAG,4BAA4B,CAAC,OAAO;IACvC,GAAG,sCAAsC,CAAC,OAAO;IACjD,GAAG,yCAAyC,CAAC,OAAO;IACpD,GAAG,8CAA8C,CAAC,OAAO;IACzD,GAAG,uCAAuC,CAAC,OAAO;IAClD,GAAG,0BAA0B;CAC9B,CAAC,CAAC,QAAQ,CAAC;;;;;;;;;CASX,CAAC,CAAA"}