@seamapi/types 1.461.0 → 1.463.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.
package/dist/connect.cjs CHANGED
@@ -1762,7 +1762,8 @@ var DEVICE_PROVIDERS = {
1762
1762
  SALTO_SPACE: "salto_space",
1763
1763
  SENSI: "sensi",
1764
1764
  KWIKSET2: "kwikset2",
1765
- KEYNEST: "keynest"
1765
+ KEYNEST: "keynest",
1766
+ DORMAKABA_AMBIANCE: "dormakaba_ambiance"
1766
1767
  };
1767
1768
  var ALL_DEVICE_PROVIDERS = Object.values(DEVICE_PROVIDERS);
1768
1769
  var PROVIDER_CATEGORY_MAP = {
@@ -1792,7 +1793,8 @@ var PROVIDER_CATEGORY_MAP = {
1792
1793
  "latch",
1793
1794
  "akiles",
1794
1795
  "sensi",
1795
- "assa_abloy_vostio"
1796
+ "assa_abloy_vostio",
1797
+ "avigilon_alta"
1796
1798
  ],
1797
1799
  consumer_smartlocks: [
1798
1800
  "akiles",
@@ -1816,7 +1818,8 @@ var PROVIDER_CATEGORY_MAP = {
1816
1818
  "latch",
1817
1819
  "salto_ks",
1818
1820
  "assa_abloy_vostio",
1819
- "salto_space"
1821
+ "salto_space",
1822
+ "dormakaba_ambiance"
1820
1823
  ],
1821
1824
  internal_beta: ALL_DEVICE_PROVIDERS
1822
1825
  };
@@ -2806,6 +2809,7 @@ var acs_system_external_type = zod.z.enum([
2806
2809
  "assa_abloy_credential_service",
2807
2810
  "latch_building",
2808
2811
  "dormakaba_community_site",
2812
+ "dormakaba_ambiance_site",
2809
2813
  "legic_connect_credential_service",
2810
2814
  "assa_abloy_vostio",
2811
2815
  "assa_abloy_vostio_credential_service"
@@ -3789,6 +3793,144 @@ var action_attempt = zod.z.union([
3789
3793
 
3790
3794
  See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts).
3791
3795
  `);
3796
+ var client_session = zod.z.object({
3797
+ client_session_id: zod.z.string().uuid().describe(
3798
+ "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3799
+ ),
3800
+ workspace_id: zod.z.string().uuid().describe(
3801
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3802
+ ),
3803
+ created_at: zod.z.string().datetime().describe(
3804
+ "Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created."
3805
+ ),
3806
+ expires_at: zod.z.string().datetime().describe(
3807
+ "Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires."
3808
+ ),
3809
+ token: zod.z.string().describe(
3810
+ "Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3811
+ ),
3812
+ user_identifier_key: zod.z.string().nullable().describe(
3813
+ "Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3814
+ ),
3815
+ device_count: zod.z.number().describe(
3816
+ "Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3817
+ ),
3818
+ customer_id: zod.z.string().uuid().optional().describe(
3819
+ "Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3820
+ ),
3821
+ connected_account_ids: zod.z.array(zod.z.string().uuid()).describe(
3822
+ "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3823
+ ),
3824
+ connect_webview_ids: zod.z.array(zod.z.string().uuid()).describe(
3825
+ "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
3826
+ ),
3827
+ user_identity_ids: zod.z.array(zod.z.string().uuid()).describe(`
3828
+ ---
3829
+ deprecated: Use \`user_identity_id\` instead.
3830
+ ---
3831
+ IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
3832
+ `),
3833
+ user_identity_id: zod.z.string().uuid().optional().describe(
3834
+ "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session."
3835
+ )
3836
+ }).describe(`
3837
+ ---
3838
+ route_path: /client_sessions
3839
+ ---
3840
+ Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
3841
+
3842
+ You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
3843
+
3844
+ When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
3845
+
3846
+ 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.
3847
+
3848
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
3849
+ `);
3850
+ var connect_webview_device_selection_mode = zod.z.enum([
3851
+ "none",
3852
+ "single",
3853
+ "multiple"
3854
+ ]);
3855
+ var connect_webview = zod.z.object({
3856
+ connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
3857
+ workspace_id: zod.z.string().uuid().describe(
3858
+ "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview."
3859
+ ),
3860
+ created_at: zod.z.string().datetime().describe("Date and time at which the Connect Webview was created."),
3861
+ connected_account_id: zod.z.string().uuid().nullable().describe(
3862
+ "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview."
3863
+ ),
3864
+ url: zod.z.string().url().describe(
3865
+ "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
3866
+ ),
3867
+ device_selection_mode: connect_webview_device_selection_mode,
3868
+ // TODO: Use enum value.
3869
+ accepted_providers: zod.z.array(zod.z.string()).describe(
3870
+ "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
3871
+ ),
3872
+ accepted_capabilities: zod.z.array(provider_capability).describe(
3873
+ "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`."
3874
+ ),
3875
+ accepted_devices: zod.z.array(zod.z.string()).describe(
3876
+ `
3877
+ ---
3878
+ undocumented: Unused. Will be removed.
3879
+ deprecated: Unused. Will be removed.
3880
+ ---
3881
+ `
3882
+ ),
3883
+ any_device_allowed: zod.z.boolean().describe(
3884
+ `
3885
+ ---
3886
+ undocumented: Unused. Will be removed.
3887
+ deprecated: Unused. Will be removed.
3888
+ ---
3889
+ `
3890
+ ),
3891
+ any_provider_allowed: zod.z.boolean().describe("Indicates whether any provider is allowed."),
3892
+ login_successful: zod.z.boolean().describe(
3893
+ "Indicates whether the user logged in successfully using the Connect Webview."
3894
+ ),
3895
+ status: zod.z.enum(["pending", "failed", "authorized"]).describe(
3896
+ "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview."
3897
+ ),
3898
+ custom_redirect_url: zod.z.string().url().nullable().describe(
3899
+ "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs."
3900
+ ),
3901
+ custom_redirect_failure_url: zod.z.string().url().nullable().describe(
3902
+ "URL to which the Connect Webview should redirect when an unexpected error occurs."
3903
+ ),
3904
+ custom_metadata,
3905
+ automatically_manage_new_devices: zod.z.boolean().describe(
3906
+ "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/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."
3907
+ ),
3908
+ wait_for_device_creation: zod.z.boolean().describe(
3909
+ "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview."
3910
+ ),
3911
+ authorized_at: zod.z.string().datetime().nullable().describe(
3912
+ "Date and time at which the user authorized (through the Connect Webview) the management of their devices."
3913
+ ),
3914
+ selected_provider: zod.z.string().nullable().describe(
3915
+ "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
3916
+ ),
3917
+ customer_key: zod.z.string().optional().describe("The customer key associated with this webview, if any.")
3918
+ }).describe(`
3919
+ ---
3920
+ route_path: /connect_webviews
3921
+ ---
3922
+ Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
3923
+
3924
+ 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\u2014once your user has completed the authorization through your app\u2014you can access and control their devices or systems using the Seam API.
3925
+
3926
+ Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
3927
+
3928
+ To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
3929
+
3930
+ When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.
3931
+
3932
+ To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.
3933
+ `);
3792
3934
  var space = zod.z.object({
3793
3935
  space_id: zod.z.string().uuid().describe("ID of the space."),
3794
3936
  workspace_id: zod.z.string().uuid().describe(
@@ -3969,26 +4111,41 @@ zod.z.object({
3969
4111
  workspaces: workspace.array().optional(),
3970
4112
  spaces: space.array().optional(),
3971
4113
  devices: device.array().optional(),
3972
- acs_entrances: acs_entrance.array().optional()
3973
- }).describe("A batch of workspace-related resources.");
4114
+ acs_entrances: acs_entrance.array().optional(),
4115
+ acs_systems: acs_system.array().optional(),
4116
+ acs_users: acs_user.array().optional(),
4117
+ acs_access_groups: acs_access_group.array().optional(),
4118
+ acs_encoders: acs_encoder.array().optional(),
4119
+ action_attempts: action_attempt.array().optional(),
4120
+ client_sessions: client_session.array().optional(),
4121
+ unmanaged_acs_users: unmanaged_acs_user.array().optional(),
4122
+ unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
4123
+ unmanaged_devices: unmanaged_device.array().optional(),
4124
+ connect_webviews: connect_webview.array().optional()
4125
+ }).describe("A batch of workspace resources.");
3974
4126
  var batch = zod.z.object({
3975
4127
  batch_type: zod.z.enum([
3976
4128
  "workspaces",
4129
+ "spaces",
3977
4130
  "access_grants",
3978
- "access_methods",
3979
- "spaces"
4131
+ "access_methods"
3980
4132
  ]),
3981
4133
  user_identities: user_identity.array().optional(),
3982
4134
  workspaces: workspace.array().optional(),
3983
4135
  spaces: space.array().optional(),
3984
4136
  devices: device.array().optional(),
3985
- acs_entrances: acs_entrance.array().optional()
3986
- }).describe(`
3987
- ---
3988
- route_path: /
3989
- ---
3990
- Represents a resource batch.
3991
- `);
4137
+ acs_entrances: acs_entrance.array().optional(),
4138
+ acs_systems: acs_system.array().optional(),
4139
+ acs_users: acs_user.array().optional(),
4140
+ acs_access_groups: acs_access_group.array().optional(),
4141
+ acs_encoders: acs_encoder.array().optional(),
4142
+ action_attempts: action_attempt.array().optional(),
4143
+ client_sessions: client_session.array().optional(),
4144
+ unmanaged_acs_users: unmanaged_acs_user.array().optional(),
4145
+ unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
4146
+ unmanaged_devices: unmanaged_device.array().optional(),
4147
+ connect_webviews: connect_webview.array().optional()
4148
+ }).describe("A batch of workspace resources.");
3992
4149
  var bridge = zod.z.object({
3993
4150
  bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
3994
4151
  workspace_id: zod.z.string().uuid().describe(
@@ -4066,144 +4223,6 @@ var bridge_client_session = zod.z.object({
4066
4223
  ---
4067
4224
  Represents a [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) client session.
4068
4225
  `);
4069
- var client_session = zod.z.object({
4070
- client_session_id: zod.z.string().uuid().describe(
4071
- "ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4072
- ),
4073
- workspace_id: zod.z.string().uuid().describe(
4074
- "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4075
- ),
4076
- created_at: zod.z.string().datetime().describe(
4077
- "Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created."
4078
- ),
4079
- expires_at: zod.z.string().datetime().describe(
4080
- "Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires."
4081
- ),
4082
- token: zod.z.string().describe(
4083
- "Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4084
- ),
4085
- user_identifier_key: zod.z.string().nullable().describe(
4086
- "Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4087
- ),
4088
- device_count: zod.z.number().describe(
4089
- "Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4090
- ),
4091
- customer_id: zod.z.string().uuid().optional().describe(
4092
- "Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4093
- ),
4094
- connected_account_ids: zod.z.array(zod.z.string().uuid()).describe(
4095
- "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4096
- ),
4097
- connect_webview_ids: zod.z.array(zod.z.string().uuid()).describe(
4098
- "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens)."
4099
- ),
4100
- user_identity_ids: zod.z.array(zod.z.string().uuid()).describe(`
4101
- ---
4102
- deprecated: Use \`user_identity_id\` instead.
4103
- ---
4104
- IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
4105
- `),
4106
- user_identity_id: zod.z.string().uuid().optional().describe(
4107
- "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session."
4108
- )
4109
- }).describe(`
4110
- ---
4111
- route_path: /client_sessions
4112
- ---
4113
- Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
4114
-
4115
- You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
4116
-
4117
- When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
4118
-
4119
- 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.
4120
-
4121
- See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
4122
- `);
4123
- var connect_webview_device_selection_mode = zod.z.enum([
4124
- "none",
4125
- "single",
4126
- "multiple"
4127
- ]);
4128
- var connect_webview = zod.z.object({
4129
- connect_webview_id: zod.z.string().uuid().describe("ID of the Connect Webview."),
4130
- workspace_id: zod.z.string().uuid().describe(
4131
- "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Connect Webview."
4132
- ),
4133
- created_at: zod.z.string().datetime().describe("Date and time at which the Connect Webview was created."),
4134
- connected_account_id: zod.z.string().uuid().nullable().describe(
4135
- "ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the Connect Webview."
4136
- ),
4137
- url: zod.z.string().url().describe(
4138
- "URL for the Connect Webview. You use the URL to display the Connect Webview flow to your user."
4139
- ),
4140
- device_selection_mode: connect_webview_device_selection_mode,
4141
- // TODO: Use enum value.
4142
- accepted_providers: zod.z.array(zod.z.string()).describe(
4143
- "List of accepted [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
4144
- ),
4145
- accepted_capabilities: zod.z.array(provider_capability).describe(
4146
- "High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`."
4147
- ),
4148
- accepted_devices: zod.z.array(zod.z.string()).describe(
4149
- `
4150
- ---
4151
- undocumented: Unused. Will be removed.
4152
- deprecated: Unused. Will be removed.
4153
- ---
4154
- `
4155
- ),
4156
- any_device_allowed: zod.z.boolean().describe(
4157
- `
4158
- ---
4159
- undocumented: Unused. Will be removed.
4160
- deprecated: Unused. Will be removed.
4161
- ---
4162
- `
4163
- ),
4164
- any_provider_allowed: zod.z.boolean().describe("Indicates whether any provider is allowed."),
4165
- login_successful: zod.z.boolean().describe(
4166
- "Indicates whether the user logged in successfully using the Connect Webview."
4167
- ),
4168
- status: zod.z.enum(["pending", "failed", "authorized"]).describe(
4169
- "Status of the Connect Webview. `authorized` indicates that the user has successfully logged into their device or system account, thereby completing the Connect Webview."
4170
- ),
4171
- custom_redirect_url: zod.z.string().url().nullable().describe(
4172
- "URL to which the Connect Webview should redirect when the user successfully pairs a device or system. If you do not set the `custom_redirect_failure_url`, the Connect Webview redirects to the `custom_redirect_url` when an unexpected error occurs."
4173
- ),
4174
- custom_redirect_failure_url: zod.z.string().url().nullable().describe(
4175
- "URL to which the Connect Webview should redirect when an unexpected error occurs."
4176
- ),
4177
- custom_metadata,
4178
- automatically_manage_new_devices: zod.z.boolean().describe(
4179
- "Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/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."
4180
- ),
4181
- wait_for_device_creation: zod.z.boolean().describe(
4182
- "Indicates whether Seam should [finish syncing all devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#wait_for_device_creation) in a newly-connected account before completing the associated Connect Webview."
4183
- ),
4184
- authorized_at: zod.z.string().datetime().nullable().describe(
4185
- "Date and time at which the user authorized (through the Connect Webview) the management of their devices."
4186
- ),
4187
- selected_provider: zod.z.string().nullable().describe(
4188
- "Selected provider of the Connect Webview, one of the [provider keys](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews)."
4189
- ),
4190
- customer_key: zod.z.string().optional().describe("The customer key associated with this webview, if any.")
4191
- }).describe(`
4192
- ---
4193
- route_path: /connect_webviews
4194
- ---
4195
- Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
4196
-
4197
- 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\u2014once your user has completed the authorization through your app\u2014you can access and control their devices or systems using the Seam API.
4198
-
4199
- Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
4200
-
4201
- To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
4202
-
4203
- When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.
4204
-
4205
- To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.
4206
- `);
4207
4226
  var common_event = zod.z.object({
4208
4227
  event_id: zod.z.string().uuid().describe("ID of the event."),
4209
4228
  workspace_id: zod.z.string().uuid().describe(
@@ -8194,6 +8213,7 @@ var openapi_default = {
8194
8213
  "assa_abloy_credential_service",
8195
8214
  "latch_building",
8196
8215
  "dormakaba_community_site",
8216
+ "dormakaba_ambiance_site",
8197
8217
  "legic_connect_credential_service",
8198
8218
  "assa_abloy_vostio",
8199
8219
  "assa_abloy_vostio_credential_service"
@@ -8244,6 +8264,7 @@ var openapi_default = {
8244
8264
  "assa_abloy_credential_service",
8245
8265
  "latch_building",
8246
8266
  "dormakaba_community_site",
8267
+ "dormakaba_ambiance_site",
8247
8268
  "legic_connect_credential_service",
8248
8269
  "assa_abloy_vostio",
8249
8270
  "assa_abloy_vostio_credential_service"
@@ -16922,7 +16943,8 @@ var openapi_default = {
16922
16943
  "salto_space",
16923
16944
  "sensi",
16924
16945
  "kwikset2",
16925
- "keynest"
16946
+ "keynest",
16947
+ "dormakaba_ambiance"
16926
16948
  ],
16927
16949
  type: "string"
16928
16950
  },
@@ -30492,6 +30514,12 @@ var openapi_default = {
30492
30514
  description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
30493
30515
  nullable: true,
30494
30516
  type: "string"
30517
+ },
30518
+ user_identity_key: {
30519
+ description: "Unique key for the user identity.",
30520
+ minLength: 1,
30521
+ nullable: true,
30522
+ type: "string"
30495
30523
  }
30496
30524
  },
30497
30525
  type: "object"
@@ -31277,7 +31305,6 @@ var openapi_default = {
31277
31305
  starts_at: {
31278
31306
  description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
31279
31307
  format: "date-time",
31280
- nullable: true,
31281
31308
  type: "string"
31282
31309
  }
31283
31310
  },
@@ -31344,7 +31371,6 @@ var openapi_default = {
31344
31371
  starts_at: {
31345
31372
  description: "Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
31346
31373
  format: "date-time",
31347
- nullable: true,
31348
31374
  type: "string"
31349
31375
  }
31350
31376
  },
@@ -31696,21 +31722,57 @@ var openapi_default = {
31696
31722
  schema: {
31697
31723
  properties: {
31698
31724
  batch: {
31699
- description: "Represents a resource batch.",
31725
+ description: "A batch of workspace resources.",
31700
31726
  properties: {
31727
+ acs_access_groups: {
31728
+ items: {
31729
+ $ref: "#/components/schemas/acs_access_group"
31730
+ },
31731
+ type: "array"
31732
+ },
31733
+ acs_encoders: {
31734
+ items: { $ref: "#/components/schemas/acs_encoder" },
31735
+ type: "array"
31736
+ },
31701
31737
  acs_entrances: {
31702
31738
  items: { $ref: "#/components/schemas/acs_entrance" },
31703
31739
  type: "array"
31704
31740
  },
31741
+ acs_systems: {
31742
+ items: { $ref: "#/components/schemas/acs_system" },
31743
+ type: "array"
31744
+ },
31745
+ acs_users: {
31746
+ items: { $ref: "#/components/schemas/acs_user" },
31747
+ type: "array"
31748
+ },
31749
+ action_attempts: {
31750
+ items: {
31751
+ $ref: "#/components/schemas/action_attempt"
31752
+ },
31753
+ type: "array"
31754
+ },
31705
31755
  batch_type: {
31706
31756
  enum: [
31707
31757
  "workspaces",
31758
+ "spaces",
31708
31759
  "access_grants",
31709
- "access_methods",
31710
- "spaces"
31760
+ "access_methods"
31711
31761
  ],
31712
31762
  type: "string"
31713
31763
  },
31764
+ client_sessions: {
31765
+ items: {
31766
+ $ref: "#/components/schemas/client_session"
31767
+ },
31768
+ type: "array"
31769
+ },
31770
+ connect_webviews: {
31771
+ items: {
31772
+ $ref: "#/components/schemas/connect_webview"
31773
+ },
31774
+ type: "array"
31775
+ },
31714
31776
  devices: {
31715
31777
  items: { $ref: "#/components/schemas/device" },
31716
31778
  type: "array"
@@ -31719,6 +31781,24 @@ var openapi_default = {
31719
31781
  items: { $ref: "#/components/schemas/space" },
31720
31782
  type: "array"
31721
31783
  },
31784
+ unmanaged_acs_access_groups: {
31785
+ items: {
31786
+ $ref: "#/components/schemas/unmanaged_acs_access_group"
31787
+ },
31788
+ type: "array"
31789
+ },
31790
+ unmanaged_acs_users: {
31791
+ items: {
31792
+ $ref: "#/components/schemas/unmanaged_acs_user"
31793
+ },
31794
+ type: "array"
31795
+ },
31796
+ unmanaged_devices: {
31797
+ items: {
31798
+ $ref: "#/components/schemas/unmanaged_device"
31799
+ },
31800
+ type: "array"
31801
+ },
31722
31802
  user_identities: {
31723
31803
  items: { $ref: "#/components/schemas/user_identity" },
31724
31804
  type: "array"
@@ -31729,8 +31809,7 @@ var openapi_default = {
31729
31809
  }
31730
31810
  },
31731
31811
  required: ["batch_type"],
31732
- type: "object",
31733
- "x-route-path": "/"
31812
+ type: "object"
31734
31813
  },
31735
31814
  ok: { type: "boolean" }
31736
31815
  },
@@ -31800,21 +31879,57 @@ var openapi_default = {
31800
31879
  schema: {
31801
31880
  properties: {
31802
31881
  batch: {
31803
- description: "Represents a resource batch.",
31882
+ description: "A batch of workspace resources.",
31804
31883
  properties: {
31884
+ acs_access_groups: {
31885
+ items: {
31886
+ $ref: "#/components/schemas/acs_access_group"
31887
+ },
31888
+ type: "array"
31889
+ },
31890
+ acs_encoders: {
31891
+ items: { $ref: "#/components/schemas/acs_encoder" },
31892
+ type: "array"
31893
+ },
31805
31894
  acs_entrances: {
31806
31895
  items: { $ref: "#/components/schemas/acs_entrance" },
31807
31896
  type: "array"
31808
31897
  },
31898
+ acs_systems: {
31899
+ items: { $ref: "#/components/schemas/acs_system" },
31900
+ type: "array"
31901
+ },
31902
+ acs_users: {
31903
+ items: { $ref: "#/components/schemas/acs_user" },
31904
+ type: "array"
31905
+ },
31906
+ action_attempts: {
31907
+ items: {
31908
+ $ref: "#/components/schemas/action_attempt"
31909
+ },
31910
+ type: "array"
31911
+ },
31809
31912
  batch_type: {
31810
31913
  enum: [
31811
31914
  "workspaces",
31915
+ "spaces",
31812
31916
  "access_grants",
31813
- "access_methods",
31814
- "spaces"
31917
+ "access_methods"
31815
31918
  ],
31816
31919
  type: "string"
31817
31920
  },
31921
+ client_sessions: {
31922
+ items: {
31923
+ $ref: "#/components/schemas/client_session"
31924
+ },
31925
+ type: "array"
31926
+ },
31927
+ connect_webviews: {
31928
+ items: {
31929
+ $ref: "#/components/schemas/connect_webview"
31930
+ },
31931
+ type: "array"
31932
+ },
31818
31933
  devices: {
31819
31934
  items: { $ref: "#/components/schemas/device" },
31820
31935
  type: "array"
@@ -31823,6 +31938,24 @@ var openapi_default = {
31823
31938
  items: { $ref: "#/components/schemas/space" },
31824
31939
  type: "array"
31825
31940
  },
31941
+ unmanaged_acs_access_groups: {
31942
+ items: {
31943
+ $ref: "#/components/schemas/unmanaged_acs_access_group"
31944
+ },
31945
+ type: "array"
31946
+ },
31947
+ unmanaged_acs_users: {
31948
+ items: {
31949
+ $ref: "#/components/schemas/unmanaged_acs_user"
31950
+ },
31951
+ type: "array"
31952
+ },
31953
+ unmanaged_devices: {
31954
+ items: {
31955
+ $ref: "#/components/schemas/unmanaged_device"
31956
+ },
31957
+ type: "array"
31958
+ },
31826
31959
  user_identities: {
31827
31960
  items: { $ref: "#/components/schemas/user_identity" },
31828
31961
  type: "array"
@@ -31833,8 +31966,7 @@ var openapi_default = {
31833
31966
  }
31834
31967
  },
31835
31968
  required: ["batch_type"],
31836
- type: "object",
31837
- "x-route-path": "/"
31969
+ type: "object"
31838
31970
  },
31839
31971
  ok: { type: "boolean" }
31840
31972
  },
@@ -38966,6 +39098,7 @@ var openapi_default = {
38966
39098
  "sensi",
38967
39099
  "kwikset2",
38968
39100
  "keynest",
39101
+ "dormakaba_ambiance",
38969
39102
  "yale_access",
38970
39103
  "hid_cm",
38971
39104
  "google_nest"
@@ -44523,6 +44656,107 @@ var openapi_default = {
44523
44656
  "x-title": "List Events"
44524
44657
  }
44525
44658
  },
44659
+ "/instant_keys/get": {
44660
+ get: {
44661
+ description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
44662
+ operationId: "instantKeysGetGet",
44663
+ parameters: [
44664
+ {
44665
+ in: "query",
44666
+ name: "instant_key_id",
44667
+ required: true,
44668
+ schema: {
44669
+ description: "ID of the instant key to get.",
44670
+ format: "uuid",
44671
+ type: "string"
44672
+ }
44673
+ }
44674
+ ],
44675
+ responses: {
44676
+ 200: {
44677
+ content: {
44678
+ "application/json": {
44679
+ schema: {
44680
+ properties: {
44681
+ instant_key: { $ref: "#/components/schemas/instant_key" },
44682
+ ok: { type: "boolean" }
44683
+ },
44684
+ required: ["instant_key", "ok"],
44685
+ type: "object"
44686
+ }
44687
+ }
44688
+ },
44689
+ description: "OK"
44690
+ },
44691
+ 400: { description: "Bad Request" },
44692
+ 401: { description: "Unauthorized" }
44693
+ },
44694
+ security: [
44695
+ { api_key: [] },
44696
+ { pat_with_workspace: [] },
44697
+ { console_session_with_workspace: [] }
44698
+ ],
44699
+ summary: "/instant_keys/get",
44700
+ tags: [],
44701
+ "x-fern-sdk-group-name": ["instant_keys"],
44702
+ "x-fern-sdk-method-name": "get",
44703
+ "x-fern-sdk-return-value": "instant_key",
44704
+ "x-response-key": "instant_key",
44705
+ "x-title": "Get an Instant Key"
44706
+ },
44707
+ post: {
44708
+ description: "Gets an [instant key](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
44709
+ operationId: "instantKeysGetPost",
44710
+ requestBody: {
44711
+ content: {
44712
+ "application/json": {
44713
+ schema: {
44714
+ properties: {
44715
+ instant_key_id: {
44716
+ description: "ID of the instant key to get.",
44717
+ format: "uuid",
44718
+ type: "string"
44719
+ }
44720
+ },
44721
+ required: ["instant_key_id"],
44722
+ type: "object"
44723
+ }
44724
+ }
44725
+ }
44726
+ },
44727
+ responses: {
44728
+ 200: {
44729
+ content: {
44730
+ "application/json": {
44731
+ schema: {
44732
+ properties: {
44733
+ instant_key: { $ref: "#/components/schemas/instant_key" },
44734
+ ok: { type: "boolean" }
44735
+ },
44736
+ required: ["instant_key", "ok"],
44737
+ type: "object"
44738
+ }
44739
+ }
44740
+ },
44741
+ description: "OK"
44742
+ },
44743
+ 400: { description: "Bad Request" },
44744
+ 401: { description: "Unauthorized" }
44745
+ },
44746
+ security: [
44747
+ { api_key: [] },
44748
+ { pat_with_workspace: [] },
44749
+ { console_session_with_workspace: [] }
44750
+ ],
44751
+ summary: "/instant_keys/get",
44752
+ tags: [],
44753
+ "x-fern-sdk-group-name": ["instant_keys"],
44754
+ "x-fern-sdk-method-name": "get",
44755
+ "x-fern-sdk-return-value": "instant_key",
44756
+ "x-response-key": "instant_key",
44757
+ "x-title": "Get an Instant Key"
44758
+ }
44759
+ },
44526
44760
  "/instant_keys/list": {
44527
44761
  get: {
44528
44762
  description: "Returns a list of all [instant keys](https://docs.seam.co/latest/capability-guides/mobile-access/instant-keys).",
@@ -58004,21 +58238,57 @@ var openapi_default = {
58004
58238
  schema: {
58005
58239
  properties: {
58006
58240
  batch: {
58007
- description: "Represents a resource batch.",
58241
+ description: "A batch of workspace resources.",
58008
58242
  properties: {
58243
+ acs_access_groups: {
58244
+ items: {
58245
+ $ref: "#/components/schemas/acs_access_group"
58246
+ },
58247
+ type: "array"
58248
+ },
58249
+ acs_encoders: {
58250
+ items: { $ref: "#/components/schemas/acs_encoder" },
58251
+ type: "array"
58252
+ },
58009
58253
  acs_entrances: {
58010
58254
  items: { $ref: "#/components/schemas/acs_entrance" },
58011
58255
  type: "array"
58012
58256
  },
58257
+ acs_systems: {
58258
+ items: { $ref: "#/components/schemas/acs_system" },
58259
+ type: "array"
58260
+ },
58261
+ acs_users: {
58262
+ items: { $ref: "#/components/schemas/acs_user" },
58263
+ type: "array"
58264
+ },
58265
+ action_attempts: {
58266
+ items: {
58267
+ $ref: "#/components/schemas/action_attempt"
58268
+ },
58269
+ type: "array"
58270
+ },
58013
58271
  batch_type: {
58014
58272
  enum: [
58015
58273
  "workspaces",
58274
+ "spaces",
58016
58275
  "access_grants",
58017
- "access_methods",
58018
- "spaces"
58276
+ "access_methods"
58019
58277
  ],
58020
58278
  type: "string"
58021
58279
  },
58280
+ client_sessions: {
58281
+ items: {
58282
+ $ref: "#/components/schemas/client_session"
58283
+ },
58284
+ type: "array"
58285
+ },
58286
+ connect_webviews: {
58287
+ items: {
58288
+ $ref: "#/components/schemas/connect_webview"
58289
+ },
58290
+ type: "array"
58291
+ },
58022
58292
  devices: {
58023
58293
  items: { $ref: "#/components/schemas/device" },
58024
58294
  type: "array"
@@ -58027,6 +58297,24 @@ var openapi_default = {
58027
58297
  items: { $ref: "#/components/schemas/space" },
58028
58298
  type: "array"
58029
58299
  },
58300
+ unmanaged_acs_access_groups: {
58301
+ items: {
58302
+ $ref: "#/components/schemas/unmanaged_acs_access_group"
58303
+ },
58304
+ type: "array"
58305
+ },
58306
+ unmanaged_acs_users: {
58307
+ items: {
58308
+ $ref: "#/components/schemas/unmanaged_acs_user"
58309
+ },
58310
+ type: "array"
58311
+ },
58312
+ unmanaged_devices: {
58313
+ items: {
58314
+ $ref: "#/components/schemas/unmanaged_device"
58315
+ },
58316
+ type: "array"
58317
+ },
58030
58318
  user_identities: {
58031
58319
  items: { $ref: "#/components/schemas/user_identity" },
58032
58320
  type: "array"
@@ -58037,8 +58325,7 @@ var openapi_default = {
58037
58325
  }
58038
58326
  },
58039
58327
  required: ["batch_type"],
58040
- type: "object",
58041
- "x-route-path": "/"
58328
+ type: "object"
58042
58329
  },
58043
58330
  ok: { type: "boolean" }
58044
58331
  },
@@ -58085,21 +58372,57 @@ var openapi_default = {
58085
58372
  schema: {
58086
58373
  properties: {
58087
58374
  batch: {
58088
- description: "Represents a resource batch.",
58375
+ description: "A batch of workspace resources.",
58089
58376
  properties: {
58377
+ acs_access_groups: {
58378
+ items: {
58379
+ $ref: "#/components/schemas/acs_access_group"
58380
+ },
58381
+ type: "array"
58382
+ },
58383
+ acs_encoders: {
58384
+ items: { $ref: "#/components/schemas/acs_encoder" },
58385
+ type: "array"
58386
+ },
58090
58387
  acs_entrances: {
58091
58388
  items: { $ref: "#/components/schemas/acs_entrance" },
58092
58389
  type: "array"
58093
58390
  },
58391
+ acs_systems: {
58392
+ items: { $ref: "#/components/schemas/acs_system" },
58393
+ type: "array"
58394
+ },
58395
+ acs_users: {
58396
+ items: { $ref: "#/components/schemas/acs_user" },
58397
+ type: "array"
58398
+ },
58399
+ action_attempts: {
58400
+ items: {
58401
+ $ref: "#/components/schemas/action_attempt"
58402
+ },
58403
+ type: "array"
58404
+ },
58094
58405
  batch_type: {
58095
58406
  enum: [
58096
58407
  "workspaces",
58408
+ "spaces",
58097
58409
  "access_grants",
58098
- "access_methods",
58099
- "spaces"
58410
+ "access_methods"
58100
58411
  ],
58101
58412
  type: "string"
58102
58413
  },
58414
+ client_sessions: {
58415
+ items: {
58416
+ $ref: "#/components/schemas/client_session"
58417
+ },
58418
+ type: "array"
58419
+ },
58420
+ connect_webviews: {
58421
+ items: {
58422
+ $ref: "#/components/schemas/connect_webview"
58423
+ },
58424
+ type: "array"
58425
+ },
58103
58426
  devices: {
58104
58427
  items: { $ref: "#/components/schemas/device" },
58105
58428
  type: "array"
@@ -58108,6 +58431,24 @@ var openapi_default = {
58108
58431
  items: { $ref: "#/components/schemas/space" },
58109
58432
  type: "array"
58110
58433
  },
58434
+ unmanaged_acs_access_groups: {
58435
+ items: {
58436
+ $ref: "#/components/schemas/unmanaged_acs_access_group"
58437
+ },
58438
+ type: "array"
58439
+ },
58440
+ unmanaged_acs_users: {
58441
+ items: {
58442
+ $ref: "#/components/schemas/unmanaged_acs_user"
58443
+ },
58444
+ type: "array"
58445
+ },
58446
+ unmanaged_devices: {
58447
+ items: {
58448
+ $ref: "#/components/schemas/unmanaged_device"
58449
+ },
58450
+ type: "array"
58451
+ },
58111
58452
  user_identities: {
58112
58453
  items: { $ref: "#/components/schemas/user_identity" },
58113
58454
  type: "array"
@@ -58118,8 +58459,7 @@ var openapi_default = {
58118
58459
  }
58119
58460
  },
58120
58461
  required: ["batch_type"],
58121
- type: "object",
58122
- "x-route-path": "/"
58462
+ type: "object"
58123
58463
  },
58124
58464
  ok: { type: "boolean" }
58125
58465
  },