@seamapi/http 2.31.0 → 2.33.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 (177) hide show
  1. package/lib/resources/access-code.d.ts +15 -15
  2. package/lib/resources/access-grant.d.ts +4 -4
  3. package/lib/resources/access-method.d.ts +9 -9
  4. package/lib/resources/acs-access-group.d.ts +3 -3
  5. package/lib/resources/acs-credential.d.ts +35 -35
  6. package/lib/resources/acs-encoder.d.ts +10 -10
  7. package/lib/resources/acs-entrance.d.ts +20 -20
  8. package/lib/resources/acs-system.d.ts +37 -37
  9. package/lib/resources/acs-user.d.ts +35 -35
  10. package/lib/resources/action-attempt.d.ts +101 -101
  11. package/lib/resources/client-session.d.ts +12 -12
  12. package/lib/resources/connect-webview.d.ts +6 -6
  13. package/lib/resources/connected-account.d.ts +8 -8
  14. package/lib/resources/device-provider.d.ts +1 -1
  15. package/lib/resources/device.d.ts +102 -85
  16. package/lib/resources/event.d.ts +10 -10
  17. package/lib/resources/noise-threshold.d.ts +2 -2
  18. package/lib/resources/phone.d.ts +1 -1
  19. package/lib/resources/thermostat-daily-program.d.ts +1 -1
  20. package/lib/resources/thermostat-schedule.d.ts +11 -11
  21. package/lib/resources/unmanaged-access-code.d.ts +12 -12
  22. package/lib/resources/unmanaged-access-grant.d.ts +4 -4
  23. package/lib/resources/unmanaged-access-method.d.ts +9 -9
  24. package/lib/resources/unmanaged-device.d.ts +11 -11
  25. package/lib/resources/user-identity.d.ts +1 -1
  26. package/lib/resources/webhook.d.ts +4 -4
  27. package/lib/resources/workspace.d.ts +12 -12
  28. package/lib/routes/access-codes/access-codes.d.ts +28 -28
  29. package/lib/routes/access-codes/access-codes.js +13 -13
  30. package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
  31. package/lib/routes/access-codes/simulate/simulate.js +1 -1
  32. package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
  33. package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
  34. package/lib/routes/access-grants/access-grants.d.ts +3 -3
  35. package/lib/routes/access-grants/access-grants.js +1 -1
  36. package/lib/routes/access-methods/access-methods.d.ts +2 -2
  37. package/lib/routes/access-methods/access-methods.js +2 -2
  38. package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
  39. package/lib/routes/acs/access-groups/access-groups.js +7 -7
  40. package/lib/routes/acs/credentials/credentials.d.ts +12 -12
  41. package/lib/routes/acs/credentials/credentials.js +8 -8
  42. package/lib/routes/acs/encoders/encoders.d.ts +5 -5
  43. package/lib/routes/acs/encoders/encoders.js +5 -5
  44. package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
  45. package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
  46. package/lib/routes/acs/entrances/entrances.d.ts +5 -5
  47. package/lib/routes/acs/entrances/entrances.js +5 -5
  48. package/lib/routes/acs/systems/systems.d.ts +3 -3
  49. package/lib/routes/acs/systems/systems.js +3 -3
  50. package/lib/routes/acs/users/users.d.ts +16 -16
  51. package/lib/routes/acs/users/users.js +11 -11
  52. package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
  53. package/lib/routes/action-attempts/action-attempts.js +2 -2
  54. package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
  55. package/lib/routes/client-sessions/client-sessions.js +8 -8
  56. package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
  57. package/lib/routes/connect-webviews/connect-webviews.js +5 -5
  58. package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
  59. package/lib/routes/connected-accounts/connected-accounts.js +5 -5
  60. package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
  61. package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
  62. package/lib/routes/devices/devices.d.ts +12 -12
  63. package/lib/routes/devices/devices.js +6 -6
  64. package/lib/routes/devices/simulate/simulate.d.ts +3 -3
  65. package/lib/routes/devices/simulate/simulate.js +3 -3
  66. package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
  67. package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
  68. package/lib/routes/events/events.d.ts +4 -4
  69. package/lib/routes/events/events.js +2 -2
  70. package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
  71. package/lib/routes/instant-keys/instant-keys.js +3 -3
  72. package/lib/routes/locks/locks.d.ts +6 -6
  73. package/lib/routes/locks/locks.js +5 -5
  74. package/lib/routes/locks/simulate/simulate.d.ts +2 -2
  75. package/lib/routes/locks/simulate/simulate.js +2 -2
  76. package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
  77. package/lib/routes/noise-sensors/noise-sensors.js +1 -1
  78. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
  79. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
  80. package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
  81. package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
  82. package/lib/routes/phones/phones.d.ts +4 -4
  83. package/lib/routes/phones/phones.js +3 -3
  84. package/lib/routes/phones/simulate/simulate.d.ts +1 -1
  85. package/lib/routes/phones/simulate/simulate.js +1 -1
  86. package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
  87. package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
  88. package/lib/routes/seam-http-endpoints.d.ts +176 -176
  89. package/lib/routes/seam-http-endpoints.js +176 -176
  90. package/lib/routes/spaces/spaces.d.ts +4 -4
  91. package/lib/routes/spaces/spaces.js +4 -4
  92. package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
  93. package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
  94. package/lib/routes/thermostats/schedules/schedules.js +5 -5
  95. package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
  96. package/lib/routes/thermostats/simulate/simulate.js +2 -2
  97. package/lib/routes/thermostats/thermostats.d.ts +43 -43
  98. package/lib/routes/thermostats/thermostats.js +13 -13
  99. package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
  100. package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
  101. package/lib/routes/user-identities/user-identities.d.ts +15 -15
  102. package/lib/routes/user-identities/user-identities.js +15 -15
  103. package/lib/routes/webhooks/webhooks.d.ts +5 -5
  104. package/lib/routes/webhooks/webhooks.js +5 -5
  105. package/lib/routes/workspaces/workspaces.d.ts +16 -16
  106. package/lib/routes/workspaces/workspaces.js +5 -5
  107. package/lib/version.d.ts +1 -1
  108. package/lib/version.js +1 -1
  109. package/package.json +2 -2
  110. package/src/lib/resources/access-code.ts +15 -15
  111. package/src/lib/resources/access-grant.ts +4 -4
  112. package/src/lib/resources/access-method.ts +9 -9
  113. package/src/lib/resources/acs-access-group.ts +3 -3
  114. package/src/lib/resources/acs-credential.ts +35 -35
  115. package/src/lib/resources/acs-encoder.ts +10 -10
  116. package/src/lib/resources/acs-entrance.ts +20 -20
  117. package/src/lib/resources/acs-system.ts +37 -37
  118. package/src/lib/resources/acs-user.ts +35 -35
  119. package/src/lib/resources/action-attempt.ts +101 -101
  120. package/src/lib/resources/client-session.ts +12 -12
  121. package/src/lib/resources/connect-webview.ts +6 -6
  122. package/src/lib/resources/connected-account.ts +8 -8
  123. package/src/lib/resources/device-provider.ts +1 -0
  124. package/src/lib/resources/device.ts +104 -84
  125. package/src/lib/resources/event.ts +10 -10
  126. package/src/lib/resources/noise-threshold.ts +2 -2
  127. package/src/lib/resources/phone.ts +1 -1
  128. package/src/lib/resources/thermostat-daily-program.ts +1 -1
  129. package/src/lib/resources/thermostat-schedule.ts +11 -11
  130. package/src/lib/resources/unmanaged-access-code.ts +12 -12
  131. package/src/lib/resources/unmanaged-access-grant.ts +4 -4
  132. package/src/lib/resources/unmanaged-access-method.ts +9 -9
  133. package/src/lib/resources/unmanaged-device.ts +11 -10
  134. package/src/lib/resources/user-identity.ts +1 -1
  135. package/src/lib/resources/webhook.ts +4 -4
  136. package/src/lib/resources/workspace.ts +12 -12
  137. package/src/lib/routes/access-codes/access-codes.ts +28 -28
  138. package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
  139. package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
  140. package/src/lib/routes/access-grants/access-grants.ts +3 -3
  141. package/src/lib/routes/access-methods/access-methods.ts +2 -2
  142. package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
  143. package/src/lib/routes/acs/credentials/credentials.ts +12 -12
  144. package/src/lib/routes/acs/encoders/encoders.ts +5 -5
  145. package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
  146. package/src/lib/routes/acs/entrances/entrances.ts +5 -5
  147. package/src/lib/routes/acs/systems/systems.ts +3 -3
  148. package/src/lib/routes/acs/users/users.ts +16 -16
  149. package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
  150. package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
  151. package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
  152. package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
  153. package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
  154. package/src/lib/routes/devices/devices.ts +13 -9
  155. package/src/lib/routes/devices/simulate/simulate.ts +3 -3
  156. package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -6
  157. package/src/lib/routes/events/events.ts +4 -4
  158. package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
  159. package/src/lib/routes/locks/locks.ts +6 -5
  160. package/src/lib/routes/locks/simulate/simulate.ts +2 -2
  161. package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
  162. package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
  163. package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
  164. package/src/lib/routes/phones/phones.ts +4 -4
  165. package/src/lib/routes/phones/simulate/simulate.ts +1 -1
  166. package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
  167. package/src/lib/routes/seam-http-endpoints.ts +176 -176
  168. package/src/lib/routes/spaces/spaces.ts +4 -4
  169. package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
  170. package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
  171. package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
  172. package/src/lib/routes/thermostats/thermostats.ts +43 -43
  173. package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
  174. package/src/lib/routes/user-identities/user-identities.ts +15 -15
  175. package/src/lib/routes/webhooks/webhooks.ts +5 -5
  176. package/src/lib/routes/workspaces/workspaces.ts +16 -16
  177. package/src/lib/version.ts +1 -1
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Represents a [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
2
+ * Represents a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
3
3
  *
4
4
  * You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
5
5
  *
@@ -7,7 +7,7 @@
7
7
  *
8
8
  * A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
9
9
  *
10
- * See also [Get Started with React](https://docs.seam.co/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
10
+ * See also [Get Started with React](https://www.seam.co/docs/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
11
11
  */
12
12
  export type ClientSession = {
13
13
  /**
@@ -15,43 +15,43 @@ export type ClientSession = {
15
15
  */
16
16
  client_session_id: string;
17
17
  /**
18
- * IDs of the [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
18
+ * IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
19
19
  */
20
20
  connect_webview_ids: Array<string>;
21
21
  /**
22
- * IDs of the [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
22
+ * IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
23
23
  */
24
24
  connected_account_ids: Array<string>;
25
25
  /**
26
- * Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) was created.
26
+ * Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) was created.
27
27
  */
28
28
  created_at: string;
29
29
  /**
30
- * Customer key associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
30
+ * Customer key associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
31
31
  */
32
32
  customer_key?: string | undefined;
33
33
  /**
34
- * Number of devices associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
34
+ * Number of devices associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
35
35
  */
36
36
  device_count: number;
37
37
  /**
38
- * Date and time at which the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens) expires.
38
+ * Date and time at which the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) expires.
39
39
  */
40
40
  expires_at: string;
41
41
  /**
42
- * Client session token associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
42
+ * Client session token associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
43
43
  */
44
44
  token: string;
45
45
  /**
46
- * Your user ID for the user associated with the [client session](https://docs.seam.co/core-concepts/authentication/client-session-tokens).
46
+ * Your user ID for the user associated with the [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
47
47
  */
48
48
  user_identifier_key: string | null;
49
49
  /**
50
- * ID of the [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
50
+ * ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
51
51
  */
52
52
  user_identity_id?: string | undefined;
53
53
  /**
54
- * IDs of the [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
54
+ * IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
55
55
  * @deprecated Use `user_identity_id` instead.
56
56
  */
57
57
  user_identity_ids: Array<string>;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Represents a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews).
2
+ * Represents a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
3
3
  *
4
4
  * Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
5
5
  *
@@ -17,7 +17,7 @@ export type ConnectWebview = {
17
17
  */
18
18
  accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera'>;
19
19
  /**
20
- * List of accepted [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
20
+ * List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
21
21
  */
22
22
  accepted_providers: Array<string>;
23
23
  /**
@@ -29,7 +29,7 @@ export type ConnectWebview = {
29
29
  */
30
30
  authorized_at: string | null;
31
31
  /**
32
- * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.
32
+ * Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API.
33
33
  */
34
34
  automatically_manage_new_devices: boolean;
35
35
  /**
@@ -45,7 +45,7 @@ export type ConnectWebview = {
45
45
  */
46
46
  created_at: string;
47
47
  /**
48
- * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
48
+ * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
49
49
  */
50
50
  custom_metadata: Record<string, string | boolean>;
51
51
  /**
@@ -69,7 +69,7 @@ export type ConnectWebview = {
69
69
  */
70
70
  login_successful: boolean;
71
71
  /**
72
- * Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
72
+ * Selected provider of the Connect Webview, one of the [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
73
73
  */
74
74
  selected_provider: string | null;
75
75
  /**
@@ -81,7 +81,7 @@ export type ConnectWebview = {
81
81
  */
82
82
  url: string;
83
83
  /**
84
- * Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.
84
+ * Indicates whether Seam should [finish syncing all devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview.
85
85
  */
86
86
  wait_for_device_creation: boolean;
87
87
  /**
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
2
+ * Represents a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
3
3
  */
4
4
  export type ConnectedAccount = {
5
5
  /**
@@ -15,7 +15,7 @@ export type ConnectedAccount = {
15
15
  */
16
16
  account_type_display_name: string;
17
17
  /**
18
- * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.
18
+ * Indicates whether Seam should [import all new devices](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.
19
19
  */
20
20
  automatically_manage_new_devices: boolean;
21
21
  /**
@@ -27,7 +27,7 @@ export type ConnectedAccount = {
27
27
  */
28
28
  created_at?: string | undefined;
29
29
  /**
30
- * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
30
+ * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
31
31
  */
32
32
  custom_metadata: Record<string, string | boolean>;
33
33
  /**
@@ -63,7 +63,7 @@ export type ConnectedAccount = {
63
63
  */
64
64
  error_code: 'account_disconnected';
65
65
  /**
66
- * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
66
+ * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
67
67
  */
68
68
  is_bridge_error?: boolean | undefined;
69
69
  /**
@@ -75,7 +75,7 @@ export type ConnectedAccount = {
75
75
  */
76
76
  message: string;
77
77
  } /**
78
- * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
78
+ * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
79
79
  */ | {
80
80
  /**
81
81
  * Date and time at which Seam created the error.
@@ -86,7 +86,7 @@ export type ConnectedAccount = {
86
86
  */
87
87
  error_code: 'bridge_disconnected';
88
88
  /**
89
- * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
89
+ * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
90
90
  */
91
91
  is_bridge_error?: boolean | undefined;
92
92
  /**
@@ -109,7 +109,7 @@ export type ConnectedAccount = {
109
109
  */
110
110
  error_code: 'salto_ks_subscription_limit_exceeded';
111
111
  /**
112
- * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
112
+ * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
113
113
  */
114
114
  is_bridge_error?: boolean | undefined;
115
115
  /**
@@ -158,7 +158,7 @@ export type ConnectedAccount = {
158
158
  */
159
159
  error_code: 'dormakaba_sites_disconnected';
160
160
  /**
161
- * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
161
+ * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
162
162
  */
163
163
  is_bridge_error?: boolean | undefined;
164
164
  /**
@@ -82,7 +82,7 @@ export type DeviceProvider = {
82
82
  /**
83
83
  * Name of the device provider.
84
84
  */
85
- device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
85
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
86
86
  /**
87
87
  * Display name for the device provider.
88
88
  */