@seamapi/types 1.399.0 → 1.399.1

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 (42) hide show
  1. package/dist/connect.cjs +877 -295
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +835 -178
  4. package/lib/seam/connect/models/access-codes/managed-access-code.js +8 -2
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +4 -0
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  8. package/lib/seam/connect/models/client-sessions/client-session.js +9 -0
  9. package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
  10. package/lib/seam/connect/models/connect-webviews/connect-webview.js +13 -0
  11. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  12. package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -0
  13. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  14. package/lib/seam/connect/models/devices/capability-properties/access-code.js +4 -1
  15. package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.js +5 -1
  17. package/lib/seam/connect/models/devices/device.js.map +1 -1
  18. package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
  19. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  20. package/lib/seam/connect/models/events/seam-event.js +3 -0
  21. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  22. package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
  23. package/lib/seam/connect/models/workspaces/workspace.js +1 -0
  24. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  25. package/lib/seam/connect/openapi.d.ts +371 -0
  26. package/lib/seam/connect/openapi.js +795 -256
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +464 -178
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +8 -2
  31. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +4 -0
  32. package/src/lib/seam/connect/models/client-sessions/client-session.ts +9 -0
  33. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +13 -0
  34. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -0
  35. package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +6 -1
  36. package/src/lib/seam/connect/models/devices/device.ts +7 -1
  37. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
  38. package/src/lib/seam/connect/models/events/seam-event.ts +3 -0
  39. package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
  40. package/src/lib/seam/connect/models/workspaces/workspace.ts +1 -0
  41. package/src/lib/seam/connect/openapi.ts +996 -256
  42. package/src/lib/seam/connect/route-types.ts +466 -178
package/dist/connect.cjs CHANGED
@@ -90,7 +90,9 @@ var access_code_constraint = zod.z.union([
90
90
  ]);
91
91
  var access_code_capability_properties = zod.z.object({
92
92
  _experimental_supported_code_from_access_codes_lengths: zod.z.array(zod.z.number()).optional(),
93
- code_constraints: zod.z.array(access_code_constraint).optional(),
93
+ code_constraints: zod.z.array(access_code_constraint).optional().describe(
94
+ "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific."
95
+ ),
94
96
  supported_code_lengths: zod.z.array(zod.z.number()).optional(),
95
97
  max_active_codes_supported: zod.z.number().optional(),
96
98
  supports_backup_access_code_pool: zod.z.boolean().optional(),
@@ -629,6 +631,7 @@ var connected_account = zod.z.object({
629
631
  ---
630
632
  route_path: /connected_accounts
631
633
  ---
634
+ Represents a [connected account](https://docs.seam.co/latest/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.
632
635
  `);
633
636
  var dormakaba_oracode_time_slot = zod.z.object({
634
637
  name: zod.z.string(),
@@ -1199,7 +1202,9 @@ var common_device_properties = zod.z.object({
1199
1202
  'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.'
1200
1203
  ),
1201
1204
  // todo: use enum
1202
- manufacturer: zod.z.string().optional().describe("Manufacturer of the device."),
1205
+ manufacturer: zod.z.string().optional().describe(
1206
+ "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub."
1207
+ ),
1203
1208
  image_url: zod.z.string().url().optional().describe("Image URL for the device."),
1204
1209
  image_alt_text: zod.z.string().optional().describe("Alt text for the device image."),
1205
1210
  serial_number: zod.z.string().optional().describe("Serial number of the device."),
@@ -1282,6 +1287,7 @@ var device = zod.z.object({
1282
1287
  ---
1283
1288
  route_path: /devices
1284
1289
  ---
1290
+ Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.
1285
1291
  `);
1286
1292
  var DEVICE_PROVIDERS = {
1287
1293
  DORMAKABA_COMMUNITY: "dormakaba_community",
@@ -1433,6 +1439,7 @@ var unmanaged_device = device.pick({
1433
1439
  ---
1434
1440
  route_path: /devices/unmanaged
1435
1441
  ---
1442
+ Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
1436
1443
  `);
1437
1444
 
1438
1445
  // src/lib/seam/connect/models/access-codes/managed-access-code.ts
@@ -1674,7 +1681,13 @@ var access_code = zod.z.object({
1674
1681
  "Unique identifier for the device associated with the access code."
1675
1682
  ),
1676
1683
  name: zod.z.string().nullable().describe(
1677
- "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes."
1684
+ `Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1685
+
1686
+ Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as \`first_name\` and \`last_name\`.
1687
+
1688
+ To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
1689
+
1690
+ To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called \`appearance\`. This is an object with a \`name\` property and, optionally, \`first_name\` and \`last_name\` properties (for providers that break down a name into components).`
1678
1691
  ),
1679
1692
  code: zod.z.string().nullable().describe(
1680
1693
  "Code used for access. Typically, a numeric or alphanumeric string."
@@ -1725,7 +1738,7 @@ var access_code = zod.z.object({
1725
1738
 
1726
1739
  An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
1727
1740
 
1728
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`.
1741
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.
1729
1742
 
1730
1743
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
1731
1744
  `);
@@ -1757,6 +1770,10 @@ var unmanaged_access_code = access_code.pick({
1757
1770
  When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
1758
1771
 
1759
1772
  Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
1773
+
1774
+ Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
1775
+
1776
+ - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
1760
1777
  `);
1761
1778
  var access_method = zod.z.object({
1762
1779
  workspace_id: zod.z.string().uuid().describe(
@@ -3308,6 +3325,15 @@ var client_session = zod.z.object({
3308
3325
  ---
3309
3326
  route_path: /client_sessions
3310
3327
  ---
3328
+ 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.
3329
+
3330
+ You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
3331
+
3332
+ 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\`.
3333
+
3334
+ 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.
3335
+
3336
+ 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).
3311
3337
  `);
3312
3338
  var connect_webview_device_selection_mode = zod.z.enum([
3313
3339
  "none",
@@ -3326,6 +3352,7 @@ var connect_webview = zod.z.object({
3326
3352
  accepted_devices: zod.z.array(zod.z.string()).describe(
3327
3353
  `
3328
3354
  ---
3355
+ undocumented: Unused. Will be removed.
3329
3356
  deprecated: Unused. Will be removed.
3330
3357
  ---
3331
3358
  `
@@ -3333,6 +3360,7 @@ var connect_webview = zod.z.object({
3333
3360
  any_device_allowed: zod.z.boolean().describe(
3334
3361
  `
3335
3362
  ---
3363
+ undocumented: Unused. Will be removed.
3336
3364
  deprecated: Unused. Will be removed.
3337
3365
  ---
3338
3366
  `
@@ -3351,6 +3379,17 @@ var connect_webview = zod.z.object({
3351
3379
  ---
3352
3380
  route_path: /connect_webviews
3353
3381
  ---
3382
+ Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
3383
+
3384
+ 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.
3385
+
3386
+ 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.
3387
+
3388
+ 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.
3389
+
3390
+ 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.
3391
+
3392
+ 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.
3354
3393
  `);
3355
3394
  var common_event = zod.z.object({
3356
3395
  event_id: zod.z.string().uuid().describe("ID of the event."),
@@ -4451,6 +4490,9 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
4451
4490
  ---
4452
4491
  route_path: /events
4453
4492
  ---
4493
+ Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
4494
+
4495
+ As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
4454
4496
  `);
4455
4497
  var event_types = seam_event.options.map(
4456
4498
  (schema) => schema.shape.event_type.value
@@ -4513,7 +4555,7 @@ var user_identity = zod.z.object({
4513
4555
  ---
4514
4556
  route_path: /user_identities
4515
4557
  ---
4516
- Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
4558
+ Represents a [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 an application user account.
4517
4559
  `);
4518
4560
  var webhook = zod.z.object({
4519
4561
  webhook_id: zod.z.string(),
@@ -4557,6 +4599,7 @@ var workspace = zod.z.object({
4557
4599
  ---
4558
4600
  route_path: /workspaces
4559
4601
  ---
4602
+ Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).
4560
4603
  `);
4561
4604
 
4562
4605
  // src/lib/seam/connect/openapi.ts
@@ -4564,7 +4607,7 @@ var openapi_default = {
4564
4607
  components: {
4565
4608
  schemas: {
4566
4609
  access_code: {
4567
- description: "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.",
4610
+ description: "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.",
4568
4611
  properties: {
4569
4612
  access_code_id: {
4570
4613
  description: "Unique identifier for the access code.",
@@ -5604,7 +5647,7 @@ var openapi_default = {
5604
5647
  type: "boolean"
5605
5648
  },
5606
5649
  name: {
5607
- description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
5650
+ description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
5608
5651
  nullable: true,
5609
5652
  type: "string"
5610
5653
  },
@@ -10965,6 +11008,7 @@ var openapi_default = {
10965
11008
  "x-route-path": "/action_attempts"
10966
11009
  },
10967
11010
  client_session: {
11011
+ description: "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.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen 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`.\n\nA 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.\n\nSee 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).",
10968
11012
  properties: {
10969
11013
  client_session_id: { format: "uuid", type: "string" },
10970
11014
  connect_webview_ids: {
@@ -11002,18 +11046,21 @@ var openapi_default = {
11002
11046
  "x-route-path": "/client_sessions"
11003
11047
  },
11004
11048
  connect_webview: {
11049
+ description: "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect 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.\n\nConnect 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.\n\nTo 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.\n\nWhen 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.\n\nTo 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.",
11005
11050
  properties: {
11006
11051
  accepted_devices: {
11007
11052
  deprecated: true,
11008
11053
  items: { type: "string" },
11009
11054
  type: "array",
11010
- "x-deprecated": "Unused. Will be removed."
11055
+ "x-deprecated": "Unused. Will be removed.",
11056
+ "x-undocumented": "Unused. Will be removed."
11011
11057
  },
11012
11058
  accepted_providers: { items: { type: "string" }, type: "array" },
11013
11059
  any_device_allowed: {
11014
11060
  deprecated: true,
11015
11061
  type: "boolean",
11016
- "x-deprecated": "Unused. Will be removed."
11062
+ "x-deprecated": "Unused. Will be removed.",
11063
+ "x-undocumented": "Unused. Will be removed."
11017
11064
  },
11018
11065
  any_provider_allowed: { type: "boolean" },
11019
11066
  authorized_at: {
@@ -11081,6 +11128,7 @@ var openapi_default = {
11081
11128
  "x-route-path": "/connect_webviews"
11082
11129
  },
11083
11130
  connected_account: {
11131
+ description: "Represents a [connected account](https://docs.seam.co/latest/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.",
11084
11132
  properties: {
11085
11133
  account_type: { type: "string" },
11086
11134
  account_type_display_name: { type: "string" },
@@ -11336,6 +11384,7 @@ var openapi_default = {
11336
11384
  "x-route-path": "/connected_accounts"
11337
11385
  },
11338
11386
  device: {
11387
+ description: "Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.",
11339
11388
  properties: {
11340
11389
  can_hvac_cool: { type: "boolean" },
11341
11390
  can_hvac_heat: { type: "boolean" },
@@ -11873,7 +11922,7 @@ var openapi_default = {
11873
11922
  type: "string"
11874
11923
  },
11875
11924
  manufacturer: {
11876
- description: "Manufacturer of the device.",
11925
+ description: "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.",
11877
11926
  type: "string"
11878
11927
  },
11879
11928
  model: {
@@ -12549,6 +12598,7 @@ var openapi_default = {
12549
12598
  type: "array"
12550
12599
  },
12551
12600
  code_constraints: {
12601
+ description: "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.",
12552
12602
  items: {
12553
12603
  oneOf: [
12554
12604
  {
@@ -13564,6 +13614,7 @@ var openapi_default = {
13564
13614
  "x-route-path": "/user_identities/enrollment_automations"
13565
13615
  },
13566
13616
  event: {
13617
+ description: "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.",
13567
13618
  discriminator: { propertyName: "event_type" },
13568
13619
  oneOf: [
13569
13620
  {
@@ -18488,7 +18539,7 @@ var openapi_default = {
18488
18539
  "x-route-path": "/thermostats/schedules"
18489
18540
  },
18490
18541
  unmanaged_access_code: {
18491
- description: "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.",
18542
+ description: "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.\n\nNot all providers support unmanaged access codes. The following providers do not support unmanaged access codes:\n\n- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)",
18492
18543
  properties: {
18493
18544
  access_code_id: {
18494
18545
  description: "Unique identifier for the access code.",
@@ -19495,7 +19546,7 @@ var openapi_default = {
19495
19546
  type: "boolean"
19496
19547
  },
19497
19548
  name: {
19498
- description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
19549
+ description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
19499
19550
  nullable: true,
19500
19551
  type: "string"
19501
19552
  },
@@ -20792,6 +20843,7 @@ var openapi_default = {
20792
20843
  "x-route-path": "/acs/users/unmanaged"
20793
20844
  },
20794
20845
  unmanaged_device: {
20846
+ description: "Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
20795
20847
  properties: {
20796
20848
  can_hvac_cool: { type: "boolean" },
20797
20849
  can_hvac_heat: { type: "boolean" },
@@ -21286,7 +21338,7 @@ var openapi_default = {
21286
21338
  type: "string"
21287
21339
  },
21288
21340
  manufacturer: {
21289
- description: "Manufacturer of the device.",
21341
+ description: "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.",
21290
21342
  type: "string"
21291
21343
  },
21292
21344
  model: {
@@ -21616,7 +21668,7 @@ var openapi_default = {
21616
21668
  "x-route-path": "/devices/unmanaged"
21617
21669
  },
21618
21670
  user_identity: {
21619
- description: "Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.",
21671
+ description: "Represents a [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 an application user account.",
21620
21672
  properties: {
21621
21673
  created_at: {
21622
21674
  description: "Date and time at which the user identity was created.",
@@ -21678,6 +21730,7 @@ var openapi_default = {
21678
21730
  "x-route-path": "/webhooks"
21679
21731
  },
21680
21732
  workspace: {
21733
+ description: "Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).",
21681
21734
  properties: {
21682
21735
  company_name: { type: "string" },
21683
21736
  connect_partner_name: {
@@ -21809,7 +21862,7 @@ var openapi_default = {
21809
21862
  type: "string"
21810
21863
  },
21811
21864
  device_id: {
21812
- description: "ID of the device for which to create the new access code.",
21865
+ description: "ID of the device for which you want to create the new access code.",
21813
21866
  format: "uuid",
21814
21867
  type: "string"
21815
21868
  },
@@ -21836,7 +21889,7 @@ var openapi_default = {
21836
21889
  type: "string"
21837
21890
  },
21838
21891
  name: {
21839
- description: "Name of the new access code.",
21892
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21840
21893
  type: "string"
21841
21894
  },
21842
21895
  prefer_native_scheduling: {
@@ -21938,7 +21991,7 @@ var openapi_default = {
21938
21991
  type: "string"
21939
21992
  },
21940
21993
  device_ids: {
21941
- description: "IDs of the devices for which to create the new access codes.",
21994
+ description: "IDs of the devices for which you want to create the new access codes.",
21942
21995
  items: { format: "uuid", type: "string" },
21943
21996
  type: "array"
21944
21997
  },
@@ -21965,7 +22018,7 @@ var openapi_default = {
21965
22018
  type: "string"
21966
22019
  },
21967
22020
  name: {
21968
- description: "Name of the new access code.",
22021
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21969
22022
  type: "string"
21970
22023
  },
21971
22024
  prefer_native_scheduling: {
@@ -22059,7 +22112,7 @@ var openapi_default = {
22059
22112
  type: "string"
22060
22113
  },
22061
22114
  device_ids: {
22062
- description: "IDs of the devices for which to create the new access codes.",
22115
+ description: "IDs of the devices for which you want to create the new access codes.",
22063
22116
  items: { format: "uuid", type: "string" },
22064
22117
  type: "array"
22065
22118
  },
@@ -22086,7 +22139,7 @@ var openapi_default = {
22086
22139
  type: "string"
22087
22140
  },
22088
22141
  name: {
22089
- description: "Name of the new access code.",
22142
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
22090
22143
  type: "string"
22091
22144
  },
22092
22145
  prefer_native_scheduling: {
@@ -22159,12 +22212,12 @@ var openapi_default = {
22159
22212
  schema: {
22160
22213
  properties: {
22161
22214
  access_code_id: {
22162
- description: "ID of the access code to delete.",
22215
+ description: "ID of the access code that you want to delete.",
22163
22216
  format: "uuid",
22164
22217
  type: "string"
22165
22218
  },
22166
22219
  device_id: {
22167
- description: "ID of the device for which to delete the access code.",
22220
+ description: "ID of the device for which you want to delete the access code.",
22168
22221
  format: "uuid",
22169
22222
  type: "string"
22170
22223
  },
@@ -22218,12 +22271,19 @@ var openapi_default = {
22218
22271
  },
22219
22272
  "/access_codes/generate_code": {
22220
22273
  post: {
22274
+ description: "Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.",
22221
22275
  operationId: "accessCodesGenerateCodePost",
22222
22276
  requestBody: {
22223
22277
  content: {
22224
22278
  "application/json": {
22225
22279
  schema: {
22226
- properties: { device_id: { format: "uuid", type: "string" } },
22280
+ properties: {
22281
+ device_id: {
22282
+ description: "ID of the device for which you want to generate a code.",
22283
+ format: "uuid",
22284
+ type: "string"
22285
+ }
22286
+ },
22227
22287
  required: ["device_id"],
22228
22288
  type: "object"
22229
22289
  }
@@ -22262,7 +22322,8 @@ var openapi_default = {
22262
22322
  "x-fern-sdk-group-name": ["access_codes"],
22263
22323
  "x-fern-sdk-method-name": "generate_code",
22264
22324
  "x-fern-sdk-return-value": "generated_code",
22265
- "x-response-key": "generated_code"
22325
+ "x-response-key": "generated_code",
22326
+ "x-title": "Generate a Code"
22266
22327
  }
22267
22328
  },
22268
22329
  "/access_codes/get": {
@@ -22408,7 +22469,7 @@ var openapi_default = {
22408
22469
  },
22409
22470
  "/access_codes/pull_backup_access_code": {
22410
22471
  post: {
22411
- description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code\u2014be it due to intermittent connectivity, manual removal from a device, or provider outages\u2014a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
22472
+ description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code\u2014be it due to intermittent connectivity, manual removal from a device, or provider outages\u2014a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
22412
22473
  operationId: "accessCodesPullBackupAccessCodePost",
22413
22474
  requestBody: {
22414
22475
  content: {
@@ -22466,7 +22527,7 @@ var openapi_default = {
22466
22527
  },
22467
22528
  "/access_codes/report_device_constraints": {
22468
22529
  post: {
22469
- description: "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.",
22530
+ description: "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.",
22470
22531
  operationId: "accessCodesReportDeviceConstraintsPost",
22471
22532
  requestBody: {
22472
22533
  content: {
@@ -22474,7 +22535,7 @@ var openapi_default = {
22474
22535
  schema: {
22475
22536
  properties: {
22476
22537
  device_id: {
22477
- description: "ID of the device for which to report constraints.",
22538
+ description: "ID of the device for which you want to report constraints.",
22478
22539
  format: "uuid",
22479
22540
  type: "string"
22480
22541
  },
@@ -22616,7 +22677,7 @@ var openapi_default = {
22616
22677
  type: "string"
22617
22678
  },
22618
22679
  allow_external_modification: {
22619
- description: "Indicates whether external modification of the access code is allowed.",
22680
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
22620
22681
  type: "boolean"
22621
22682
  },
22622
22683
  force: {
@@ -22624,7 +22685,7 @@ var openapi_default = {
22624
22685
  type: "boolean"
22625
22686
  },
22626
22687
  is_external_modification_allowed: {
22627
- description: "Indicates whether external modification of the access code is allowed.",
22688
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
22628
22689
  type: "boolean"
22629
22690
  },
22630
22691
  sync: {
@@ -22682,7 +22743,7 @@ var openapi_default = {
22682
22743
  type: "string"
22683
22744
  },
22684
22745
  allow_external_modification: {
22685
- description: "Indicates whether external modification of the access code is allowed.",
22746
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
22686
22747
  type: "boolean"
22687
22748
  },
22688
22749
  force: {
@@ -22690,7 +22751,7 @@ var openapi_default = {
22690
22751
  type: "boolean"
22691
22752
  },
22692
22753
  is_external_modification_allowed: {
22693
- description: "Indicates whether external modification of the access code is allowed.",
22754
+ description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
22694
22755
  type: "boolean"
22695
22756
  },
22696
22757
  sync: {
@@ -22746,7 +22807,7 @@ var openapi_default = {
22746
22807
  schema: {
22747
22808
  properties: {
22748
22809
  access_code_id: {
22749
- description: "ID of the unmanaged access code to delete.",
22810
+ description: "ID of the unmanaged access code that you want to delete.",
22750
22811
  format: "uuid",
22751
22812
  type: "string"
22752
22813
  },
@@ -23113,7 +23174,7 @@ var openapi_default = {
23113
23174
  type: "string"
23114
23175
  },
23115
23176
  name: {
23116
- description: "Name of the new access code.",
23177
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23117
23178
  type: "string"
23118
23179
  },
23119
23180
  prefer_native_scheduling: {
@@ -23245,7 +23306,7 @@ var openapi_default = {
23245
23306
  type: "string"
23246
23307
  },
23247
23308
  name: {
23248
- description: "Name of the new access code.",
23309
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23249
23310
  type: "string"
23250
23311
  },
23251
23312
  prefer_native_scheduling: {
@@ -23378,7 +23439,7 @@ var openapi_default = {
23378
23439
  type: "string"
23379
23440
  },
23380
23441
  name: {
23381
- description: "Name of the new access code.",
23442
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23382
23443
  type: "string"
23383
23444
  },
23384
23445
  prefer_native_scheduling: {
@@ -23469,7 +23530,7 @@ var openapi_default = {
23469
23530
  type: "string"
23470
23531
  },
23471
23532
  name: {
23472
- description: "Name of the new access code.",
23533
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23473
23534
  type: "string"
23474
23535
  },
23475
23536
  starts_at: {
@@ -23528,7 +23589,7 @@ var openapi_default = {
23528
23589
  type: "string"
23529
23590
  },
23530
23591
  name: {
23531
- description: "Name of the new access code.",
23592
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23532
23593
  type: "string"
23533
23594
  },
23534
23595
  starts_at: {
@@ -23574,7 +23635,7 @@ var openapi_default = {
23574
23635
  },
23575
23636
  "/acs/access_groups/add_user": {
23576
23637
  post: {
23577
- description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23638
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23578
23639
  operationId: "acsAccessGroupsAddUserPost",
23579
23640
  requestBody: {
23580
23641
  content: {
@@ -23582,12 +23643,12 @@ var openapi_default = {
23582
23643
  schema: {
23583
23644
  properties: {
23584
23645
  acs_access_group_id: {
23585
- description: "ID of the desired access group.",
23646
+ description: "ID of the access group to which you want to add an access system user.",
23586
23647
  format: "uuid",
23587
23648
  type: "string"
23588
23649
  },
23589
23650
  acs_user_id: {
23590
- description: "ID of the desired user.",
23651
+ description: "ID of the access system user that you want to add to an access group.",
23591
23652
  format: "uuid",
23592
23653
  type: "string"
23593
23654
  }
@@ -23627,7 +23688,7 @@ var openapi_default = {
23627
23688
  "x-title": "Add an ACS User to an Access Group"
23628
23689
  },
23629
23690
  put: {
23630
- description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23691
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23631
23692
  operationId: "acsAccessGroupsAddUserPut",
23632
23693
  requestBody: {
23633
23694
  content: {
@@ -23635,12 +23696,12 @@ var openapi_default = {
23635
23696
  schema: {
23636
23697
  properties: {
23637
23698
  acs_access_group_id: {
23638
- description: "ID of the desired access group.",
23699
+ description: "ID of the access group to which you want to add an access system user.",
23639
23700
  format: "uuid",
23640
23701
  type: "string"
23641
23702
  },
23642
23703
  acs_user_id: {
23643
- description: "ID of the desired user.",
23704
+ description: "ID of the access system user that you want to add to an access group.",
23644
23705
  format: "uuid",
23645
23706
  type: "string"
23646
23707
  }
@@ -23689,7 +23750,7 @@ var openapi_default = {
23689
23750
  schema: {
23690
23751
  properties: {
23691
23752
  acs_access_group_id: {
23692
- description: "ID of the desired access group.",
23753
+ description: "ID of the access group that you want to get.",
23693
23754
  format: "uuid",
23694
23755
  type: "string"
23695
23756
  }
@@ -23745,12 +23806,12 @@ var openapi_default = {
23745
23806
  schema: {
23746
23807
  properties: {
23747
23808
  acs_system_id: {
23748
- description: "ID of the access control system for which you want to retrieve all access groups.",
23809
+ description: "ID of the access system for which you want to retrieve all access groups.",
23749
23810
  format: "uuid",
23750
23811
  type: "string"
23751
23812
  },
23752
23813
  acs_user_id: {
23753
- description: "ID of the user for which you want to retrieve all access groups.",
23814
+ description: "ID of the access system user for which you want to retrieve all access groups.",
23754
23815
  format: "uuid",
23755
23816
  type: "string"
23756
23817
  },
@@ -23860,7 +23921,7 @@ var openapi_default = {
23860
23921
  },
23861
23922
  "/acs/access_groups/list_users": {
23862
23923
  post: {
23863
- description: "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23924
+ description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23864
23925
  operationId: "acsAccessGroupsListUsersPost",
23865
23926
  requestBody: {
23866
23927
  content: {
@@ -23868,7 +23929,7 @@ var openapi_default = {
23868
23929
  schema: {
23869
23930
  properties: {
23870
23931
  acs_access_group_id: {
23871
- description: "ID of the access group for which you want to retrieve all users.",
23932
+ description: "ID of the access group for which you want to retrieve all access system users.",
23872
23933
  format: "uuid",
23873
23934
  type: "string"
23874
23935
  }
@@ -23917,7 +23978,7 @@ var openapi_default = {
23917
23978
  },
23918
23979
  "/acs/access_groups/remove_user": {
23919
23980
  post: {
23920
- description: "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23981
+ description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
23921
23982
  operationId: "acsAccessGroupsRemoveUserPost",
23922
23983
  requestBody: {
23923
23984
  content: {
@@ -23925,17 +23986,17 @@ var openapi_default = {
23925
23986
  schema: {
23926
23987
  properties: {
23927
23988
  acs_access_group_id: {
23928
- description: "ID of the desired access group.",
23989
+ description: "ID of the access group from which you want to remove an access system user.",
23929
23990
  format: "uuid",
23930
23991
  type: "string"
23931
23992
  },
23932
23993
  acs_user_id: {
23933
- description: "ID of the desired user.",
23994
+ description: "ID of the access system user that you want to remove from an access group.",
23934
23995
  format: "uuid",
23935
23996
  type: "string"
23936
23997
  },
23937
23998
  user_identity_id: {
23938
- description: "ID of the desired user identity.",
23999
+ description: "ID of the user identity associated with the user that you want to remove from an access group.",
23939
24000
  format: "uuid",
23940
24001
  type: "string"
23941
24002
  }
@@ -23985,7 +24046,7 @@ var openapi_default = {
23985
24046
  schema: {
23986
24047
  properties: {
23987
24048
  acs_access_group_id: {
23988
- description: "ID of the desired unmanaged access group.",
24049
+ description: "ID of the unmanaged access group that you want to get.",
23989
24050
  format: "uuid",
23990
24051
  type: "string"
23991
24052
  }
@@ -24028,6 +24089,7 @@ var openapi_default = {
24028
24089
  "x-fern-sdk-method-name": "get",
24029
24090
  "x-fern-sdk-return-value": "acs_access_group",
24030
24091
  "x-response-key": "acs_access_group",
24092
+ "x-title": "Get an Unmanaged Access Group",
24031
24093
  "x-undocumented": "No unmanaged access groups are currently implemented."
24032
24094
  }
24033
24095
  },
@@ -24041,12 +24103,12 @@ var openapi_default = {
24041
24103
  schema: {
24042
24104
  properties: {
24043
24105
  acs_system_id: {
24044
- description: "ID of the access control system for which you want to retrieve all unmanaged access groups.",
24106
+ description: "ID of the access system for which you want to retrieve all unmanaged access groups.",
24045
24107
  format: "uuid",
24046
24108
  type: "string"
24047
24109
  },
24048
24110
  acs_user_id: {
24049
- description: "ID of the user for which you want to retrieve all unmanaged access groups.",
24111
+ description: "ID of the access system user for which you want to retrieve all unmanaged access groups.",
24050
24112
  format: "uuid",
24051
24113
  type: "string"
24052
24114
  }
@@ -24091,18 +24153,24 @@ var openapi_default = {
24091
24153
  "x-fern-sdk-method-name": "list",
24092
24154
  "x-fern-sdk-return-value": "acs_access_groups",
24093
24155
  "x-response-key": "acs_access_groups",
24156
+ "x-title": "List Unmanaged Access Groups",
24094
24157
  "x-undocumented": "No unmanaged access groups are currently implemented."
24095
24158
  }
24096
24159
  },
24097
24160
  "/acs/credential_pools/list": {
24098
24161
  post: {
24162
+ description: "Returns a list of all credential pools.",
24099
24163
  operationId: "acsCredentialPoolsListPost",
24100
24164
  requestBody: {
24101
24165
  content: {
24102
24166
  "application/json": {
24103
24167
  schema: {
24104
24168
  properties: {
24105
- acs_system_id: { format: "uuid", type: "string" }
24169
+ acs_system_id: {
24170
+ description: "ID of the access system for which you want to list credential pools.",
24171
+ format: "uuid",
24172
+ type: "string"
24173
+ }
24106
24174
  },
24107
24175
  required: ["acs_system_id"],
24108
24176
  type: "object"
@@ -24146,28 +24214,43 @@ var openapi_default = {
24146
24214
  "x-fern-sdk-method-name": "list",
24147
24215
  "x-fern-sdk-return-value": "acs_credential_pools",
24148
24216
  "x-response-key": "acs_credential_pools",
24217
+ "x-title": "List Credential Pools",
24149
24218
  "x-undocumented": "Replaced by enrollment automations."
24150
24219
  }
24151
24220
  },
24152
24221
  "/acs/credential_provisioning_automations/launch": {
24153
24222
  post: {
24223
+ description: "Launches a credential provisioning automation.",
24154
24224
  operationId: "acsCredentialProvisioningAutomationsLaunchPost",
24155
24225
  requestBody: {
24156
24226
  content: {
24157
24227
  "application/json": {
24158
24228
  schema: {
24159
24229
  properties: {
24160
- acs_credential_pool_id: { format: "uuid", type: "string" },
24161
- create_credential_manager_user: { type: "boolean" },
24230
+ acs_credential_pool_id: {
24231
+ description: "ID of the credential pool for which you want to launch a credential provisioning automation.",
24232
+ format: "uuid",
24233
+ type: "string"
24234
+ },
24235
+ create_credential_manager_user: {
24236
+ description: "Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.",
24237
+ type: "boolean"
24238
+ },
24162
24239
  credential_manager_acs_system_id: {
24240
+ description: "Access system ID of the credential manager for which you want to launch a credential provisioning automation.",
24163
24241
  format: "uuid",
24164
24242
  type: "string"
24165
24243
  },
24166
24244
  credential_manager_acs_user_id: {
24245
+ description: "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.",
24167
24246
  format: "uuid",
24168
24247
  type: "string"
24169
24248
  },
24170
- user_identity_id: { format: "uuid", type: "string" }
24249
+ user_identity_id: {
24250
+ description: "ID of the user identity for which you want to launch a credential provisioning automation.",
24251
+ format: "uuid",
24252
+ type: "string"
24253
+ }
24171
24254
  },
24172
24255
  required: [
24173
24256
  "user_identity_id",
@@ -24211,12 +24294,13 @@ var openapi_default = {
24211
24294
  "x-fern-sdk-method-name": "launch",
24212
24295
  "x-fern-sdk-return-value": "acs_credential_provisioning_automation",
24213
24296
  "x-response-key": "acs_credential_provisioning_automation",
24297
+ "x-title": "Launch a Credential Provisioning Automation",
24214
24298
  "x-undocumented": "Replaced by enrollment automations."
24215
24299
  }
24216
24300
  },
24217
24301
  "/acs/credentials/assign": {
24218
24302
  patch: {
24219
- description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24303
+ description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24220
24304
  operationId: "acsCredentialsAssignPatch",
24221
24305
  requestBody: {
24222
24306
  content: {
@@ -24224,12 +24308,12 @@ var openapi_default = {
24224
24308
  schema: {
24225
24309
  properties: {
24226
24310
  acs_credential_id: {
24227
- description: "ID of the desired credential.",
24311
+ description: "ID of the credential that you want to assign to an access system user.",
24228
24312
  format: "uuid",
24229
24313
  type: "string"
24230
24314
  },
24231
24315
  acs_user_id: {
24232
- description: "ID of the desired user.",
24316
+ description: "ID of the access system user to whom you want to assign a credential.",
24233
24317
  format: "uuid",
24234
24318
  type: "string"
24235
24319
  }
@@ -24273,7 +24357,7 @@ var openapi_default = {
24273
24357
  "x-title": "Assign a Credential to an ACS User"
24274
24358
  },
24275
24359
  post: {
24276
- description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24360
+ description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24277
24361
  operationId: "acsCredentialsAssignPost",
24278
24362
  requestBody: {
24279
24363
  content: {
@@ -24281,12 +24365,12 @@ var openapi_default = {
24281
24365
  schema: {
24282
24366
  properties: {
24283
24367
  acs_credential_id: {
24284
- description: "ID of the desired credential.",
24368
+ description: "ID of the credential that you want to assign to an access system user.",
24285
24369
  format: "uuid",
24286
24370
  type: "string"
24287
24371
  },
24288
24372
  acs_user_id: {
24289
- description: "ID of the desired user.",
24373
+ description: "ID of the access system user to whom you want to assign a credential.",
24290
24374
  format: "uuid",
24291
24375
  type: "string"
24292
24376
  }
@@ -24346,12 +24430,12 @@ var openapi_default = {
24346
24430
  type: "string"
24347
24431
  },
24348
24432
  acs_system_id: {
24349
- description: "ID of the ACS system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.",
24433
+ description: "ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.",
24350
24434
  format: "uuid",
24351
24435
  type: "string"
24352
24436
  },
24353
24437
  acs_user_id: {
24354
- description: "ID of the ACS user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.",
24438
+ description: "ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.",
24355
24439
  format: "uuid",
24356
24440
  type: "string"
24357
24441
  },
@@ -24397,8 +24481,14 @@ var openapi_default = {
24397
24481
  salto_space_metadata: {
24398
24482
  description: "Salto Space-specific metadata for the new credential.",
24399
24483
  properties: {
24400
- assign_new_key: { type: "boolean" },
24401
- update_current_key: { type: "boolean" }
24484
+ assign_new_key: {
24485
+ description: "Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).",
24486
+ type: "boolean"
24487
+ },
24488
+ update_current_key: {
24489
+ description: "Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).",
24490
+ type: "boolean"
24491
+ }
24402
24492
  },
24403
24493
  type: "object"
24404
24494
  },
@@ -24408,7 +24498,7 @@ var openapi_default = {
24408
24498
  type: "string"
24409
24499
  },
24410
24500
  user_identity_id: {
24411
- description: "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
24501
+ description: "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.",
24412
24502
  format: "uuid",
24413
24503
  type: "string"
24414
24504
  },
@@ -24490,7 +24580,7 @@ var openapi_default = {
24490
24580
  },
24491
24581
  "/acs/credentials/create_offline_code": {
24492
24582
  post: {
24493
- description: "Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24583
+ description: "Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24494
24584
  operationId: "acsCredentialsCreateOfflineCodePost",
24495
24585
  requestBody: {
24496
24586
  content: {
@@ -24498,7 +24588,7 @@ var openapi_default = {
24498
24588
  schema: {
24499
24589
  properties: {
24500
24590
  acs_user_id: {
24501
- description: "ID of the ACS user to whom the new credential belongs.",
24591
+ description: "ID of the access system user to whom the new credential belongs.",
24502
24592
  format: "uuid",
24503
24593
  type: "string"
24504
24594
  },
@@ -24575,7 +24665,7 @@ var openapi_default = {
24575
24665
  schema: {
24576
24666
  properties: {
24577
24667
  acs_credential_id: {
24578
- description: "ID of the desired credential.",
24668
+ description: "ID of the credential that you want to delete.",
24579
24669
  format: "uuid",
24580
24670
  type: "string"
24581
24671
  }
@@ -24625,7 +24715,7 @@ var openapi_default = {
24625
24715
  schema: {
24626
24716
  properties: {
24627
24717
  acs_credential_id: {
24628
- description: "ID of the desired credential.",
24718
+ description: "ID of the credential that you want to get.",
24629
24719
  format: "uuid",
24630
24720
  type: "string"
24631
24721
  }
@@ -24685,7 +24775,7 @@ var openapi_default = {
24685
24775
  {
24686
24776
  properties: {
24687
24777
  acs_user_id: {
24688
- description: "ID of the ACS user for which you want to retrieve all credentials.",
24778
+ description: "ID of the access system user for which you want to retrieve all credentials.",
24689
24779
  format: "uuid",
24690
24780
  type: "string"
24691
24781
  }
@@ -24696,7 +24786,7 @@ var openapi_default = {
24696
24786
  {
24697
24787
  properties: {
24698
24788
  acs_system_id: {
24699
- description: "ID of the access control system for which you want to retrieve all credentials.",
24789
+ description: "ID of the access system for which you want to retrieve all credentials.",
24700
24790
  format: "uuid",
24701
24791
  type: "string"
24702
24792
  }
@@ -24707,12 +24797,12 @@ var openapi_default = {
24707
24797
  {
24708
24798
  properties: {
24709
24799
  acs_system_id: {
24710
- description: "ID of the access control system for which you want to retrieve all credentials.",
24800
+ description: "ID of the access system for which you want to retrieve all credentials.",
24711
24801
  format: "uuid",
24712
24802
  type: "string"
24713
24803
  },
24714
24804
  acs_user_id: {
24715
- description: "ID of the ACS user for which you want to retrieve all credentials.",
24805
+ description: "ID of the access system user for which you want to retrieve all credentials.",
24716
24806
  format: "uuid",
24717
24807
  type: "string"
24718
24808
  }
@@ -24806,7 +24896,7 @@ var openapi_default = {
24806
24896
  schema: {
24807
24897
  properties: {
24808
24898
  acs_credential_id: {
24809
- description: "ID of the credential for which you want to retrieve all entrances to which this credential grants access.",
24899
+ description: "ID of the credential for which you want to retrieve all entrances to which the credential grants access.",
24810
24900
  format: "uuid",
24811
24901
  type: "string"
24812
24902
  }
@@ -24855,7 +24945,7 @@ var openapi_default = {
24855
24945
  },
24856
24946
  "/acs/credentials/unassign": {
24857
24947
  patch: {
24858
- description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24948
+ description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24859
24949
  operationId: "acsCredentialsUnassignPatch",
24860
24950
  requestBody: {
24861
24951
  content: {
@@ -24863,12 +24953,12 @@ var openapi_default = {
24863
24953
  schema: {
24864
24954
  properties: {
24865
24955
  acs_credential_id: {
24866
- description: "ID of the desired credential.",
24956
+ description: "ID of the credential that you want to unassign from an access system user.",
24867
24957
  format: "uuid",
24868
24958
  type: "string"
24869
24959
  },
24870
24960
  acs_user_id: {
24871
- description: "ID of the desired user.",
24961
+ description: "ID of the access system user from which you want to unassign a credential.",
24872
24962
  format: "uuid",
24873
24963
  type: "string"
24874
24964
  }
@@ -24912,7 +25002,7 @@ var openapi_default = {
24912
25002
  "x-title": "Unassign a Credential from an ACS User"
24913
25003
  },
24914
25004
  post: {
24915
- description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
25005
+ description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
24916
25006
  operationId: "acsCredentialsUnassignPost",
24917
25007
  requestBody: {
24918
25008
  content: {
@@ -24920,12 +25010,12 @@ var openapi_default = {
24920
25010
  schema: {
24921
25011
  properties: {
24922
25012
  acs_credential_id: {
24923
- description: "ID of the desired credential.",
25013
+ description: "ID of the credential that you want to unassign from an access system user.",
24924
25014
  format: "uuid",
24925
25015
  type: "string"
24926
25016
  },
24927
25017
  acs_user_id: {
24928
- description: "ID of the desired user.",
25018
+ description: "ID of the access system user from which you want to unassign a credential.",
24929
25019
  format: "uuid",
24930
25020
  type: "string"
24931
25021
  }
@@ -24980,7 +25070,7 @@ var openapi_default = {
24980
25070
  schema: {
24981
25071
  properties: {
24982
25072
  acs_credential_id: {
24983
- description: "ID of the desired unmanaged credential.",
25073
+ description: "ID of the unmanaged credential that you want to get.",
24984
25074
  format: "uuid",
24985
25075
  type: "string"
24986
25076
  }
@@ -25037,9 +25127,10 @@ var openapi_default = {
25037
25127
  schema: {
25038
25128
  oneOf: [
25039
25129
  {
25130
+ description: "ID of the access system user for which you want to list unmanaged credentials.",
25040
25131
  properties: {
25041
25132
  acs_user_id: {
25042
- description: "ID of the ACS user for which you want to retrieve all credentials.",
25133
+ description: "ID of the access system user for which you want to retrieve all credentials.",
25043
25134
  format: "uuid",
25044
25135
  type: "string"
25045
25136
  }
@@ -25048,9 +25139,10 @@ var openapi_default = {
25048
25139
  type: "object"
25049
25140
  },
25050
25141
  {
25142
+ description: "ID of the access system for which you want to list unmanaged credentials.",
25051
25143
  properties: {
25052
25144
  acs_system_id: {
25053
- description: "ID of the access control system for which you want to retrieve all credentials.",
25145
+ description: "ID of the access system for which you want to retrieve all credentials.",
25054
25146
  format: "uuid",
25055
25147
  type: "string"
25056
25148
  }
@@ -25059,14 +25151,15 @@ var openapi_default = {
25059
25151
  type: "object"
25060
25152
  },
25061
25153
  {
25154
+ description: "ID of the access system and ID of the access system user for which you want to list unmanaged credentials.",
25062
25155
  properties: {
25063
25156
  acs_system_id: {
25064
- description: "ID of the access control system for which you want to retrieve all credentials.",
25157
+ description: "ID of the access system for which you want to retrieve all credentials.",
25065
25158
  format: "uuid",
25066
25159
  type: "string"
25067
25160
  },
25068
25161
  acs_user_id: {
25069
- description: "ID of the ACS user for which you want to retrieve all credentials.",
25162
+ description: "ID of the access system user for which you want to retrieve all credentials.",
25070
25163
  format: "uuid",
25071
25164
  type: "string"
25072
25165
  }
@@ -25075,6 +25168,7 @@ var openapi_default = {
25075
25168
  type: "object"
25076
25169
  },
25077
25170
  {
25171
+ description: "ID of the user identity for which you want to list unmanaged credentials.",
25078
25172
  properties: {
25079
25173
  user_identity_id: {
25080
25174
  description: "ID of the user identity for which you want to retrieve all credentials.",
@@ -25139,11 +25233,11 @@ var openapi_default = {
25139
25233
  schema: {
25140
25234
  properties: {
25141
25235
  acs_credential_id: {
25142
- description: "ID of the desired credential.",
25236
+ description: "ID of the credential that you want to update.",
25143
25237
  type: "string"
25144
25238
  },
25145
25239
  code: {
25146
- description: "Replacement access (PIN) code for the credential.",
25240
+ description: "Replacement access (PIN) code for the credential that you want to update.",
25147
25241
  pattern: "^\\d+$",
25148
25242
  type: "string"
25149
25243
  },
@@ -25200,11 +25294,11 @@ var openapi_default = {
25200
25294
  schema: {
25201
25295
  properties: {
25202
25296
  acs_credential_id: {
25203
- description: "ID of the desired credential.",
25297
+ description: "ID of the credential that you want to update.",
25204
25298
  type: "string"
25205
25299
  },
25206
25300
  code: {
25207
- description: "Replacement access (PIN) code for the credential.",
25301
+ description: "Replacement access (PIN) code for the credential that you want to update.",
25208
25302
  pattern: "^\\d+$",
25209
25303
  type: "string"
25210
25304
  },
@@ -25388,7 +25482,7 @@ var openapi_default = {
25388
25482
  schema: {
25389
25483
  properties: {
25390
25484
  acs_encoder_id: {
25391
- description: "ID of the desired encoder.",
25485
+ description: "ID of the encoder that you want to get.",
25392
25486
  format: "uuid",
25393
25487
  type: "string"
25394
25488
  }
@@ -25444,13 +25538,13 @@ var openapi_default = {
25444
25538
  {
25445
25539
  properties: {
25446
25540
  acs_system_id: {
25447
- description: "ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.",
25541
+ description: "ID of the access system for which you want to retrieve all encoders.",
25448
25542
  format: "uuid",
25449
25543
  type: "string"
25450
25544
  },
25451
25545
  limit: {
25452
25546
  default: 500,
25453
- description: "Number of `acs_encoders` to return.",
25547
+ description: "Number of encoders to return.",
25454
25548
  format: "float",
25455
25549
  type: "number"
25456
25550
  }
@@ -25461,13 +25555,13 @@ var openapi_default = {
25461
25555
  {
25462
25556
  properties: {
25463
25557
  acs_system_ids: {
25464
- description: "IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.",
25558
+ description: "IDs of the access systems for which you want to retrieve all encoders.",
25465
25559
  items: { format: "uuid", type: "string" },
25466
25560
  type: "array"
25467
25561
  },
25468
25562
  limit: {
25469
25563
  default: 500,
25470
- description: "Number of `acs_encoders` to return.",
25564
+ description: "Number of encoders to return.",
25471
25565
  format: "float",
25472
25566
  type: "number"
25473
25567
  }
@@ -25478,13 +25572,13 @@ var openapi_default = {
25478
25572
  {
25479
25573
  properties: {
25480
25574
  acs_encoder_ids: {
25481
- description: "IDs of the `acs_encoder`s that you want to retrieve.",
25575
+ description: "IDs of the encoders that you want to retrieve.",
25482
25576
  items: { format: "uuid", type: "string" },
25483
25577
  type: "array"
25484
25578
  },
25485
25579
  limit: {
25486
25580
  default: 500,
25487
- description: "Number of `acs_encoders` to return.",
25581
+ description: "Number of encoders to return.",
25488
25582
  format: "float",
25489
25583
  type: "number"
25490
25584
  }
@@ -25543,7 +25637,7 @@ var openapi_default = {
25543
25637
  schema: {
25544
25638
  properties: {
25545
25639
  acs_encoder_id: {
25546
- description: "ID of the `acs_encoder` to use for the scan.",
25640
+ description: "ID of the encoder to use for the scan.",
25547
25641
  format: "uuid",
25548
25642
  type: "string"
25549
25643
  }
@@ -25915,14 +26009,18 @@ var openapi_default = {
25915
26009
  },
25916
26010
  "/acs/entrances/get": {
25917
26011
  post: {
25918
- description: "Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
26012
+ description: "Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
25919
26013
  operationId: "acsEntrancesGetPost",
25920
26014
  requestBody: {
25921
26015
  content: {
25922
26016
  "application/json": {
25923
26017
  schema: {
25924
26018
  properties: {
25925
- acs_entrance_id: { format: "uuid", type: "string" }
26019
+ acs_entrance_id: {
26020
+ description: "ID of the entrance that you want to get.",
26021
+ format: "uuid",
26022
+ type: "string"
26023
+ }
25926
26024
  },
25927
26025
  required: ["acs_entrance_id"],
25928
26026
  type: "object"
@@ -25966,14 +26064,23 @@ var openapi_default = {
25966
26064
  },
25967
26065
  "/acs/entrances/grant_access": {
25968
26066
  post: {
26067
+ description: "Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
25969
26068
  operationId: "acsEntrancesGrantAccessPost",
25970
26069
  requestBody: {
25971
26070
  content: {
25972
26071
  "application/json": {
25973
26072
  schema: {
25974
26073
  properties: {
25975
- acs_entrance_id: { format: "uuid", type: "string" },
25976
- acs_user_id: { format: "uuid", type: "string" }
26074
+ acs_entrance_id: {
26075
+ description: "ID of the entrance to which you want to grant an access system user access.",
26076
+ format: "uuid",
26077
+ type: "string"
26078
+ },
26079
+ acs_user_id: {
26080
+ description: "ID of the access system user to whom you want to grant access to an entrance.",
26081
+ format: "uuid",
26082
+ type: "string"
26083
+ }
25977
26084
  },
25978
26085
  required: ["acs_entrance_id", "acs_user_id"],
25979
26086
  type: "object"
@@ -26012,16 +26119,25 @@ var openapi_default = {
26012
26119
  },
26013
26120
  "/acs/entrances/list": {
26014
26121
  post: {
26015
- description: "Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
26122
+ description: "Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
26016
26123
  operationId: "acsEntrancesListPost",
26017
26124
  requestBody: {
26018
26125
  content: {
26019
26126
  "application/json": {
26020
26127
  schema: {
26021
26128
  properties: {
26022
- acs_credential_id: { format: "uuid", type: "string" },
26023
- acs_system_id: { format: "uuid", type: "string" },
26129
+ acs_credential_id: {
26130
+ description: "ID of the credential for which you want to retrieve all entrances.",
26131
+ format: "uuid",
26132
+ type: "string"
26133
+ },
26134
+ acs_system_id: {
26135
+ description: "ID of the access system for which you want to retrieve all entrances.",
26136
+ format: "uuid",
26137
+ type: "string"
26138
+ },
26024
26139
  location_id: {
26140
+ description: "ID of the location for which you want to retrieve all entrances.",
26025
26141
  format: "uuid",
26026
26142
  nullable: true,
26027
26143
  type: "string",
@@ -26079,8 +26195,13 @@ var openapi_default = {
26079
26195
  "application/json": {
26080
26196
  schema: {
26081
26197
  properties: {
26082
- acs_entrance_id: { format: "uuid", type: "string" },
26198
+ acs_entrance_id: {
26199
+ description: "ID of the entrance for which you want to list all credentials that grant access.",
26200
+ format: "uuid",
26201
+ type: "string"
26202
+ },
26083
26203
  include_if: {
26204
+ description: "Conditions that credentials must meet to be included in the returned list.",
26084
26205
  items: {
26085
26206
  enum: ["visionline_metadata.is_valid"],
26086
26207
  type: "string"
@@ -26133,7 +26254,7 @@ var openapi_default = {
26133
26254
  },
26134
26255
  "/acs/systems/get": {
26135
26256
  post: {
26136
- description: "Returns a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the desired access control system by including the corresponding `acs_system_id` in the request body.",
26257
+ description: "Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).",
26137
26258
  operationId: "acsSystemsGetPost",
26138
26259
  requestBody: {
26139
26260
  content: {
@@ -26141,7 +26262,7 @@ var openapi_default = {
26141
26262
  schema: {
26142
26263
  properties: {
26143
26264
  acs_system_id: {
26144
- description: "ID of the desired access control system.",
26265
+ description: "ID of the access system that you want to get.",
26145
26266
  format: "uuid",
26146
26267
  type: "string"
26147
26268
  }
@@ -26187,7 +26308,7 @@ var openapi_default = {
26187
26308
  },
26188
26309
  "/acs/systems/list": {
26189
26310
  post: {
26190
- description: "Returns a list of all [access control systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access control systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access control systems connected to your workspace.",
26311
+ description: "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.",
26191
26312
  operationId: "acsSystemsListPost",
26192
26313
  requestBody: {
26193
26314
  content: {
@@ -26195,7 +26316,7 @@ var openapi_default = {
26195
26316
  schema: {
26196
26317
  properties: {
26197
26318
  connected_account_id: {
26198
- description: "ID of the connected account by which to filter the list of returned access control systems.",
26319
+ description: "ID of the connected account by which you want to filter the list of access systems.",
26199
26320
  format: "uuid",
26200
26321
  type: "string"
26201
26322
  }
@@ -26244,7 +26365,7 @@ var openapi_default = {
26244
26365
  },
26245
26366
  "/acs/systems/list_compatible_credential_manager_acs_systems": {
26246
26367
  post: {
26247
- description: "Returns a list of all credential manager ACS systems that are compatible with a specified [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the ACS system for which you want to retrieve all compatible credential manager ACS systems by including the corresponding `acs_system_id` in the request body.",
26368
+ description: "Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.",
26248
26369
  operationId: "acsSystemsListCompatibleCredentialManagerAcsSystemsPost",
26249
26370
  requestBody: {
26250
26371
  content: {
@@ -26252,7 +26373,7 @@ var openapi_default = {
26252
26373
  schema: {
26253
26374
  properties: {
26254
26375
  acs_system_id: {
26255
- description: "ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.",
26376
+ description: "ID of the access system for which you want to retrieve all compatible credential manager systems.",
26256
26377
  format: "uuid",
26257
26378
  type: "string"
26258
26379
  }
@@ -26301,7 +26422,7 @@ var openapi_default = {
26301
26422
  },
26302
26423
  "/acs/users/add_to_access_group": {
26303
26424
  post: {
26304
- description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26425
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26305
26426
  operationId: "acsUsersAddToAccessGroupPost",
26306
26427
  requestBody: {
26307
26428
  content: {
@@ -26309,12 +26430,12 @@ var openapi_default = {
26309
26430
  schema: {
26310
26431
  properties: {
26311
26432
  acs_access_group_id: {
26312
- description: "ID of the desired access group.",
26433
+ description: "ID of the access group to which you want to add an access system user.",
26313
26434
  format: "uuid",
26314
26435
  type: "string"
26315
26436
  },
26316
26437
  acs_user_id: {
26317
- description: "ID of the desired `acs_user`.",
26438
+ description: "ID of the access system user that you want to add to an access group.",
26318
26439
  format: "uuid",
26319
26440
  type: "string"
26320
26441
  }
@@ -26354,7 +26475,7 @@ var openapi_default = {
26354
26475
  "x-title": "Add an ACS User to an Access Group"
26355
26476
  },
26356
26477
  put: {
26357
- description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26478
+ description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26358
26479
  operationId: "acsUsersAddToAccessGroupPut",
26359
26480
  requestBody: {
26360
26481
  content: {
@@ -26362,12 +26483,12 @@ var openapi_default = {
26362
26483
  schema: {
26363
26484
  properties: {
26364
26485
  acs_access_group_id: {
26365
- description: "ID of the desired access group.",
26486
+ description: "ID of the access group to which you want to add an access system user.",
26366
26487
  format: "uuid",
26367
26488
  type: "string"
26368
26489
  },
26369
26490
  acs_user_id: {
26370
- description: "ID of the desired `acs_user`.",
26491
+ description: "ID of the access system user that you want to add to an access group.",
26371
26492
  format: "uuid",
26372
26493
  type: "string"
26373
26494
  }
@@ -26408,7 +26529,7 @@ var openapi_default = {
26408
26529
  },
26409
26530
  "/acs/users/create": {
26410
26531
  post: {
26411
- description: "Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26532
+ description: "Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26412
26533
  operationId: "acsUsersCreatePost",
26413
26534
  requestBody: {
26414
26535
  content: {
@@ -26416,25 +26537,30 @@ var openapi_default = {
26416
26537
  schema: {
26417
26538
  properties: {
26418
26539
  access_schedule: {
26419
- description: "`starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`.",
26540
+ description: "`starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
26420
26541
  properties: {
26421
26542
  ends_at: {
26543
+ description: "Ending timestamp for the new access system user's access.",
26422
26544
  format: "date-time",
26423
26545
  nullable: true,
26424
26546
  type: "string"
26425
26547
  },
26426
- starts_at: { format: "date-time", type: "string" }
26548
+ starts_at: {
26549
+ description: "Starting timestamp for the new access system user's access.",
26550
+ format: "date-time",
26551
+ type: "string"
26552
+ }
26427
26553
  },
26428
26554
  type: "object"
26429
26555
  },
26430
26556
  acs_access_group_ids: {
26431
26557
  default: [],
26432
- description: "Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.",
26558
+ description: "Array of access group IDs to indicate the access groups to which you want to add the new access system user.",
26433
26559
  items: { format: "uuid", type: "string" },
26434
26560
  type: "array"
26435
26561
  },
26436
26562
  acs_system_id: {
26437
- description: "ID of the `acs_system` to which to add the new `acs_user`.",
26563
+ description: "ID of the access system to which you want to add the new access system user.",
26438
26564
  format: "uuid",
26439
26565
  type: "string"
26440
26566
  },
@@ -26450,7 +26576,7 @@ var openapi_default = {
26450
26576
  type: "string"
26451
26577
  },
26452
26578
  full_name: {
26453
- description: "Full name of the new `acs_user`.",
26579
+ description: "Full name of the new access system user.",
26454
26580
  type: "string"
26455
26581
  },
26456
26582
  phone_number: {
@@ -26458,7 +26584,7 @@ var openapi_default = {
26458
26584
  type: "string"
26459
26585
  },
26460
26586
  user_identity_id: {
26461
- description: "ID of the user identity with which to associate the new `acs_user`.",
26587
+ description: "ID of the user identity with which you want to associate the new access system user.",
26462
26588
  format: "uuid",
26463
26589
  type: "string"
26464
26590
  }
@@ -26504,7 +26630,7 @@ var openapi_default = {
26504
26630
  },
26505
26631
  "/acs/users/delete": {
26506
26632
  post: {
26507
- description: "Deletes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the ACS user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
26633
+ description: "Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
26508
26634
  operationId: "acsUsersDeletePost",
26509
26635
  requestBody: {
26510
26636
  content: {
@@ -26512,7 +26638,7 @@ var openapi_default = {
26512
26638
  schema: {
26513
26639
  properties: {
26514
26640
  acs_user_id: {
26515
- description: "ID of the desired `acs_user`.",
26641
+ description: "ID of the access system user that you want to delete.",
26516
26642
  format: "uuid",
26517
26643
  type: "string"
26518
26644
  }
@@ -26554,7 +26680,7 @@ var openapi_default = {
26554
26680
  },
26555
26681
  "/acs/users/get": {
26556
26682
  post: {
26557
- description: "Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26683
+ description: "Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26558
26684
  operationId: "acsUsersGetPost",
26559
26685
  requestBody: {
26560
26686
  content: {
@@ -26562,7 +26688,7 @@ var openapi_default = {
26562
26688
  schema: {
26563
26689
  properties: {
26564
26690
  acs_user_id: {
26565
- description: "ID of the desired `acs_user`.",
26691
+ description: "ID of the access system user that you want to get.",
26566
26692
  format: "uuid",
26567
26693
  type: "string"
26568
26694
  }
@@ -26608,7 +26734,7 @@ var openapi_default = {
26608
26734
  },
26609
26735
  "/acs/users/list": {
26610
26736
  post: {
26611
- description: "Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26737
+ description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26612
26738
  operationId: "acsUsersListPost",
26613
26739
  requestBody: {
26614
26740
  content: {
@@ -26616,11 +26742,15 @@ var openapi_default = {
26616
26742
  schema: {
26617
26743
  properties: {
26618
26744
  acs_system_id: {
26619
- description: "ID of the `acs_system` for which you want to retrieve all `acs_user`s.",
26745
+ description: "ID of the `acs_system` for which you want to retrieve all access system users.",
26620
26746
  format: "uuid",
26621
26747
  type: "string"
26622
26748
  },
26623
- created_before: { format: "date-time", type: "string" },
26749
+ created_before: {
26750
+ description: "Timestamp by which to limit returned access system users. Returns users created before this timestamp.",
26751
+ format: "date-time",
26752
+ type: "string"
26753
+ },
26624
26754
  limit: {
26625
26755
  default: 500,
26626
26756
  description: "Maximum number of records to return per page.",
@@ -26634,21 +26764,21 @@ var openapi_default = {
26634
26764
  type: "string"
26635
26765
  },
26636
26766
  search: {
26637
- description: "String for which to search. Filters returned `acs_user`s to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.",
26767
+ description: "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.",
26638
26768
  minLength: 1,
26639
26769
  type: "string"
26640
26770
  },
26641
26771
  user_identity_email_address: {
26642
- description: "Email address of the user identity for which you want to retrieve all `acs_user`s.",
26772
+ description: "Email address of the user identity for which you want to retrieve all access system users.",
26643
26773
  type: "string"
26644
26774
  },
26645
26775
  user_identity_id: {
26646
- description: "ID of the user identity for which you want to retrieve all `acs_user`s.",
26776
+ description: "ID of the user identity for which you want to retrieve all access system users.",
26647
26777
  format: "uuid",
26648
26778
  type: "string"
26649
26779
  },
26650
26780
  user_identity_phone_number: {
26651
- description: "Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).",
26781
+ description: "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).",
26652
26782
  type: "string"
26653
26783
  }
26654
26784
  },
@@ -26697,7 +26827,7 @@ var openapi_default = {
26697
26827
  },
26698
26828
  "/acs/users/list_accessible_entrances": {
26699
26829
  post: {
26700
- description: "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.",
26830
+ description: "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.",
26701
26831
  operationId: "acsUsersListAccessibleEntrancesPost",
26702
26832
  requestBody: {
26703
26833
  content: {
@@ -26705,7 +26835,7 @@ var openapi_default = {
26705
26835
  schema: {
26706
26836
  properties: {
26707
26837
  acs_user_id: {
26708
- description: "ID of the desired `acs_user`.",
26838
+ description: "ID of the access system user for whom you want to list accessible entrances.",
26709
26839
  format: "uuid",
26710
26840
  type: "string"
26711
26841
  }
@@ -26755,7 +26885,7 @@ var openapi_default = {
26755
26885
  },
26756
26886
  "/acs/users/remove_from_access_group": {
26757
26887
  post: {
26758
- description: "Removes a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26888
+ description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
26759
26889
  operationId: "acsUsersRemoveFromAccessGroupPost",
26760
26890
  requestBody: {
26761
26891
  content: {
@@ -26763,12 +26893,12 @@ var openapi_default = {
26763
26893
  schema: {
26764
26894
  properties: {
26765
26895
  acs_access_group_id: {
26766
- description: "ID of the desired access group.",
26896
+ description: "ID of the access group from which you want to remove an access system user.",
26767
26897
  format: "uuid",
26768
26898
  type: "string"
26769
26899
  },
26770
26900
  acs_user_id: {
26771
- description: "ID of the desired `acs_user`.",
26901
+ description: "ID of the access system user that you want to remove from an access group.",
26772
26902
  format: "uuid",
26773
26903
  type: "string"
26774
26904
  }
@@ -26810,7 +26940,7 @@ var openapi_default = {
26810
26940
  },
26811
26941
  "/acs/users/revoke_access_to_all_entrances": {
26812
26942
  post: {
26813
- description: "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26943
+ description: "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26814
26944
  operationId: "acsUsersRevokeAccessToAllEntrancesPost",
26815
26945
  requestBody: {
26816
26946
  content: {
@@ -26818,7 +26948,7 @@ var openapi_default = {
26818
26948
  schema: {
26819
26949
  properties: {
26820
26950
  acs_user_id: {
26821
- description: "ID of the desired `acs_user`.",
26951
+ description: "ID of the access system user for whom you want to revoke access.",
26822
26952
  format: "uuid",
26823
26953
  type: "string"
26824
26954
  }
@@ -26860,7 +26990,7 @@ var openapi_default = {
26860
26990
  },
26861
26991
  "/acs/users/suspend": {
26862
26992
  post: {
26863
- description: "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an ACS user revokes their access temporarily. To restore an ACS user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.",
26993
+ description: "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.",
26864
26994
  operationId: "acsUsersSuspendPost",
26865
26995
  requestBody: {
26866
26996
  content: {
@@ -26868,7 +26998,7 @@ var openapi_default = {
26868
26998
  schema: {
26869
26999
  properties: {
26870
27000
  acs_user_id: {
26871
- description: "ID of the desired `acs_user`.",
27001
+ description: "ID of the access system user that you want to suspend.",
26872
27002
  format: "uuid",
26873
27003
  type: "string"
26874
27004
  }
@@ -26910,12 +27040,19 @@ var openapi_default = {
26910
27040
  },
26911
27041
  "/acs/users/unmanaged/get": {
26912
27042
  post: {
27043
+ description: "Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26913
27044
  operationId: "acsUsersUnmanagedGetPost",
26914
27045
  requestBody: {
26915
27046
  content: {
26916
27047
  "application/json": {
26917
27048
  schema: {
26918
- properties: { acs_user_id: { format: "uuid", type: "string" } },
27049
+ properties: {
27050
+ acs_user_id: {
27051
+ description: "ID of the unmanaged access system user that you want to get.",
27052
+ format: "uuid",
27053
+ type: "string"
27054
+ }
27055
+ },
26919
27056
  required: ["acs_user_id"],
26920
27057
  type: "object"
26921
27058
  }
@@ -26954,22 +27091,43 @@ var openapi_default = {
26954
27091
  "x-fern-sdk-method-name": "get",
26955
27092
  "x-fern-sdk-return-value": "acs_user",
26956
27093
  "x-response-key": "acs_user",
27094
+ "x-title": "Get an Unmanaged ACS User",
26957
27095
  "x-undocumented": "No unmanaged users are currently implemented."
26958
27096
  }
26959
27097
  },
26960
27098
  "/acs/users/unmanaged/list": {
26961
27099
  post: {
27100
+ description: "Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26962
27101
  operationId: "acsUsersUnmanagedListPost",
26963
27102
  requestBody: {
26964
27103
  content: {
26965
27104
  "application/json": {
26966
27105
  schema: {
26967
27106
  properties: {
26968
- acs_system_id: { format: "uuid", type: "string" },
26969
- limit: { default: 500, format: "float", type: "number" },
26970
- user_identity_email_address: { type: "string" },
26971
- user_identity_id: { format: "uuid", type: "string" },
26972
- user_identity_phone_number: { type: "string" }
27107
+ acs_system_id: {
27108
+ description: "ID of the access system for which you want to retrieve all unmanaged access system users.",
27109
+ format: "uuid",
27110
+ type: "string"
27111
+ },
27112
+ limit: {
27113
+ default: 500,
27114
+ description: "Number of unmanaged access system users to return.",
27115
+ format: "float",
27116
+ type: "number"
27117
+ },
27118
+ user_identity_email_address: {
27119
+ description: "Email address of the user identity for which you want to retrieve all unmanaged access system users.",
27120
+ type: "string"
27121
+ },
27122
+ user_identity_id: {
27123
+ description: "ID of the user identity for which you want to retrieve all unmanaged access system users.",
27124
+ format: "uuid",
27125
+ type: "string"
27126
+ },
27127
+ user_identity_phone_number: {
27128
+ description: "Phone number of the user identity for which you want to retrieve all unmanaged access system users.",
27129
+ type: "string"
27130
+ }
26973
27131
  },
26974
27132
  type: "object"
26975
27133
  }
@@ -27011,12 +27169,13 @@ var openapi_default = {
27011
27169
  "x-fern-sdk-method-name": "list",
27012
27170
  "x-fern-sdk-return-value": "acs_users",
27013
27171
  "x-response-key": "acs_users",
27172
+ "x-title": "List Unmanaged ACS Users",
27014
27173
  "x-undocumented": "No unmanaged users are currently implemented."
27015
27174
  }
27016
27175
  },
27017
27176
  "/acs/users/unsuspend": {
27018
27177
  post: {
27019
- description: "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an ACS user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the ACS user restores their access.",
27178
+ description: "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.",
27020
27179
  operationId: "acsUsersUnsuspendPost",
27021
27180
  requestBody: {
27022
27181
  content: {
@@ -27024,7 +27183,7 @@ var openapi_default = {
27024
27183
  schema: {
27025
27184
  properties: {
27026
27185
  acs_user_id: {
27027
- description: "ID of the desired `acs_user`.",
27186
+ description: "ID of the access system user that you want to unsuspend.",
27028
27187
  format: "uuid",
27029
27188
  type: "string"
27030
27189
  }
@@ -27066,7 +27225,7 @@ var openapi_default = {
27066
27225
  },
27067
27226
  "/acs/users/update": {
27068
27227
  patch: {
27069
- description: "Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
27228
+ description: "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
27070
27229
  operationId: "acsUsersUpdatePatch",
27071
27230
  requestBody: {
27072
27231
  content: {
@@ -27074,11 +27233,19 @@ var openapi_default = {
27074
27233
  schema: {
27075
27234
  properties: {
27076
27235
  access_schedule: {
27077
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.",
27236
+ description: "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
27078
27237
  nullable: true,
27079
27238
  properties: {
27080
- ends_at: { format: "date-time", type: "string" },
27081
- starts_at: { format: "date-time", type: "string" }
27239
+ ends_at: {
27240
+ description: "Ending timestamp for the access system user's access.",
27241
+ format: "date-time",
27242
+ type: "string"
27243
+ },
27244
+ starts_at: {
27245
+ description: "Starting timestamp for the access system user's access.",
27246
+ format: "date-time",
27247
+ type: "string"
27248
+ }
27082
27249
  },
27083
27250
  required: ["starts_at", "ends_at"],
27084
27251
  type: "object"
@@ -27144,7 +27311,7 @@ var openapi_default = {
27144
27311
  "x-title": "Update an ACS User"
27145
27312
  },
27146
27313
  post: {
27147
- description: "Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
27314
+ description: "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
27148
27315
  operationId: "acsUsersUpdatePost",
27149
27316
  requestBody: {
27150
27317
  content: {
@@ -27152,11 +27319,19 @@ var openapi_default = {
27152
27319
  schema: {
27153
27320
  properties: {
27154
27321
  access_schedule: {
27155
- description: "`starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`.",
27322
+ description: "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
27156
27323
  nullable: true,
27157
27324
  properties: {
27158
- ends_at: { format: "date-time", type: "string" },
27159
- starts_at: { format: "date-time", type: "string" }
27325
+ ends_at: {
27326
+ description: "Ending timestamp for the access system user's access.",
27327
+ format: "date-time",
27328
+ type: "string"
27329
+ },
27330
+ starts_at: {
27331
+ description: "Starting timestamp for the access system user's access.",
27332
+ format: "date-time",
27333
+ type: "string"
27334
+ }
27160
27335
  },
27161
27336
  required: ["starts_at", "ends_at"],
27162
27337
  type: "object"
@@ -27225,13 +27400,18 @@ var openapi_default = {
27225
27400
  },
27226
27401
  "/action_attempts/get": {
27227
27402
  post: {
27403
+ description: "Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
27228
27404
  operationId: "actionAttemptsGetPost",
27229
27405
  requestBody: {
27230
27406
  content: {
27231
27407
  "application/json": {
27232
27408
  schema: {
27233
27409
  properties: {
27234
- action_attempt_id: { format: "uuid", type: "string" }
27410
+ action_attempt_id: {
27411
+ description: "ID of the action attempt that you want to get.",
27412
+ format: "uuid",
27413
+ type: "string"
27414
+ }
27235
27415
  },
27236
27416
  required: ["action_attempt_id"],
27237
27417
  type: "object"
@@ -27271,11 +27451,13 @@ var openapi_default = {
27271
27451
  "x-fern-sdk-group-name": ["action_attempts"],
27272
27452
  "x-fern-sdk-method-name": "get",
27273
27453
  "x-fern-sdk-return-value": "action_attempt",
27274
- "x-response-key": "action_attempt"
27454
+ "x-response-key": "action_attempt",
27455
+ "x-title": "Get an Action Attempt"
27275
27456
  }
27276
27457
  },
27277
27458
  "/action_attempts/list": {
27278
27459
  post: {
27460
+ description: "Returns a list of the [action attempts](https://docs.seam.co/latest/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.",
27279
27461
  operationId: "actionAttemptsListPost",
27280
27462
  requestBody: {
27281
27463
  content: {
@@ -27283,6 +27465,7 @@ var openapi_default = {
27283
27465
  schema: {
27284
27466
  properties: {
27285
27467
  action_attempt_ids: {
27468
+ description: "IDs of the action attempts that you want to retrieve.",
27286
27469
  items: { format: "uuid", type: "string" },
27287
27470
  type: "array"
27288
27471
  }
@@ -27325,17 +27508,25 @@ var openapi_default = {
27325
27508
  "x-fern-sdk-group-name": ["action_attempts"],
27326
27509
  "x-fern-sdk-method-name": "list",
27327
27510
  "x-fern-sdk-return-value": "action_attempts",
27328
- "x-response-key": "action_attempts"
27511
+ "x-response-key": "action_attempts",
27512
+ "x-title": "List Action Attempts"
27329
27513
  }
27330
27514
  },
27331
27515
  "/bridges/get": {
27332
27516
  post: {
27517
+ description: "Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).",
27333
27518
  operationId: "bridgesGetPost",
27334
27519
  requestBody: {
27335
27520
  content: {
27336
27521
  "application/json": {
27337
27522
  schema: {
27338
- properties: { bridge_id: { format: "uuid", type: "string" } },
27523
+ properties: {
27524
+ bridge_id: {
27525
+ description: "ID of the Seam Bridge that you want to get.",
27526
+ format: "uuid",
27527
+ type: "string"
27528
+ }
27529
+ },
27339
27530
  required: ["bridge_id"],
27340
27531
  type: "object"
27341
27532
  }
@@ -27381,11 +27572,14 @@ var openapi_default = {
27381
27572
  "x-fern-sdk-group-name": ["bridges"],
27382
27573
  "x-fern-sdk-method-name": "get",
27383
27574
  "x-fern-sdk-return-value": "bridge",
27384
- "x-response-key": "bridge"
27575
+ "x-response-key": "bridge",
27576
+ "x-title": "Get a Seam Bridge",
27577
+ "x-undocumented": "Not yet for customer use."
27385
27578
  }
27386
27579
  },
27387
27580
  "/bridges/list": {
27388
27581
  post: {
27582
+ description: "Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).",
27389
27583
  operationId: "bridgesListPost",
27390
27584
  requestBody: {
27391
27585
  content: {
@@ -27434,11 +27628,14 @@ var openapi_default = {
27434
27628
  "x-fern-sdk-group-name": ["bridges"],
27435
27629
  "x-fern-sdk-method-name": "list",
27436
27630
  "x-fern-sdk-return-value": "bridges",
27437
- "x-response-key": "bridges"
27631
+ "x-response-key": "bridges",
27632
+ "x-title": "List Seam Bridges",
27633
+ "x-undocumented": "Not yet for customer use."
27438
27634
  }
27439
27635
  },
27440
27636
  "/client_sessions/create": {
27441
27637
  post: {
27638
+ description: "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27442
27639
  operationId: "clientSessionsCreatePost",
27443
27640
  requestBody: {
27444
27641
  content: {
@@ -27446,16 +27643,27 @@ var openapi_default = {
27446
27643
  schema: {
27447
27644
  properties: {
27448
27645
  connect_webview_ids: {
27646
+ description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.",
27449
27647
  items: { type: "string" },
27450
27648
  type: "array"
27451
27649
  },
27452
27650
  connected_account_ids: {
27651
+ description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.",
27453
27652
  items: { type: "string" },
27454
27653
  type: "array"
27455
27654
  },
27456
- expires_at: { format: "date-time", type: "string" },
27457
- user_identifier_key: { minLength: 1, type: "string" },
27655
+ expires_at: {
27656
+ description: "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
27657
+ format: "date-time",
27658
+ type: "string"
27659
+ },
27660
+ user_identifier_key: {
27661
+ description: "Your user ID for the user for whom you want to create a client session.",
27662
+ minLength: 1,
27663
+ type: "string"
27664
+ },
27458
27665
  user_identity_ids: {
27666
+ description: "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) for which you want to create a client session.",
27459
27667
  items: { type: "string" },
27460
27668
  type: "array"
27461
27669
  }
@@ -27497,9 +27705,11 @@ var openapi_default = {
27497
27705
  "x-fern-sdk-group-name": ["client_sessions"],
27498
27706
  "x-fern-sdk-method-name": "create",
27499
27707
  "x-fern-sdk-return-value": "client_session",
27500
- "x-response-key": "client_session"
27708
+ "x-response-key": "client_session",
27709
+ "x-title": "Create a Client Session"
27501
27710
  },
27502
27711
  put: {
27712
+ description: "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27503
27713
  operationId: "clientSessionsCreatePut",
27504
27714
  requestBody: {
27505
27715
  content: {
@@ -27507,16 +27717,27 @@ var openapi_default = {
27507
27717
  schema: {
27508
27718
  properties: {
27509
27719
  connect_webview_ids: {
27720
+ description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.",
27510
27721
  items: { type: "string" },
27511
27722
  type: "array"
27512
27723
  },
27513
27724
  connected_account_ids: {
27725
+ description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.",
27514
27726
  items: { type: "string" },
27515
27727
  type: "array"
27516
27728
  },
27517
- expires_at: { format: "date-time", type: "string" },
27518
- user_identifier_key: { minLength: 1, type: "string" },
27729
+ expires_at: {
27730
+ description: "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
27731
+ format: "date-time",
27732
+ type: "string"
27733
+ },
27734
+ user_identifier_key: {
27735
+ description: "Your user ID for the user for whom you want to create a client session.",
27736
+ minLength: 1,
27737
+ type: "string"
27738
+ },
27519
27739
  user_identity_ids: {
27740
+ description: "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) for which you want to create a client session.",
27520
27741
  items: { type: "string" },
27521
27742
  type: "array"
27522
27743
  }
@@ -27556,18 +27777,24 @@ var openapi_default = {
27556
27777
  summary: "/client_sessions/create",
27557
27778
  tags: ["/client_sessions"],
27558
27779
  "x-fern-ignore": true,
27559
- "x-response-key": "client_session"
27780
+ "x-response-key": "client_session",
27781
+ "x-title": "Create a Client Session"
27560
27782
  }
27561
27783
  },
27562
27784
  "/client_sessions/delete": {
27563
27785
  post: {
27786
+ description: "Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27564
27787
  operationId: "clientSessionsDeletePost",
27565
27788
  requestBody: {
27566
27789
  content: {
27567
27790
  "application/json": {
27568
27791
  schema: {
27569
27792
  properties: {
27570
- client_session_id: { format: "uuid", type: "string" }
27793
+ client_session_id: {
27794
+ description: "ID of the client session that you want to delete.",
27795
+ format: "uuid",
27796
+ type: "string"
27797
+ }
27571
27798
  },
27572
27799
  required: ["client_session_id"],
27573
27800
  type: "object"
@@ -27600,19 +27827,27 @@ var openapi_default = {
27600
27827
  tags: ["/client_sessions"],
27601
27828
  "x-fern-sdk-group-name": ["client_sessions"],
27602
27829
  "x-fern-sdk-method-name": "delete",
27603
- "x-response-key": null
27830
+ "x-response-key": null,
27831
+ "x-title": "Delete a Client Session"
27604
27832
  }
27605
27833
  },
27606
27834
  "/client_sessions/get": {
27607
27835
  post: {
27836
+ description: "Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27608
27837
  operationId: "clientSessionsGetPost",
27609
27838
  requestBody: {
27610
27839
  content: {
27611
27840
  "application/json": {
27612
27841
  schema: {
27613
27842
  properties: {
27614
- client_session_id: { type: "string" },
27615
- user_identifier_key: { type: "string" }
27843
+ client_session_id: {
27844
+ description: "ID of the client session that you want to get.",
27845
+ type: "string"
27846
+ },
27847
+ user_identifier_key: {
27848
+ description: "User identifier key associated with the client session that you want to get.",
27849
+ type: "string"
27850
+ }
27616
27851
  },
27617
27852
  type: "object"
27618
27853
  }
@@ -27651,11 +27886,13 @@ var openapi_default = {
27651
27886
  "x-fern-sdk-group-name": ["client_sessions"],
27652
27887
  "x-fern-sdk-method-name": "get",
27653
27888
  "x-fern-sdk-return-value": "client_session",
27654
- "x-response-key": "client_session"
27889
+ "x-response-key": "client_session",
27890
+ "x-title": "Get a Client Session"
27655
27891
  }
27656
27892
  },
27657
27893
  "/client_sessions/get_or_create": {
27658
27894
  post: {
27895
+ description: "Returns a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.",
27659
27896
  operationId: "clientSessionsGetOrCreatePost",
27660
27897
  requestBody: {
27661
27898
  content: {
@@ -27663,16 +27900,27 @@ var openapi_default = {
27663
27900
  schema: {
27664
27901
  properties: {
27665
27902
  connect_webview_ids: {
27903
+ description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).",
27666
27904
  items: { type: "string" },
27667
27905
  type: "array"
27668
27906
  },
27669
27907
  connected_account_ids: {
27908
+ description: "IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session).",
27670
27909
  items: { type: "string" },
27671
27910
  type: "array"
27672
27911
  },
27673
- expires_at: { format: "date-time", type: "string" },
27674
- user_identifier_key: { minLength: 1, type: "string" },
27912
+ expires_at: {
27913
+ description: "Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
27914
+ format: "date-time",
27915
+ type: "string"
27916
+ },
27917
+ user_identifier_key: {
27918
+ description: "Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).",
27919
+ minLength: 1,
27920
+ type: "string"
27921
+ },
27675
27922
  user_identity_ids: {
27923
+ description: "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) that you want to associate with the client session (or that are already associated with the existing client session).",
27676
27924
  items: { type: "string" },
27677
27925
  type: "array"
27678
27926
  }
@@ -27714,28 +27962,39 @@ var openapi_default = {
27714
27962
  "x-fern-sdk-group-name": ["client_sessions"],
27715
27963
  "x-fern-sdk-method-name": "get_or_create",
27716
27964
  "x-fern-sdk-return-value": "client_session",
27717
- "x-response-key": "client_session"
27965
+ "x-response-key": "client_session",
27966
+ "x-title": "Get or Create a Client Session"
27718
27967
  }
27719
27968
  },
27720
27969
  "/client_sessions/grant_access": {
27721
27970
  patch: {
27971
+ description: "Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.",
27722
27972
  operationId: "clientSessionsGrantAccessPatch",
27723
27973
  requestBody: {
27724
27974
  content: {
27725
27975
  "application/json": {
27726
27976
  schema: {
27727
27977
  properties: {
27728
- client_session_id: { type: "string" },
27978
+ client_session_id: {
27979
+ description: "ID of the client session to which you want to grant access to resources.",
27980
+ type: "string"
27981
+ },
27729
27982
  connect_webview_ids: {
27983
+ description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.",
27730
27984
  items: { type: "string" },
27731
27985
  type: "array"
27732
27986
  },
27733
27987
  connected_account_ids: {
27988
+ description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.",
27734
27989
  items: { type: "string" },
27735
27990
  type: "array"
27736
27991
  },
27737
- user_identifier_key: { type: "string" },
27992
+ user_identifier_key: {
27993
+ description: "Your user ID for the user that you want to associate with the client session.",
27994
+ type: "string"
27995
+ },
27738
27996
  user_identity_ids: {
27997
+ description: "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) that you want to associate with the client session.",
27739
27998
  items: { type: "string" },
27740
27999
  type: "array"
27741
28000
  }
@@ -27774,26 +28033,37 @@ var openapi_default = {
27774
28033
  summary: "/client_sessions/grant_access",
27775
28034
  tags: ["/client_sessions"],
27776
28035
  "x-fern-ignore": true,
27777
- "x-response-key": null
28036
+ "x-response-key": null,
28037
+ "x-title": "Grant Access to a Client Session"
27778
28038
  },
27779
28039
  post: {
28040
+ description: "Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.",
27780
28041
  operationId: "clientSessionsGrantAccessPost",
27781
28042
  requestBody: {
27782
28043
  content: {
27783
28044
  "application/json": {
27784
28045
  schema: {
27785
28046
  properties: {
27786
- client_session_id: { type: "string" },
28047
+ client_session_id: {
28048
+ description: "ID of the client session to which you want to grant access to resources.",
28049
+ type: "string"
28050
+ },
27787
28051
  connect_webview_ids: {
28052
+ description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.",
27788
28053
  items: { type: "string" },
27789
28054
  type: "array"
27790
28055
  },
27791
28056
  connected_account_ids: {
28057
+ description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.",
27792
28058
  items: { type: "string" },
27793
28059
  type: "array"
27794
28060
  },
27795
- user_identifier_key: { type: "string" },
28061
+ user_identifier_key: {
28062
+ description: "Your user ID for the user that you want to associate with the client session.",
28063
+ type: "string"
28064
+ },
27796
28065
  user_identity_ids: {
28066
+ description: "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) that you want to associate with the client session.",
27797
28067
  items: { type: "string" },
27798
28068
  type: "array"
27799
28069
  }
@@ -27833,22 +28103,39 @@ var openapi_default = {
27833
28103
  tags: ["/client_sessions"],
27834
28104
  "x-fern-sdk-group-name": ["client_sessions"],
27835
28105
  "x-fern-sdk-method-name": "grant_access",
27836
- "x-response-key": null
28106
+ "x-response-key": null,
28107
+ "x-title": "Grant Access to a Client Session"
27837
28108
  }
27838
28109
  },
27839
28110
  "/client_sessions/list": {
27840
28111
  post: {
28112
+ description: "Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27841
28113
  operationId: "clientSessionsListPost",
27842
28114
  requestBody: {
27843
28115
  content: {
27844
28116
  "application/json": {
27845
28117
  schema: {
27846
28118
  properties: {
27847
- client_session_id: { type: "string" },
27848
- connect_webview_id: { type: "string" },
27849
- user_identifier_key: { type: "string" },
27850
- user_identity_id: { type: "string" },
27851
- without_user_identifier_key: { type: "boolean" }
28119
+ client_session_id: {
28120
+ description: "ID of the client session that you want to retrieve.",
28121
+ type: "string"
28122
+ },
28123
+ connect_webview_id: {
28124
+ description: "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.",
28125
+ type: "string"
28126
+ },
28127
+ user_identifier_key: {
28128
+ description: "Your user ID for the user by which you want to filter client sessions.",
28129
+ type: "string"
28130
+ },
28131
+ user_identity_id: {
28132
+ description: "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) for which you want to retrieve client sessions.",
28133
+ type: "string"
28134
+ },
28135
+ without_user_identifier_key: {
28136
+ description: "Indicates whether to retrieve only client sessions without associated user identifier keys.",
28137
+ type: "boolean"
28138
+ }
27852
28139
  },
27853
28140
  type: "object"
27854
28141
  }
@@ -27887,18 +28174,24 @@ var openapi_default = {
27887
28174
  "x-fern-sdk-group-name": ["client_sessions"],
27888
28175
  "x-fern-sdk-method-name": "list",
27889
28176
  "x-fern-sdk-return-value": "client_sessions",
27890
- "x-response-key": "client_sessions"
28177
+ "x-response-key": "client_sessions",
28178
+ "x-title": "List Client Sessions"
27891
28179
  }
27892
28180
  },
27893
28181
  "/client_sessions/revoke": {
27894
28182
  post: {
28183
+ description: "Revokes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).\n\nNote that [deleting a client session](https://docs.seam.co/latest/api/client_sessions/delete) is a separate action.",
27895
28184
  operationId: "clientSessionsRevokePost",
27896
28185
  requestBody: {
27897
28186
  content: {
27898
28187
  "application/json": {
27899
28188
  schema: {
27900
28189
  properties: {
27901
- client_session_id: { format: "uuid", type: "string" }
28190
+ client_session_id: {
28191
+ description: "ID of the client session that you want to revoke.",
28192
+ format: "uuid",
28193
+ type: "string"
28194
+ }
27902
28195
  },
27903
28196
  required: ["client_session_id"],
27904
28197
  type: "object"
@@ -27931,11 +28224,13 @@ var openapi_default = {
27931
28224
  tags: ["/client_sessions"],
27932
28225
  "x-fern-sdk-group-name": ["client_sessions"],
27933
28226
  "x-fern-sdk-method-name": "revoke",
27934
- "x-response-key": null
28227
+ "x-response-key": null,
28228
+ "x-title": "Revoke a Client Session"
27935
28229
  }
27936
28230
  },
27937
28231
  "/connect_webviews/create": {
27938
28232
  post: {
28233
+ description: "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).",
27939
28234
  operationId: "connectWebviewsCreatePost",
27940
28235
  requestBody: {
27941
28236
  content: {
@@ -27943,6 +28238,7 @@ var openapi_default = {
27943
28238
  schema: {
27944
28239
  properties: {
27945
28240
  accepted_providers: {
28241
+ description: "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.",
27946
28242
  items: {
27947
28243
  enum: [
27948
28244
  "dormakaba_community",
@@ -28002,6 +28298,7 @@ var openapi_default = {
28002
28298
  },
28003
28299
  automatically_manage_new_devices: {
28004
28300
  default: true,
28301
+ description: "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).",
28005
28302
  type: "boolean"
28006
28303
  },
28007
28304
  custom_metadata: {
@@ -28012,15 +28309,24 @@ var openapi_default = {
28012
28309
  { type: "boolean" }
28013
28310
  ]
28014
28311
  },
28312
+ description: "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).",
28015
28313
  type: "object"
28016
28314
  },
28017
- custom_redirect_failure_url: { type: "string" },
28018
- custom_redirect_url: { type: "string" },
28315
+ custom_redirect_failure_url: {
28316
+ description: "Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.",
28317
+ type: "string"
28318
+ },
28319
+ custom_redirect_url: {
28320
+ description: "URL that you want to redirect the user to after the provider login is complete.",
28321
+ type: "string"
28322
+ },
28019
28323
  device_selection_mode: {
28020
28324
  enum: ["none", "single", "multiple"],
28021
- type: "string"
28325
+ type: "string",
28326
+ "x-undocumented": "Not supported."
28022
28327
  },
28023
28328
  provider_category: {
28329
+ description: "Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter.",
28024
28330
  enum: [
28025
28331
  "stable",
28026
28332
  "consumer_smartlocks",
@@ -28031,7 +28337,11 @@ var openapi_default = {
28031
28337
  ],
28032
28338
  type: "string"
28033
28339
  },
28034
- wait_for_device_creation: { default: false, type: "boolean" }
28340
+ wait_for_device_creation: {
28341
+ default: false,
28342
+ description: "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).",
28343
+ type: "boolean"
28344
+ }
28035
28345
  },
28036
28346
  type: "object"
28037
28347
  }
@@ -28070,18 +28380,24 @@ var openapi_default = {
28070
28380
  "x-fern-sdk-group-name": ["connect_webviews"],
28071
28381
  "x-fern-sdk-method-name": "create",
28072
28382
  "x-fern-sdk-return-value": "connect_webview",
28073
- "x-response-key": "connect_webview"
28383
+ "x-response-key": "connect_webview",
28384
+ "x-title": "Create a Connect Webview"
28074
28385
  }
28075
28386
  },
28076
28387
  "/connect_webviews/delete": {
28077
28388
  post: {
28389
+ description: "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.",
28078
28390
  operationId: "connectWebviewsDeletePost",
28079
28391
  requestBody: {
28080
28392
  content: {
28081
28393
  "application/json": {
28082
28394
  schema: {
28083
28395
  properties: {
28084
- connect_webview_id: { format: "uuid", type: "string" }
28396
+ connect_webview_id: {
28397
+ description: "ID of the Connect Webview that you want to delete.",
28398
+ format: "uuid",
28399
+ type: "string"
28400
+ }
28085
28401
  },
28086
28402
  required: ["connect_webview_id"],
28087
28403
  type: "object"
@@ -28114,18 +28430,24 @@ var openapi_default = {
28114
28430
  tags: ["/connect_webviews"],
28115
28431
  "x-fern-sdk-group-name": ["connect_webviews"],
28116
28432
  "x-fern-sdk-method-name": "delete",
28117
- "x-response-key": null
28433
+ "x-response-key": null,
28434
+ "x-title": "Delete a Connect Webview"
28118
28435
  }
28119
28436
  },
28120
28437
  "/connect_webviews/get": {
28121
28438
  post: {
28439
+ description: "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.",
28122
28440
  operationId: "connectWebviewsGetPost",
28123
28441
  requestBody: {
28124
28442
  content: {
28125
28443
  "application/json": {
28126
28444
  schema: {
28127
28445
  properties: {
28128
- connect_webview_id: { format: "uuid", type: "string" }
28446
+ connect_webview_id: {
28447
+ description: "ID of the Connect Webview that you want to get.",
28448
+ format: "uuid",
28449
+ type: "string"
28450
+ }
28129
28451
  },
28130
28452
  required: ["connect_webview_id"],
28131
28453
  type: "object"
@@ -28165,11 +28487,13 @@ var openapi_default = {
28165
28487
  "x-fern-sdk-group-name": ["connect_webviews"],
28166
28488
  "x-fern-sdk-method-name": "get",
28167
28489
  "x-fern-sdk-return-value": "connect_webview",
28168
- "x-response-key": "connect_webview"
28490
+ "x-response-key": "connect_webview",
28491
+ "x-title": "Get a Connect Webview"
28169
28492
  }
28170
28493
  },
28171
28494
  "/connect_webviews/list": {
28172
28495
  post: {
28496
+ description: "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).",
28173
28497
  operationId: "connectWebviewsListPost",
28174
28498
  requestBody: {
28175
28499
  content: {
@@ -28180,12 +28504,17 @@ var openapi_default = {
28180
28504
  additionalProperties: {
28181
28505
  oneOf: [{ type: "string" }, { type: "boolean" }]
28182
28506
  },
28183
- description: "Returns webviews whose custom_metadata contains all of the provided key/value pairs.",
28507
+ description: "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.",
28184
28508
  type: "object"
28185
28509
  },
28186
- limit: { default: 500, format: "float", type: "number" },
28510
+ limit: {
28511
+ default: 500,
28512
+ description: "Maximum number of records to return per page.",
28513
+ format: "float",
28514
+ type: "number"
28515
+ },
28187
28516
  user_identifier_key: {
28188
- description: "Returns webviews that can be accessed by the provided user_identifier_key.",
28517
+ description: "Your user ID for the user by which you want to filter Connect Webviews.",
28189
28518
  type: "string"
28190
28519
  }
28191
28520
  },
@@ -28227,19 +28556,29 @@ var openapi_default = {
28227
28556
  "x-fern-sdk-group-name": ["connect_webviews"],
28228
28557
  "x-fern-sdk-method-name": "list",
28229
28558
  "x-fern-sdk-return-value": "connect_webviews",
28230
- "x-response-key": "connect_webviews"
28559
+ "x-response-key": "connect_webviews",
28560
+ "x-title": "List Connect Webviews"
28231
28561
  }
28232
28562
  },
28233
28563
  "/connected_accounts/delete": {
28234
28564
  post: {
28565
+ description: "Deletes a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.",
28235
28566
  operationId: "connectedAccountsDeletePost",
28236
28567
  requestBody: {
28237
28568
  content: {
28238
28569
  "application/json": {
28239
28570
  schema: {
28240
28571
  properties: {
28241
- connected_account_id: { format: "uuid", type: "string" },
28242
- sync: { default: false, type: "boolean" }
28572
+ connected_account_id: {
28573
+ description: "ID of the connected account that you want to delete.",
28574
+ format: "uuid",
28575
+ type: "string"
28576
+ },
28577
+ sync: {
28578
+ default: false,
28579
+ type: "boolean",
28580
+ "x-undocumented": "Only used internally."
28581
+ }
28243
28582
  },
28244
28583
  required: ["connected_account_id"],
28245
28584
  type: "object"
@@ -28278,6 +28617,7 @@ var openapi_default = {
28278
28617
  },
28279
28618
  "/connected_accounts/get": {
28280
28619
  post: {
28620
+ description: "Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
28281
28621
  operationId: "connectedAccountsGetPost",
28282
28622
  requestBody: {
28283
28623
  content: {
@@ -28286,13 +28626,23 @@ var openapi_default = {
28286
28626
  oneOf: [
28287
28627
  {
28288
28628
  properties: {
28289
- connected_account_id: { format: "uuid", type: "string" }
28629
+ connected_account_id: {
28630
+ description: "ID of the connected account that you want to get.",
28631
+ format: "uuid",
28632
+ type: "string"
28633
+ }
28290
28634
  },
28291
28635
  required: ["connected_account_id"],
28292
28636
  type: "object"
28293
28637
  },
28294
28638
  {
28295
- properties: { email: { format: "email", type: "string" } },
28639
+ properties: {
28640
+ email: {
28641
+ description: "Email address associated with the connected account that you want to get.",
28642
+ format: "email",
28643
+ type: "string"
28644
+ }
28645
+ },
28296
28646
  required: ["email"],
28297
28647
  type: "object"
28298
28648
  }
@@ -28339,6 +28689,7 @@ var openapi_default = {
28339
28689
  },
28340
28690
  "/connected_accounts/list": {
28341
28691
  post: {
28692
+ description: "Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).",
28342
28693
  operationId: "connectedAccountsListPost",
28343
28694
  requestBody: {
28344
28695
  content: {
@@ -28349,7 +28700,7 @@ var openapi_default = {
28349
28700
  additionalProperties: {
28350
28701
  oneOf: [{ type: "string" }, { type: "boolean" }]
28351
28702
  },
28352
- description: "Returns accounts whose custom_metadata contains all of the provided key/value pairs.",
28703
+ description: "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.",
28353
28704
  type: "object"
28354
28705
  },
28355
28706
  customer_ids: {
@@ -28369,7 +28720,7 @@ var openapi_default = {
28369
28720
  type: "string"
28370
28721
  },
28371
28722
  user_identifier_key: {
28372
- description: "Returns accounts that can be accessed by the provided user_identifier_key.",
28723
+ description: "Your user ID for the user by which you want to filter connected accounts.",
28373
28724
  type: "string"
28374
28725
  }
28375
28726
  },
@@ -28417,14 +28768,22 @@ var openapi_default = {
28417
28768
  },
28418
28769
  "/connected_accounts/update": {
28419
28770
  post: {
28771
+ description: "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
28420
28772
  operationId: "connectedAccountsUpdatePost",
28421
28773
  requestBody: {
28422
28774
  content: {
28423
28775
  "application/json": {
28424
28776
  schema: {
28425
28777
  properties: {
28426
- automatically_manage_new_devices: { type: "boolean" },
28427
- connected_account_id: { format: "uuid", type: "string" },
28778
+ automatically_manage_new_devices: {
28779
+ description: "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
28780
+ type: "boolean"
28781
+ },
28782
+ connected_account_id: {
28783
+ description: "ID of the connected account that you want to update.",
28784
+ format: "uuid",
28785
+ type: "string"
28786
+ },
28428
28787
  custom_metadata: {
28429
28788
  additionalProperties: {
28430
28789
  nullable: true,
@@ -28433,6 +28792,7 @@ var openapi_default = {
28433
28792
  { type: "boolean" }
28434
28793
  ]
28435
28794
  },
28795
+ description: "Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).",
28436
28796
  type: "object"
28437
28797
  }
28438
28798
  },
@@ -28478,12 +28838,19 @@ var openapi_default = {
28478
28838
  },
28479
28839
  "/devices/delete": {
28480
28840
  post: {
28841
+ description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
28481
28842
  operationId: "devicesDeletePost",
28482
28843
  requestBody: {
28483
28844
  content: {
28484
28845
  "application/json": {
28485
28846
  schema: {
28486
- properties: { device_id: { format: "uuid", type: "string" } },
28847
+ properties: {
28848
+ device_id: {
28849
+ description: "ID of the device that you want to delete.",
28850
+ format: "uuid",
28851
+ type: "string"
28852
+ }
28853
+ },
28487
28854
  required: ["device_id"],
28488
28855
  type: "object"
28489
28856
  }
@@ -28517,19 +28884,28 @@ var openapi_default = {
28517
28884
  "x-fern-sdk-group-name": ["devices"],
28518
28885
  "x-fern-sdk-method-name": "delete",
28519
28886
  "x-response-key": null,
28887
+ "x-title": "Delete a Device",
28520
28888
  "x-undocumented": "Deleting a device is no longer supported and will be removed."
28521
28889
  }
28522
28890
  },
28523
28891
  "/devices/get": {
28524
28892
  post: {
28893
+ description: "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.",
28525
28894
  operationId: "devicesGetPost",
28526
28895
  requestBody: {
28527
28896
  content: {
28528
28897
  "application/json": {
28529
28898
  schema: {
28530
28899
  properties: {
28531
- device_id: { format: "uuid", type: "string" },
28532
- name: { type: "string" }
28900
+ device_id: {
28901
+ description: "ID of the device that you want to get.",
28902
+ format: "uuid",
28903
+ type: "string"
28904
+ },
28905
+ name: {
28906
+ description: "Name of the device that you want to get.",
28907
+ type: "string"
28908
+ }
28533
28909
  },
28534
28910
  type: "object"
28535
28911
  }
@@ -28566,7 +28942,8 @@ var openapi_default = {
28566
28942
  "x-fern-sdk-group-name": ["devices"],
28567
28943
  "x-fern-sdk-method-name": "get",
28568
28944
  "x-fern-sdk-return-value": "device",
28569
- "x-response-key": "device"
28945
+ "x-response-key": "device",
28946
+ "x-title": "Get a Device"
28570
28947
  }
28571
28948
  },
28572
28949
  "/devices/list": {
@@ -28579,22 +28956,22 @@ var openapi_default = {
28579
28956
  schema: {
28580
28957
  properties: {
28581
28958
  connect_webview_id: {
28582
- description: "ID of the Connect Webview by which to filter devices.",
28959
+ description: "ID of the Connect Webview for which you want to list devices.",
28583
28960
  format: "uuid",
28584
28961
  type: "string"
28585
28962
  },
28586
28963
  connected_account_id: {
28587
- description: "ID of the connected account by which to filter.",
28964
+ description: "ID of the connected account for which you want to list devices.",
28588
28965
  format: "uuid",
28589
28966
  type: "string"
28590
28967
  },
28591
28968
  connected_account_ids: {
28592
- description: "Array of IDs of the connected accounts by which to filter devices.",
28969
+ description: "Array of IDs of the connected accounts for which you want to list devices.",
28593
28970
  items: { format: "uuid", type: "string" },
28594
28971
  type: "array"
28595
28972
  },
28596
28973
  created_before: {
28597
- description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
28974
+ description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
28598
28975
  format: "date-time",
28599
28976
  type: "string"
28600
28977
  },
@@ -28602,7 +28979,7 @@ var openapi_default = {
28602
28979
  additionalProperties: {
28603
28980
  oneOf: [{ type: "string" }, { type: "boolean" }]
28604
28981
  },
28605
- description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.",
28982
+ description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
28606
28983
  type: "object"
28607
28984
  },
28608
28985
  customer_ids: {
@@ -28610,12 +28987,12 @@ var openapi_default = {
28610
28987
  type: "array"
28611
28988
  },
28612
28989
  device_ids: {
28613
- description: "Array of device IDs by which to filter devices.",
28990
+ description: "Array of device IDs for which you want to list devices.",
28614
28991
  items: { format: "uuid", type: "string" },
28615
28992
  type: "array"
28616
28993
  },
28617
28994
  device_type: {
28618
- description: "Device type by which to filter devices.",
28995
+ description: "Device type for which you want to list devices.",
28619
28996
  oneOf: [
28620
28997
  {
28621
28998
  enum: [
@@ -28672,7 +29049,7 @@ var openapi_default = {
28672
29049
  ]
28673
29050
  },
28674
29051
  device_types: {
28675
- description: "Array of device types by which to filter devices.",
29052
+ description: "Array of device types for which you want to list devices.",
28676
29053
  items: {
28677
29054
  oneOf: [
28678
29055
  {
@@ -28778,7 +29155,7 @@ var openapi_default = {
28778
29155
  type: "number"
28779
29156
  },
28780
29157
  manufacturer: {
28781
- description: "Manufacturer by which to filter devices.",
29158
+ description: "Manufacturer for which you want to list devices.",
28782
29159
  enum: [
28783
29160
  "akuvox",
28784
29161
  "august",
@@ -28827,13 +29204,14 @@ var openapi_default = {
28827
29204
  type: "string"
28828
29205
  },
28829
29206
  unstable_location_id: {
29207
+ description: "ID of the location for which you want to list devices.",
28830
29208
  format: "uuid",
28831
29209
  nullable: true,
28832
29210
  type: "string",
28833
29211
  "x-undocumented": "Experimental locations."
28834
29212
  },
28835
29213
  user_identifier_key: {
28836
- description: "Your own internal user ID for the user by which to filter devices.",
29214
+ description: "Your own internal user ID for the user for which you want to list devices.",
28837
29215
  type: "string"
28838
29216
  }
28839
29217
  },
@@ -28882,6 +29260,7 @@ var openapi_default = {
28882
29260
  },
28883
29261
  "/devices/list_device_providers": {
28884
29262
  post: {
29263
+ description: "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers\u2014that is, the brands\u2014that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).",
28885
29264
  operationId: "devicesListDeviceProvidersPost",
28886
29265
  requestBody: {
28887
29266
  content: {
@@ -28889,6 +29268,7 @@ var openapi_default = {
28889
29268
  schema: {
28890
29269
  properties: {
28891
29270
  provider_category: {
29271
+ description: "Category for which you want to list providers.",
28892
29272
  enum: [
28893
29273
  "stable",
28894
29274
  "consumer_smartlocks",
@@ -28937,17 +29317,25 @@ var openapi_default = {
28937
29317
  "x-fern-sdk-group-name": ["devices"],
28938
29318
  "x-fern-sdk-method-name": "list_device_providers",
28939
29319
  "x-fern-sdk-return-value": "device_providers",
28940
- "x-response-key": "device_providers"
29320
+ "x-response-key": "device_providers",
29321
+ "x-title": "List Device Providers"
28941
29322
  }
28942
29323
  },
28943
29324
  "/devices/simulate/connect": {
28944
29325
  post: {
29326
+ description: "Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
28945
29327
  operationId: "devicesSimulateConnectPost",
28946
29328
  requestBody: {
28947
29329
  content: {
28948
29330
  "application/json": {
28949
29331
  schema: {
28950
- properties: { device_id: { format: "uuid", type: "string" } },
29332
+ properties: {
29333
+ device_id: {
29334
+ description: "ID of the device that you want to simulate connecting to Seam.",
29335
+ format: "uuid",
29336
+ type: "string"
29337
+ }
29338
+ },
28951
29339
  required: ["device_id"],
28952
29340
  type: "object"
28953
29341
  }
@@ -28979,17 +29367,25 @@ var openapi_default = {
28979
29367
  tags: ["/devices"],
28980
29368
  "x-fern-sdk-group-name": ["devices", "simulate"],
28981
29369
  "x-fern-sdk-method-name": "connect",
28982
- "x-response-key": null
29370
+ "x-response-key": null,
29371
+ "x-title": "Simulate Device Connection"
28983
29372
  }
28984
29373
  },
28985
29374
  "/devices/simulate/disconnect": {
28986
29375
  post: {
29376
+ description: "Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
28987
29377
  operationId: "devicesSimulateDisconnectPost",
28988
29378
  requestBody: {
28989
29379
  content: {
28990
29380
  "application/json": {
28991
29381
  schema: {
28992
- properties: { device_id: { format: "uuid", type: "string" } },
29382
+ properties: {
29383
+ device_id: {
29384
+ description: "ID of the device that you want to simulate disconnecting from Seam.",
29385
+ format: "uuid",
29386
+ type: "string"
29387
+ }
29388
+ },
28993
29389
  required: ["device_id"],
28994
29390
  type: "object"
28995
29391
  }
@@ -29021,17 +29417,25 @@ var openapi_default = {
29021
29417
  tags: ["/devices"],
29022
29418
  "x-fern-sdk-group-name": ["devices", "simulate"],
29023
29419
  "x-fern-sdk-method-name": "disconnect",
29024
- "x-response-key": null
29420
+ "x-response-key": null,
29421
+ "x-title": "Simulate Device Disconnection"
29025
29422
  }
29026
29423
  },
29027
29424
  "/devices/simulate/remove": {
29028
29425
  post: {
29426
+ description: "Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
29029
29427
  operationId: "devicesSimulateRemovePost",
29030
29428
  requestBody: {
29031
29429
  content: {
29032
29430
  "application/json": {
29033
29431
  schema: {
29034
- properties: { device_id: { format: "uuid", type: "string" } },
29432
+ properties: {
29433
+ device_id: {
29434
+ description: "ID of the device that you want to simulate removing from Seam.",
29435
+ format: "uuid",
29436
+ type: "string"
29437
+ }
29438
+ },
29035
29439
  required: ["device_id"],
29036
29440
  type: "object"
29037
29441
  }
@@ -29063,19 +29467,28 @@ var openapi_default = {
29063
29467
  tags: ["/devices"],
29064
29468
  "x-fern-sdk-group-name": ["devices", "simulate"],
29065
29469
  "x-fern-sdk-method-name": "remove",
29066
- "x-response-key": null
29470
+ "x-response-key": null,
29471
+ "x-title": "Simulate Device Removal"
29067
29472
  }
29068
29473
  },
29069
29474
  "/devices/unmanaged/get": {
29070
29475
  post: {
29476
+ description: "Returns a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.",
29071
29477
  operationId: "devicesUnmanagedGetPost",
29072
29478
  requestBody: {
29073
29479
  content: {
29074
29480
  "application/json": {
29075
29481
  schema: {
29076
29482
  properties: {
29077
- device_id: { format: "uuid", type: "string" },
29078
- name: { type: "string" }
29483
+ device_id: {
29484
+ description: "ID of the unmanaged device that you want to get.",
29485
+ format: "uuid",
29486
+ type: "string"
29487
+ },
29488
+ name: {
29489
+ description: "Name of the unmanaged device that you want to get.",
29490
+ type: "string"
29491
+ }
29079
29492
  },
29080
29493
  type: "object"
29081
29494
  }
@@ -29112,11 +29525,13 @@ var openapi_default = {
29112
29525
  "x-fern-sdk-group-name": ["devices", "unmanaged"],
29113
29526
  "x-fern-sdk-method-name": "get",
29114
29527
  "x-fern-sdk-return-value": "device",
29115
- "x-response-key": "device"
29528
+ "x-response-key": "device",
29529
+ "x-title": "Get an Unmanaged Device"
29116
29530
  }
29117
29531
  },
29118
29532
  "/devices/unmanaged/list": {
29119
29533
  post: {
29534
+ description: "Returns a list of all [unmanaged devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
29120
29535
  operationId: "devicesUnmanagedListPost",
29121
29536
  requestBody: {
29122
29537
  content: {
@@ -29124,22 +29539,22 @@ var openapi_default = {
29124
29539
  schema: {
29125
29540
  properties: {
29126
29541
  connect_webview_id: {
29127
- description: "ID of the Connect Webview by which to filter devices.",
29542
+ description: "ID of the Connect Webview for which you want to list devices.",
29128
29543
  format: "uuid",
29129
29544
  type: "string"
29130
29545
  },
29131
29546
  connected_account_id: {
29132
- description: "ID of the connected account by which to filter.",
29547
+ description: "ID of the connected account for which you want to list devices.",
29133
29548
  format: "uuid",
29134
29549
  type: "string"
29135
29550
  },
29136
29551
  connected_account_ids: {
29137
- description: "Array of IDs of the connected accounts by which to filter devices.",
29552
+ description: "Array of IDs of the connected accounts for which you want to list devices.",
29138
29553
  items: { format: "uuid", type: "string" },
29139
29554
  type: "array"
29140
29555
  },
29141
29556
  created_before: {
29142
- description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
29557
+ description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
29143
29558
  format: "date-time",
29144
29559
  type: "string"
29145
29560
  },
@@ -29147,7 +29562,7 @@ var openapi_default = {
29147
29562
  additionalProperties: {
29148
29563
  oneOf: [{ type: "string" }, { type: "boolean" }]
29149
29564
  },
29150
- description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.",
29565
+ description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
29151
29566
  type: "object"
29152
29567
  },
29153
29568
  customer_ids: {
@@ -29155,12 +29570,12 @@ var openapi_default = {
29155
29570
  type: "array"
29156
29571
  },
29157
29572
  device_ids: {
29158
- description: "Array of device IDs by which to filter devices.",
29573
+ description: "Array of device IDs for which you want to list devices.",
29159
29574
  items: { format: "uuid", type: "string" },
29160
29575
  type: "array"
29161
29576
  },
29162
29577
  device_type: {
29163
- description: "Device type by which to filter devices.",
29578
+ description: "Device type for which you want to list devices.",
29164
29579
  oneOf: [
29165
29580
  {
29166
29581
  enum: [
@@ -29217,7 +29632,7 @@ var openapi_default = {
29217
29632
  ]
29218
29633
  },
29219
29634
  device_types: {
29220
- description: "Array of device types by which to filter devices.",
29635
+ description: "Array of device types for which you want to list devices.",
29221
29636
  items: {
29222
29637
  oneOf: [
29223
29638
  {
@@ -29323,7 +29738,7 @@ var openapi_default = {
29323
29738
  type: "number"
29324
29739
  },
29325
29740
  manufacturer: {
29326
- description: "Manufacturer by which to filter devices.",
29741
+ description: "Manufacturer for which you want to list devices.",
29327
29742
  enum: [
29328
29743
  "akuvox",
29329
29744
  "august",
@@ -29372,13 +29787,14 @@ var openapi_default = {
29372
29787
  type: "string"
29373
29788
  },
29374
29789
  unstable_location_id: {
29790
+ description: "ID of the location for which you want to list devices.",
29375
29791
  format: "uuid",
29376
29792
  nullable: true,
29377
29793
  type: "string",
29378
29794
  "x-undocumented": "Experimental locations."
29379
29795
  },
29380
29796
  user_identifier_key: {
29381
- description: "Your own internal user ID for the user by which to filter devices.",
29797
+ description: "Your own internal user ID for the user for which you want to list devices.",
29382
29798
  type: "string"
29383
29799
  }
29384
29800
  },
@@ -29419,19 +29835,29 @@ var openapi_default = {
29419
29835
  "x-fern-sdk-group-name": ["devices", "unmanaged"],
29420
29836
  "x-fern-sdk-method-name": "list",
29421
29837
  "x-fern-sdk-return-value": "devices",
29422
- "x-response-key": "devices"
29838
+ "x-response-key": "devices",
29839
+ "x-title": "List Unmanaged Devices"
29423
29840
  }
29424
29841
  },
29425
29842
  "/devices/unmanaged/update": {
29426
29843
  patch: {
29844
+ description: "Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
29427
29845
  operationId: "devicesUnmanagedUpdatePatch",
29428
29846
  requestBody: {
29429
29847
  content: {
29430
29848
  "application/json": {
29431
29849
  schema: {
29432
29850
  properties: {
29433
- device_id: { format: "uuid", type: "string" },
29434
- is_managed: { enum: [true], type: "boolean" }
29851
+ device_id: {
29852
+ description: "ID of the unmanaged device that you want to update.",
29853
+ format: "uuid",
29854
+ type: "string"
29855
+ },
29856
+ is_managed: {
29857
+ description: "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.",
29858
+ enum: [true],
29859
+ type: "boolean"
29860
+ }
29435
29861
  },
29436
29862
  required: ["device_id", "is_managed"],
29437
29863
  type: "object"
@@ -29463,17 +29889,27 @@ var openapi_default = {
29463
29889
  summary: "/devices/unmanaged/update",
29464
29890
  tags: ["/devices"],
29465
29891
  "x-fern-ignore": true,
29466
- "x-response-key": null
29892
+ "x-response-key": null,
29893
+ "x-title": "Update an Unmanaged Device"
29467
29894
  },
29468
29895
  post: {
29896
+ description: "Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
29469
29897
  operationId: "devicesUnmanagedUpdatePost",
29470
29898
  requestBody: {
29471
29899
  content: {
29472
29900
  "application/json": {
29473
29901
  schema: {
29474
29902
  properties: {
29475
- device_id: { format: "uuid", type: "string" },
29476
- is_managed: { enum: [true], type: "boolean" }
29903
+ device_id: {
29904
+ description: "ID of the unmanaged device that you want to update.",
29905
+ format: "uuid",
29906
+ type: "string"
29907
+ },
29908
+ is_managed: {
29909
+ description: "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.",
29910
+ enum: [true],
29911
+ type: "boolean"
29912
+ }
29477
29913
  },
29478
29914
  required: ["device_id", "is_managed"],
29479
29915
  type: "object"
@@ -29506,11 +29942,13 @@ var openapi_default = {
29506
29942
  tags: ["/devices"],
29507
29943
  "x-fern-sdk-group-name": ["devices", "unmanaged"],
29508
29944
  "x-fern-sdk-method-name": "update",
29509
- "x-response-key": null
29945
+ "x-response-key": null,
29946
+ "x-title": "Update an Unmanaged Device"
29510
29947
  }
29511
29948
  },
29512
29949
  "/devices/update": {
29513
29950
  patch: {
29951
+ description: "Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
29514
29952
  operationId: "devicesUpdatePatch",
29515
29953
  requestBody: {
29516
29954
  content: {
@@ -29525,13 +29963,32 @@ var openapi_default = {
29525
29963
  { type: "boolean" }
29526
29964
  ]
29527
29965
  },
29966
+ description: "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).",
29528
29967
  type: "object"
29529
29968
  },
29530
- device_id: { format: "uuid", type: "string" },
29531
- is_managed: { default: true, type: "boolean" },
29532
- name: { nullable: true, type: "string" },
29969
+ device_id: {
29970
+ description: "ID of the device that you want to update.",
29971
+ format: "uuid",
29972
+ type: "string"
29973
+ },
29974
+ is_managed: {
29975
+ default: true,
29976
+ description: "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.",
29977
+ type: "boolean"
29978
+ },
29979
+ name: {
29980
+ description: "Name for the device.",
29981
+ nullable: true,
29982
+ type: "string"
29983
+ },
29533
29984
  properties: {
29534
- properties: { name: { nullable: true, type: "string" } },
29985
+ properties: {
29986
+ name: {
29987
+ description: "Name for the device.",
29988
+ nullable: true,
29989
+ type: "string"
29990
+ }
29991
+ },
29535
29992
  type: "object"
29536
29993
  }
29537
29994
  },
@@ -29566,9 +30023,11 @@ var openapi_default = {
29566
30023
  summary: "/devices/update",
29567
30024
  tags: ["/devices"],
29568
30025
  "x-fern-ignore": true,
29569
- "x-response-key": null
30026
+ "x-response-key": null,
30027
+ "x-title": "Update a Device"
29570
30028
  },
29571
30029
  post: {
30030
+ description: "Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
29572
30031
  operationId: "devicesUpdatePost",
29573
30032
  requestBody: {
29574
30033
  content: {
@@ -29583,13 +30042,32 @@ var openapi_default = {
29583
30042
  { type: "boolean" }
29584
30043
  ]
29585
30044
  },
30045
+ description: "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).",
29586
30046
  type: "object"
29587
30047
  },
29588
- device_id: { format: "uuid", type: "string" },
29589
- is_managed: { default: true, type: "boolean" },
29590
- name: { nullable: true, type: "string" },
30048
+ device_id: {
30049
+ description: "ID of the device that you want to update.",
30050
+ format: "uuid",
30051
+ type: "string"
30052
+ },
30053
+ is_managed: {
30054
+ default: true,
30055
+ description: "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.",
30056
+ type: "boolean"
30057
+ },
30058
+ name: {
30059
+ description: "Name for the device.",
30060
+ nullable: true,
30061
+ type: "string"
30062
+ },
29591
30063
  properties: {
29592
- properties: { name: { nullable: true, type: "string" } },
30064
+ properties: {
30065
+ name: {
30066
+ description: "Name for the device.",
30067
+ nullable: true,
30068
+ type: "string"
30069
+ }
30070
+ },
29593
30071
  type: "object"
29594
30072
  }
29595
30073
  },
@@ -29625,11 +30103,13 @@ var openapi_default = {
29625
30103
  tags: ["/devices"],
29626
30104
  "x-fern-sdk-group-name": ["devices"],
29627
30105
  "x-fern-sdk-method-name": "update",
29628
- "x-response-key": null
30106
+ "x-response-key": null,
30107
+ "x-title": "Update a Device"
29629
30108
  }
29630
30109
  },
29631
30110
  "/events/get": {
29632
30111
  post: {
30112
+ description: "Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to retrieve an event that already took place.",
29633
30113
  operationId: "eventsGetPost",
29634
30114
  requestBody: {
29635
30115
  content: {
@@ -29676,11 +30156,13 @@ var openapi_default = {
29676
30156
  "x-fern-sdk-group-name": ["events"],
29677
30157
  "x-fern-sdk-method-name": "get",
29678
30158
  "x-fern-sdk-return-value": "event",
29679
- "x-response-key": "event"
30159
+ "x-response-key": "event",
30160
+ "x-title": "Get an Event"
29680
30161
  }
29681
30162
  },
29682
30163
  "/events/list": {
29683
30164
  post: {
30165
+ description: "Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.",
29684
30166
  operationId: "eventsListPost",
29685
30167
  requestBody: {
29686
30168
  content: {
@@ -29954,7 +30436,8 @@ var openapi_default = {
29954
30436
  "x-fern-sdk-group-name": ["events"],
29955
30437
  "x-fern-sdk-method-name": "list",
29956
30438
  "x-fern-sdk-return-value": "events",
29957
- "x-response-key": "events"
30439
+ "x-response-key": "events",
30440
+ "x-title": "List Events"
29958
30441
  }
29959
30442
  },
29960
30443
  "/locks/get": {
@@ -30017,22 +30500,22 @@ var openapi_default = {
30017
30500
  schema: {
30018
30501
  properties: {
30019
30502
  connect_webview_id: {
30020
- description: "ID of the Connect Webview by which to filter devices.",
30503
+ description: "ID of the Connect Webview for which you want to list devices.",
30021
30504
  format: "uuid",
30022
30505
  type: "string"
30023
30506
  },
30024
30507
  connected_account_id: {
30025
- description: "ID of the connected account by which to filter.",
30508
+ description: "ID of the connected account for which you want to list devices.",
30026
30509
  format: "uuid",
30027
30510
  type: "string"
30028
30511
  },
30029
30512
  connected_account_ids: {
30030
- description: "Array of IDs of the connected accounts by which to filter devices.",
30513
+ description: "Array of IDs of the connected accounts for which you want to list devices.",
30031
30514
  items: { format: "uuid", type: "string" },
30032
30515
  type: "array"
30033
30516
  },
30034
30517
  created_before: {
30035
- description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
30518
+ description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
30036
30519
  format: "date-time",
30037
30520
  type: "string"
30038
30521
  },
@@ -30040,7 +30523,7 @@ var openapi_default = {
30040
30523
  additionalProperties: {
30041
30524
  oneOf: [{ type: "string" }, { type: "boolean" }]
30042
30525
  },
30043
- description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.",
30526
+ description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
30044
30527
  type: "object"
30045
30528
  },
30046
30529
  customer_ids: {
@@ -30048,7 +30531,7 @@ var openapi_default = {
30048
30531
  type: "array"
30049
30532
  },
30050
30533
  device_ids: {
30051
- description: "Array of device IDs by which to filter devices.",
30534
+ description: "Array of device IDs for which you want to list devices.",
30052
30535
  items: { format: "uuid", type: "string" },
30053
30536
  type: "array"
30054
30537
  },
@@ -30206,13 +30689,14 @@ var openapi_default = {
30206
30689
  type: "string"
30207
30690
  },
30208
30691
  unstable_location_id: {
30692
+ description: "ID of the location for which you want to list devices.",
30209
30693
  format: "uuid",
30210
30694
  nullable: true,
30211
30695
  type: "string",
30212
30696
  "x-undocumented": "Experimental locations."
30213
30697
  },
30214
30698
  user_identifier_key: {
30215
- description: "Your own internal user ID for the user by which to filter devices.",
30699
+ description: "Your own internal user ID for the user for which you want to list devices.",
30216
30700
  type: "string"
30217
30701
  }
30218
30702
  },
@@ -30568,22 +31052,22 @@ var openapi_default = {
30568
31052
  schema: {
30569
31053
  properties: {
30570
31054
  connect_webview_id: {
30571
- description: "ID of the Connect Webview by which to filter devices.",
31055
+ description: "ID of the Connect Webview for which you want to list devices.",
30572
31056
  format: "uuid",
30573
31057
  type: "string"
30574
31058
  },
30575
31059
  connected_account_id: {
30576
- description: "ID of the connected account by which to filter.",
31060
+ description: "ID of the connected account for which you want to list devices.",
30577
31061
  format: "uuid",
30578
31062
  type: "string"
30579
31063
  },
30580
31064
  connected_account_ids: {
30581
- description: "Array of IDs of the connected accounts by which to filter devices.",
31065
+ description: "Array of IDs of the connected accounts for which you want to list devices.",
30582
31066
  items: { format: "uuid", type: "string" },
30583
31067
  type: "array"
30584
31068
  },
30585
31069
  created_before: {
30586
- description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
31070
+ description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
30587
31071
  format: "date-time",
30588
31072
  type: "string"
30589
31073
  },
@@ -30591,7 +31075,7 @@ var openapi_default = {
30591
31075
  additionalProperties: {
30592
31076
  oneOf: [{ type: "string" }, { type: "boolean" }]
30593
31077
  },
30594
- description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.",
31078
+ description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
30595
31079
  type: "object"
30596
31080
  },
30597
31081
  customer_ids: {
@@ -30599,7 +31083,7 @@ var openapi_default = {
30599
31083
  type: "array"
30600
31084
  },
30601
31085
  device_ids: {
30602
- description: "Array of device IDs by which to filter devices.",
31086
+ description: "Array of device IDs for which you want to list devices.",
30603
31087
  items: { format: "uuid", type: "string" },
30604
31088
  type: "array"
30605
31089
  },
@@ -30673,13 +31157,14 @@ var openapi_default = {
30673
31157
  type: "string"
30674
31158
  },
30675
31159
  unstable_location_id: {
31160
+ description: "ID of the location for which you want to list devices.",
30676
31161
  format: "uuid",
30677
31162
  nullable: true,
30678
31163
  type: "string",
30679
31164
  "x-undocumented": "Experimental locations."
30680
31165
  },
30681
31166
  user_identifier_key: {
30682
- description: "Your own internal user ID for the user by which to filter devices.",
31167
+ description: "Your own internal user ID for the user for which you want to list devices.",
30683
31168
  type: "string"
30684
31169
  }
30685
31170
  },
@@ -33461,22 +33946,22 @@ var openapi_default = {
33461
33946
  schema: {
33462
33947
  properties: {
33463
33948
  connect_webview_id: {
33464
- description: "ID of the Connect Webview by which to filter devices.",
33949
+ description: "ID of the Connect Webview for which you want to list devices.",
33465
33950
  format: "uuid",
33466
33951
  type: "string"
33467
33952
  },
33468
33953
  connected_account_id: {
33469
- description: "ID of the connected account by which to filter.",
33954
+ description: "ID of the connected account for which you want to list devices.",
33470
33955
  format: "uuid",
33471
33956
  type: "string"
33472
33957
  },
33473
33958
  connected_account_ids: {
33474
- description: "Array of IDs of the connected accounts by which to filter devices.",
33959
+ description: "Array of IDs of the connected accounts for which you want to list devices.",
33475
33960
  items: { format: "uuid", type: "string" },
33476
33961
  type: "array"
33477
33962
  },
33478
33963
  created_before: {
33479
- description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
33964
+ description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
33480
33965
  format: "date-time",
33481
33966
  type: "string"
33482
33967
  },
@@ -33484,7 +33969,7 @@ var openapi_default = {
33484
33969
  additionalProperties: {
33485
33970
  oneOf: [{ type: "string" }, { type: "boolean" }]
33486
33971
  },
33487
- description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.",
33972
+ description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
33488
33973
  type: "object"
33489
33974
  },
33490
33975
  customer_ids: {
@@ -33492,7 +33977,7 @@ var openapi_default = {
33492
33977
  type: "array"
33493
33978
  },
33494
33979
  device_ids: {
33495
- description: "Array of device IDs by which to filter devices.",
33980
+ description: "Array of device IDs for which you want to list devices.",
33496
33981
  items: { format: "uuid", type: "string" },
33497
33982
  type: "array"
33498
33983
  },
@@ -33586,13 +34071,14 @@ var openapi_default = {
33586
34071
  type: "string"
33587
34072
  },
33588
34073
  unstable_location_id: {
34074
+ description: "ID of the location for which you want to list devices.",
33589
34075
  format: "uuid",
33590
34076
  nullable: true,
33591
34077
  type: "string",
33592
34078
  "x-undocumented": "Experimental locations."
33593
34079
  },
33594
34080
  user_identifier_key: {
33595
- description: "Your own internal user ID for the user by which to filter devices.",
34081
+ description: "Your own internal user ID for the user for which you want to list devices.",
33596
34082
  type: "string"
33597
34083
  }
33598
34084
  },
@@ -36731,6 +37217,101 @@ var openapi_default = {
36731
37217
  "x-undocumented": "Experimental locations."
36732
37218
  }
36733
37219
  },
37220
+ "/unstable_partner/resources/push": {
37221
+ post: {
37222
+ description: "Send Seam some of your resources.",
37223
+ operationId: "unstablePartnerResourcesPushPost",
37224
+ requestBody: {
37225
+ content: {
37226
+ "application/json": {
37227
+ schema: {
37228
+ oneOf: [
37229
+ {
37230
+ items: {
37231
+ properties: {
37232
+ custom_metadata: {
37233
+ additionalProperties: { type: "string" },
37234
+ type: "object"
37235
+ },
37236
+ customer_key: { type: "string" },
37237
+ description: { type: "string" },
37238
+ email_address: { type: "string" },
37239
+ ends_at: { type: "string" },
37240
+ icon_url: { type: "string" },
37241
+ location_keys: {
37242
+ items: { type: "string" },
37243
+ type: "array"
37244
+ },
37245
+ name: { type: "string" },
37246
+ partner_resource_key: { type: "string" },
37247
+ partner_resource_type: { type: "string" },
37248
+ phone_number: { type: "string" },
37249
+ starts_at: { type: "string" },
37250
+ user_identity_key: { type: "string" }
37251
+ },
37252
+ type: "object"
37253
+ },
37254
+ type: "array"
37255
+ },
37256
+ {
37257
+ properties: {
37258
+ custom_metadata: {
37259
+ additionalProperties: { type: "string" },
37260
+ type: "object"
37261
+ },
37262
+ customer_key: { type: "string" },
37263
+ description: { type: "string" },
37264
+ email_address: { type: "string" },
37265
+ ends_at: { type: "string" },
37266
+ icon_url: { type: "string" },
37267
+ location_keys: {
37268
+ items: { type: "string" },
37269
+ type: "array"
37270
+ },
37271
+ name: { type: "string" },
37272
+ partner_resource_key: { type: "string" },
37273
+ partner_resource_type: { type: "string" },
37274
+ phone_number: { type: "string" },
37275
+ starts_at: { type: "string" },
37276
+ user_identity_key: { type: "string" }
37277
+ },
37278
+ type: "object"
37279
+ }
37280
+ ]
37281
+ }
37282
+ }
37283
+ }
37284
+ },
37285
+ responses: {
37286
+ 200: {
37287
+ content: {
37288
+ "application/json": {
37289
+ schema: {
37290
+ properties: { ok: { type: "boolean" } },
37291
+ required: ["ok"],
37292
+ type: "object"
37293
+ }
37294
+ }
37295
+ },
37296
+ description: "OK"
37297
+ },
37298
+ 400: { description: "Bad Request" },
37299
+ 401: { description: "Unauthorized" }
37300
+ },
37301
+ security: [
37302
+ { pat_with_workspace: [] },
37303
+ { console_session_with_workspace: [] },
37304
+ { api_key: [] }
37305
+ ],
37306
+ summary: "/unstable_partner/resources/push",
37307
+ tags: [],
37308
+ "x-fern-sdk-group-name": ["unstable_partner", "resources"],
37309
+ "x-fern-sdk-method-name": "push",
37310
+ "x-response-key": null,
37311
+ "x-title": "Push partner resources at Seam",
37312
+ "x-undocumented": "Experimental partner resources."
37313
+ }
37314
+ },
36734
37315
  "/user_identities/add_acs_user": {
36735
37316
  post: {
36736
37317
  description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
@@ -36918,7 +37499,7 @@ var openapi_default = {
36918
37499
  },
36919
37500
  "/user_identities/delete": {
36920
37501
  post: {
36921
- description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [ACS credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.",
37502
+ description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.",
36922
37503
  operationId: "userIdentitiesDeletePost",
36923
37504
  requestBody: {
36924
37505
  content: {
@@ -38484,6 +39065,7 @@ var openapi_default = {
38484
39065
  },
38485
39066
  "/workspaces/reset_sandbox": {
38486
39067
  post: {
39068
+ description: "Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.",
38487
39069
  operationId: "workspacesResetSandboxPost",
38488
39070
  responses: {
38489
39071
  200: {