@seamapi/types 1.398.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 +886 -294
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +848 -177
  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 +381 -0
  26. package/lib/seam/connect/openapi.js +804 -255
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +467 -177
  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 +1007 -255
  42. package/src/lib/seam/connect/route-types.ts +469 -177
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
  }
@@ -24345,8 +24429,13 @@ var openapi_default = {
24345
24429
  enum: ["code", "card", "mobile_key"],
24346
24430
  type: "string"
24347
24431
  },
24432
+ 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`.",
24434
+ format: "uuid",
24435
+ type: "string"
24436
+ },
24348
24437
  acs_user_id: {
24349
- description: "ID of the ACS user to whom the new credential belongs.",
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`.",
24350
24439
  format: "uuid",
24351
24440
  type: "string"
24352
24441
  },
@@ -24392,8 +24481,14 @@ var openapi_default = {
24392
24481
  salto_space_metadata: {
24393
24482
  description: "Salto Space-specific metadata for the new credential.",
24394
24483
  properties: {
24395
- assign_new_key: { type: "boolean" },
24396
- 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
+ }
24397
24492
  },
24398
24493
  type: "object"
24399
24494
  },
@@ -24402,6 +24497,11 @@ var openapi_default = {
24402
24497
  format: "date-time",
24403
24498
  type: "string"
24404
24499
  },
24500
+ user_identity_id: {
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.",
24502
+ format: "uuid",
24503
+ type: "string"
24504
+ },
24405
24505
  visionline_metadata: {
24406
24506
  description: "Visionline-specific metadata for the new credential.",
24407
24507
  properties: {
@@ -24437,7 +24537,7 @@ var openapi_default = {
24437
24537
  type: "object"
24438
24538
  }
24439
24539
  },
24440
- required: ["acs_user_id", "access_method"],
24540
+ required: ["access_method"],
24441
24541
  type: "object"
24442
24542
  }
24443
24543
  }
@@ -24480,7 +24580,7 @@ var openapi_default = {
24480
24580
  },
24481
24581
  "/acs/credentials/create_offline_code": {
24482
24582
  post: {
24483
- 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).",
24484
24584
  operationId: "acsCredentialsCreateOfflineCodePost",
24485
24585
  requestBody: {
24486
24586
  content: {
@@ -24488,7 +24588,7 @@ var openapi_default = {
24488
24588
  schema: {
24489
24589
  properties: {
24490
24590
  acs_user_id: {
24491
- 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.",
24492
24592
  format: "uuid",
24493
24593
  type: "string"
24494
24594
  },
@@ -24565,7 +24665,7 @@ var openapi_default = {
24565
24665
  schema: {
24566
24666
  properties: {
24567
24667
  acs_credential_id: {
24568
- description: "ID of the desired credential.",
24668
+ description: "ID of the credential that you want to delete.",
24569
24669
  format: "uuid",
24570
24670
  type: "string"
24571
24671
  }
@@ -24615,7 +24715,7 @@ var openapi_default = {
24615
24715
  schema: {
24616
24716
  properties: {
24617
24717
  acs_credential_id: {
24618
- description: "ID of the desired credential.",
24718
+ description: "ID of the credential that you want to get.",
24619
24719
  format: "uuid",
24620
24720
  type: "string"
24621
24721
  }
@@ -24675,7 +24775,7 @@ var openapi_default = {
24675
24775
  {
24676
24776
  properties: {
24677
24777
  acs_user_id: {
24678
- 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.",
24679
24779
  format: "uuid",
24680
24780
  type: "string"
24681
24781
  }
@@ -24686,7 +24786,7 @@ var openapi_default = {
24686
24786
  {
24687
24787
  properties: {
24688
24788
  acs_system_id: {
24689
- 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.",
24690
24790
  format: "uuid",
24691
24791
  type: "string"
24692
24792
  }
@@ -24697,12 +24797,12 @@ var openapi_default = {
24697
24797
  {
24698
24798
  properties: {
24699
24799
  acs_system_id: {
24700
- 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.",
24701
24801
  format: "uuid",
24702
24802
  type: "string"
24703
24803
  },
24704
24804
  acs_user_id: {
24705
- 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.",
24706
24806
  format: "uuid",
24707
24807
  type: "string"
24708
24808
  }
@@ -24796,7 +24896,7 @@ var openapi_default = {
24796
24896
  schema: {
24797
24897
  properties: {
24798
24898
  acs_credential_id: {
24799
- 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.",
24800
24900
  format: "uuid",
24801
24901
  type: "string"
24802
24902
  }
@@ -24845,7 +24945,7 @@ var openapi_default = {
24845
24945
  },
24846
24946
  "/acs/credentials/unassign": {
24847
24947
  patch: {
24848
- 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).",
24849
24949
  operationId: "acsCredentialsUnassignPatch",
24850
24950
  requestBody: {
24851
24951
  content: {
@@ -24853,12 +24953,12 @@ var openapi_default = {
24853
24953
  schema: {
24854
24954
  properties: {
24855
24955
  acs_credential_id: {
24856
- description: "ID of the desired credential.",
24956
+ description: "ID of the credential that you want to unassign from an access system user.",
24857
24957
  format: "uuid",
24858
24958
  type: "string"
24859
24959
  },
24860
24960
  acs_user_id: {
24861
- description: "ID of the desired user.",
24961
+ description: "ID of the access system user from which you want to unassign a credential.",
24862
24962
  format: "uuid",
24863
24963
  type: "string"
24864
24964
  }
@@ -24902,7 +25002,7 @@ var openapi_default = {
24902
25002
  "x-title": "Unassign a Credential from an ACS User"
24903
25003
  },
24904
25004
  post: {
24905
- 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).",
24906
25006
  operationId: "acsCredentialsUnassignPost",
24907
25007
  requestBody: {
24908
25008
  content: {
@@ -24910,12 +25010,12 @@ var openapi_default = {
24910
25010
  schema: {
24911
25011
  properties: {
24912
25012
  acs_credential_id: {
24913
- description: "ID of the desired credential.",
25013
+ description: "ID of the credential that you want to unassign from an access system user.",
24914
25014
  format: "uuid",
24915
25015
  type: "string"
24916
25016
  },
24917
25017
  acs_user_id: {
24918
- description: "ID of the desired user.",
25018
+ description: "ID of the access system user from which you want to unassign a credential.",
24919
25019
  format: "uuid",
24920
25020
  type: "string"
24921
25021
  }
@@ -24970,7 +25070,7 @@ var openapi_default = {
24970
25070
  schema: {
24971
25071
  properties: {
24972
25072
  acs_credential_id: {
24973
- description: "ID of the desired unmanaged credential.",
25073
+ description: "ID of the unmanaged credential that you want to get.",
24974
25074
  format: "uuid",
24975
25075
  type: "string"
24976
25076
  }
@@ -25027,9 +25127,10 @@ var openapi_default = {
25027
25127
  schema: {
25028
25128
  oneOf: [
25029
25129
  {
25130
+ description: "ID of the access system user for which you want to list unmanaged credentials.",
25030
25131
  properties: {
25031
25132
  acs_user_id: {
25032
- 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.",
25033
25134
  format: "uuid",
25034
25135
  type: "string"
25035
25136
  }
@@ -25038,9 +25139,10 @@ var openapi_default = {
25038
25139
  type: "object"
25039
25140
  },
25040
25141
  {
25142
+ description: "ID of the access system for which you want to list unmanaged credentials.",
25041
25143
  properties: {
25042
25144
  acs_system_id: {
25043
- 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.",
25044
25146
  format: "uuid",
25045
25147
  type: "string"
25046
25148
  }
@@ -25049,14 +25151,15 @@ var openapi_default = {
25049
25151
  type: "object"
25050
25152
  },
25051
25153
  {
25154
+ description: "ID of the access system and ID of the access system user for which you want to list unmanaged credentials.",
25052
25155
  properties: {
25053
25156
  acs_system_id: {
25054
- 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.",
25055
25158
  format: "uuid",
25056
25159
  type: "string"
25057
25160
  },
25058
25161
  acs_user_id: {
25059
- 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.",
25060
25163
  format: "uuid",
25061
25164
  type: "string"
25062
25165
  }
@@ -25065,6 +25168,7 @@ var openapi_default = {
25065
25168
  type: "object"
25066
25169
  },
25067
25170
  {
25171
+ description: "ID of the user identity for which you want to list unmanaged credentials.",
25068
25172
  properties: {
25069
25173
  user_identity_id: {
25070
25174
  description: "ID of the user identity for which you want to retrieve all credentials.",
@@ -25129,11 +25233,11 @@ var openapi_default = {
25129
25233
  schema: {
25130
25234
  properties: {
25131
25235
  acs_credential_id: {
25132
- description: "ID of the desired credential.",
25236
+ description: "ID of the credential that you want to update.",
25133
25237
  type: "string"
25134
25238
  },
25135
25239
  code: {
25136
- description: "Replacement access (PIN) code for the credential.",
25240
+ description: "Replacement access (PIN) code for the credential that you want to update.",
25137
25241
  pattern: "^\\d+$",
25138
25242
  type: "string"
25139
25243
  },
@@ -25190,11 +25294,11 @@ var openapi_default = {
25190
25294
  schema: {
25191
25295
  properties: {
25192
25296
  acs_credential_id: {
25193
- description: "ID of the desired credential.",
25297
+ description: "ID of the credential that you want to update.",
25194
25298
  type: "string"
25195
25299
  },
25196
25300
  code: {
25197
- description: "Replacement access (PIN) code for the credential.",
25301
+ description: "Replacement access (PIN) code for the credential that you want to update.",
25198
25302
  pattern: "^\\d+$",
25199
25303
  type: "string"
25200
25304
  },
@@ -25378,7 +25482,7 @@ var openapi_default = {
25378
25482
  schema: {
25379
25483
  properties: {
25380
25484
  acs_encoder_id: {
25381
- description: "ID of the desired encoder.",
25485
+ description: "ID of the encoder that you want to get.",
25382
25486
  format: "uuid",
25383
25487
  type: "string"
25384
25488
  }
@@ -25434,13 +25538,13 @@ var openapi_default = {
25434
25538
  {
25435
25539
  properties: {
25436
25540
  acs_system_id: {
25437
- 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.",
25438
25542
  format: "uuid",
25439
25543
  type: "string"
25440
25544
  },
25441
25545
  limit: {
25442
25546
  default: 500,
25443
- description: "Number of `acs_encoders` to return.",
25547
+ description: "Number of encoders to return.",
25444
25548
  format: "float",
25445
25549
  type: "number"
25446
25550
  }
@@ -25451,13 +25555,13 @@ var openapi_default = {
25451
25555
  {
25452
25556
  properties: {
25453
25557
  acs_system_ids: {
25454
- 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.",
25455
25559
  items: { format: "uuid", type: "string" },
25456
25560
  type: "array"
25457
25561
  },
25458
25562
  limit: {
25459
25563
  default: 500,
25460
- description: "Number of `acs_encoders` to return.",
25564
+ description: "Number of encoders to return.",
25461
25565
  format: "float",
25462
25566
  type: "number"
25463
25567
  }
@@ -25468,13 +25572,13 @@ var openapi_default = {
25468
25572
  {
25469
25573
  properties: {
25470
25574
  acs_encoder_ids: {
25471
- description: "IDs of the `acs_encoder`s that you want to retrieve.",
25575
+ description: "IDs of the encoders that you want to retrieve.",
25472
25576
  items: { format: "uuid", type: "string" },
25473
25577
  type: "array"
25474
25578
  },
25475
25579
  limit: {
25476
25580
  default: 500,
25477
- description: "Number of `acs_encoders` to return.",
25581
+ description: "Number of encoders to return.",
25478
25582
  format: "float",
25479
25583
  type: "number"
25480
25584
  }
@@ -25533,7 +25637,7 @@ var openapi_default = {
25533
25637
  schema: {
25534
25638
  properties: {
25535
25639
  acs_encoder_id: {
25536
- description: "ID of the `acs_encoder` to use for the scan.",
25640
+ description: "ID of the encoder to use for the scan.",
25537
25641
  format: "uuid",
25538
25642
  type: "string"
25539
25643
  }
@@ -25905,14 +26009,18 @@ var openapi_default = {
25905
26009
  },
25906
26010
  "/acs/entrances/get": {
25907
26011
  post: {
25908
- 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).",
25909
26013
  operationId: "acsEntrancesGetPost",
25910
26014
  requestBody: {
25911
26015
  content: {
25912
26016
  "application/json": {
25913
26017
  schema: {
25914
26018
  properties: {
25915
- 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
+ }
25916
26024
  },
25917
26025
  required: ["acs_entrance_id"],
25918
26026
  type: "object"
@@ -25956,14 +26064,23 @@ var openapi_default = {
25956
26064
  },
25957
26065
  "/acs/entrances/grant_access": {
25958
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).",
25959
26068
  operationId: "acsEntrancesGrantAccessPost",
25960
26069
  requestBody: {
25961
26070
  content: {
25962
26071
  "application/json": {
25963
26072
  schema: {
25964
26073
  properties: {
25965
- acs_entrance_id: { format: "uuid", type: "string" },
25966
- 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
+ }
25967
26084
  },
25968
26085
  required: ["acs_entrance_id", "acs_user_id"],
25969
26086
  type: "object"
@@ -26002,16 +26119,25 @@ var openapi_default = {
26002
26119
  },
26003
26120
  "/acs/entrances/list": {
26004
26121
  post: {
26005
- 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).",
26006
26123
  operationId: "acsEntrancesListPost",
26007
26124
  requestBody: {
26008
26125
  content: {
26009
26126
  "application/json": {
26010
26127
  schema: {
26011
26128
  properties: {
26012
- acs_credential_id: { format: "uuid", type: "string" },
26013
- 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
+ },
26014
26139
  location_id: {
26140
+ description: "ID of the location for which you want to retrieve all entrances.",
26015
26141
  format: "uuid",
26016
26142
  nullable: true,
26017
26143
  type: "string",
@@ -26069,8 +26195,13 @@ var openapi_default = {
26069
26195
  "application/json": {
26070
26196
  schema: {
26071
26197
  properties: {
26072
- 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
+ },
26073
26203
  include_if: {
26204
+ description: "Conditions that credentials must meet to be included in the returned list.",
26074
26205
  items: {
26075
26206
  enum: ["visionline_metadata.is_valid"],
26076
26207
  type: "string"
@@ -26123,7 +26254,7 @@ var openapi_default = {
26123
26254
  },
26124
26255
  "/acs/systems/get": {
26125
26256
  post: {
26126
- 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).",
26127
26258
  operationId: "acsSystemsGetPost",
26128
26259
  requestBody: {
26129
26260
  content: {
@@ -26131,7 +26262,7 @@ var openapi_default = {
26131
26262
  schema: {
26132
26263
  properties: {
26133
26264
  acs_system_id: {
26134
- description: "ID of the desired access control system.",
26265
+ description: "ID of the access system that you want to get.",
26135
26266
  format: "uuid",
26136
26267
  type: "string"
26137
26268
  }
@@ -26177,7 +26308,7 @@ var openapi_default = {
26177
26308
  },
26178
26309
  "/acs/systems/list": {
26179
26310
  post: {
26180
- 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.",
26181
26312
  operationId: "acsSystemsListPost",
26182
26313
  requestBody: {
26183
26314
  content: {
@@ -26185,7 +26316,7 @@ var openapi_default = {
26185
26316
  schema: {
26186
26317
  properties: {
26187
26318
  connected_account_id: {
26188
- 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.",
26189
26320
  format: "uuid",
26190
26321
  type: "string"
26191
26322
  }
@@ -26234,7 +26365,7 @@ var openapi_default = {
26234
26365
  },
26235
26366
  "/acs/systems/list_compatible_credential_manager_acs_systems": {
26236
26367
  post: {
26237
- 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.",
26238
26369
  operationId: "acsSystemsListCompatibleCredentialManagerAcsSystemsPost",
26239
26370
  requestBody: {
26240
26371
  content: {
@@ -26242,7 +26373,7 @@ var openapi_default = {
26242
26373
  schema: {
26243
26374
  properties: {
26244
26375
  acs_system_id: {
26245
- 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.",
26246
26377
  format: "uuid",
26247
26378
  type: "string"
26248
26379
  }
@@ -26291,7 +26422,7 @@ var openapi_default = {
26291
26422
  },
26292
26423
  "/acs/users/add_to_access_group": {
26293
26424
  post: {
26294
- 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).",
26295
26426
  operationId: "acsUsersAddToAccessGroupPost",
26296
26427
  requestBody: {
26297
26428
  content: {
@@ -26299,12 +26430,12 @@ var openapi_default = {
26299
26430
  schema: {
26300
26431
  properties: {
26301
26432
  acs_access_group_id: {
26302
- description: "ID of the desired access group.",
26433
+ description: "ID of the access group to which you want to add an access system user.",
26303
26434
  format: "uuid",
26304
26435
  type: "string"
26305
26436
  },
26306
26437
  acs_user_id: {
26307
- description: "ID of the desired `acs_user`.",
26438
+ description: "ID of the access system user that you want to add to an access group.",
26308
26439
  format: "uuid",
26309
26440
  type: "string"
26310
26441
  }
@@ -26344,7 +26475,7 @@ var openapi_default = {
26344
26475
  "x-title": "Add an ACS User to an Access Group"
26345
26476
  },
26346
26477
  put: {
26347
- 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).",
26348
26479
  operationId: "acsUsersAddToAccessGroupPut",
26349
26480
  requestBody: {
26350
26481
  content: {
@@ -26352,12 +26483,12 @@ var openapi_default = {
26352
26483
  schema: {
26353
26484
  properties: {
26354
26485
  acs_access_group_id: {
26355
- description: "ID of the desired access group.",
26486
+ description: "ID of the access group to which you want to add an access system user.",
26356
26487
  format: "uuid",
26357
26488
  type: "string"
26358
26489
  },
26359
26490
  acs_user_id: {
26360
- description: "ID of the desired `acs_user`.",
26491
+ description: "ID of the access system user that you want to add to an access group.",
26361
26492
  format: "uuid",
26362
26493
  type: "string"
26363
26494
  }
@@ -26398,7 +26529,7 @@ var openapi_default = {
26398
26529
  },
26399
26530
  "/acs/users/create": {
26400
26531
  post: {
26401
- 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).",
26402
26533
  operationId: "acsUsersCreatePost",
26403
26534
  requestBody: {
26404
26535
  content: {
@@ -26406,25 +26537,30 @@ var openapi_default = {
26406
26537
  schema: {
26407
26538
  properties: {
26408
26539
  access_schedule: {
26409
- 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`.",
26410
26541
  properties: {
26411
26542
  ends_at: {
26543
+ description: "Ending timestamp for the new access system user's access.",
26412
26544
  format: "date-time",
26413
26545
  nullable: true,
26414
26546
  type: "string"
26415
26547
  },
26416
- 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
+ }
26417
26553
  },
26418
26554
  type: "object"
26419
26555
  },
26420
26556
  acs_access_group_ids: {
26421
26557
  default: [],
26422
- 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.",
26423
26559
  items: { format: "uuid", type: "string" },
26424
26560
  type: "array"
26425
26561
  },
26426
26562
  acs_system_id: {
26427
- 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.",
26428
26564
  format: "uuid",
26429
26565
  type: "string"
26430
26566
  },
@@ -26440,7 +26576,7 @@ var openapi_default = {
26440
26576
  type: "string"
26441
26577
  },
26442
26578
  full_name: {
26443
- description: "Full name of the new `acs_user`.",
26579
+ description: "Full name of the new access system user.",
26444
26580
  type: "string"
26445
26581
  },
26446
26582
  phone_number: {
@@ -26448,7 +26584,7 @@ var openapi_default = {
26448
26584
  type: "string"
26449
26585
  },
26450
26586
  user_identity_id: {
26451
- 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.",
26452
26588
  format: "uuid",
26453
26589
  type: "string"
26454
26590
  }
@@ -26494,7 +26630,7 @@ var openapi_default = {
26494
26630
  },
26495
26631
  "/acs/users/delete": {
26496
26632
  post: {
26497
- 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).",
26498
26634
  operationId: "acsUsersDeletePost",
26499
26635
  requestBody: {
26500
26636
  content: {
@@ -26502,7 +26638,7 @@ var openapi_default = {
26502
26638
  schema: {
26503
26639
  properties: {
26504
26640
  acs_user_id: {
26505
- description: "ID of the desired `acs_user`.",
26641
+ description: "ID of the access system user that you want to delete.",
26506
26642
  format: "uuid",
26507
26643
  type: "string"
26508
26644
  }
@@ -26544,7 +26680,7 @@ var openapi_default = {
26544
26680
  },
26545
26681
  "/acs/users/get": {
26546
26682
  post: {
26547
- 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).",
26548
26684
  operationId: "acsUsersGetPost",
26549
26685
  requestBody: {
26550
26686
  content: {
@@ -26552,7 +26688,7 @@ var openapi_default = {
26552
26688
  schema: {
26553
26689
  properties: {
26554
26690
  acs_user_id: {
26555
- description: "ID of the desired `acs_user`.",
26691
+ description: "ID of the access system user that you want to get.",
26556
26692
  format: "uuid",
26557
26693
  type: "string"
26558
26694
  }
@@ -26598,7 +26734,7 @@ var openapi_default = {
26598
26734
  },
26599
26735
  "/acs/users/list": {
26600
26736
  post: {
26601
- 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).",
26602
26738
  operationId: "acsUsersListPost",
26603
26739
  requestBody: {
26604
26740
  content: {
@@ -26606,11 +26742,15 @@ var openapi_default = {
26606
26742
  schema: {
26607
26743
  properties: {
26608
26744
  acs_system_id: {
26609
- 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.",
26610
26746
  format: "uuid",
26611
26747
  type: "string"
26612
26748
  },
26613
- 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
+ },
26614
26754
  limit: {
26615
26755
  default: 500,
26616
26756
  description: "Maximum number of records to return per page.",
@@ -26624,21 +26764,21 @@ var openapi_default = {
26624
26764
  type: "string"
26625
26765
  },
26626
26766
  search: {
26627
- 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`.",
26628
26768
  minLength: 1,
26629
26769
  type: "string"
26630
26770
  },
26631
26771
  user_identity_email_address: {
26632
- 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.",
26633
26773
  type: "string"
26634
26774
  },
26635
26775
  user_identity_id: {
26636
- 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.",
26637
26777
  format: "uuid",
26638
26778
  type: "string"
26639
26779
  },
26640
26780
  user_identity_phone_number: {
26641
- 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`).",
26642
26782
  type: "string"
26643
26783
  }
26644
26784
  },
@@ -26687,7 +26827,7 @@ var openapi_default = {
26687
26827
  },
26688
26828
  "/acs/users/list_accessible_entrances": {
26689
26829
  post: {
26690
- 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.",
26691
26831
  operationId: "acsUsersListAccessibleEntrancesPost",
26692
26832
  requestBody: {
26693
26833
  content: {
@@ -26695,7 +26835,7 @@ var openapi_default = {
26695
26835
  schema: {
26696
26836
  properties: {
26697
26837
  acs_user_id: {
26698
- description: "ID of the desired `acs_user`.",
26838
+ description: "ID of the access system user for whom you want to list accessible entrances.",
26699
26839
  format: "uuid",
26700
26840
  type: "string"
26701
26841
  }
@@ -26745,7 +26885,7 @@ var openapi_default = {
26745
26885
  },
26746
26886
  "/acs/users/remove_from_access_group": {
26747
26887
  post: {
26748
- 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).",
26749
26889
  operationId: "acsUsersRemoveFromAccessGroupPost",
26750
26890
  requestBody: {
26751
26891
  content: {
@@ -26753,12 +26893,12 @@ var openapi_default = {
26753
26893
  schema: {
26754
26894
  properties: {
26755
26895
  acs_access_group_id: {
26756
- description: "ID of the desired access group.",
26896
+ description: "ID of the access group from which you want to remove an access system user.",
26757
26897
  format: "uuid",
26758
26898
  type: "string"
26759
26899
  },
26760
26900
  acs_user_id: {
26761
- description: "ID of the desired `acs_user`.",
26901
+ description: "ID of the access system user that you want to remove from an access group.",
26762
26902
  format: "uuid",
26763
26903
  type: "string"
26764
26904
  }
@@ -26800,7 +26940,7 @@ var openapi_default = {
26800
26940
  },
26801
26941
  "/acs/users/revoke_access_to_all_entrances": {
26802
26942
  post: {
26803
- 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).",
26804
26944
  operationId: "acsUsersRevokeAccessToAllEntrancesPost",
26805
26945
  requestBody: {
26806
26946
  content: {
@@ -26808,7 +26948,7 @@ var openapi_default = {
26808
26948
  schema: {
26809
26949
  properties: {
26810
26950
  acs_user_id: {
26811
- description: "ID of the desired `acs_user`.",
26951
+ description: "ID of the access system user for whom you want to revoke access.",
26812
26952
  format: "uuid",
26813
26953
  type: "string"
26814
26954
  }
@@ -26850,7 +26990,7 @@ var openapi_default = {
26850
26990
  },
26851
26991
  "/acs/users/suspend": {
26852
26992
  post: {
26853
- 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.",
26854
26994
  operationId: "acsUsersSuspendPost",
26855
26995
  requestBody: {
26856
26996
  content: {
@@ -26858,7 +26998,7 @@ var openapi_default = {
26858
26998
  schema: {
26859
26999
  properties: {
26860
27000
  acs_user_id: {
26861
- description: "ID of the desired `acs_user`.",
27001
+ description: "ID of the access system user that you want to suspend.",
26862
27002
  format: "uuid",
26863
27003
  type: "string"
26864
27004
  }
@@ -26900,12 +27040,19 @@ var openapi_default = {
26900
27040
  },
26901
27041
  "/acs/users/unmanaged/get": {
26902
27042
  post: {
27043
+ description: "Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26903
27044
  operationId: "acsUsersUnmanagedGetPost",
26904
27045
  requestBody: {
26905
27046
  content: {
26906
27047
  "application/json": {
26907
27048
  schema: {
26908
- 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
+ },
26909
27056
  required: ["acs_user_id"],
26910
27057
  type: "object"
26911
27058
  }
@@ -26944,22 +27091,43 @@ var openapi_default = {
26944
27091
  "x-fern-sdk-method-name": "get",
26945
27092
  "x-fern-sdk-return-value": "acs_user",
26946
27093
  "x-response-key": "acs_user",
27094
+ "x-title": "Get an Unmanaged ACS User",
26947
27095
  "x-undocumented": "No unmanaged users are currently implemented."
26948
27096
  }
26949
27097
  },
26950
27098
  "/acs/users/unmanaged/list": {
26951
27099
  post: {
27100
+ description: "Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
26952
27101
  operationId: "acsUsersUnmanagedListPost",
26953
27102
  requestBody: {
26954
27103
  content: {
26955
27104
  "application/json": {
26956
27105
  schema: {
26957
27106
  properties: {
26958
- acs_system_id: { format: "uuid", type: "string" },
26959
- limit: { default: 500, format: "float", type: "number" },
26960
- user_identity_email_address: { type: "string" },
26961
- user_identity_id: { format: "uuid", type: "string" },
26962
- 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
+ }
26963
27131
  },
26964
27132
  type: "object"
26965
27133
  }
@@ -27001,12 +27169,13 @@ var openapi_default = {
27001
27169
  "x-fern-sdk-method-name": "list",
27002
27170
  "x-fern-sdk-return-value": "acs_users",
27003
27171
  "x-response-key": "acs_users",
27172
+ "x-title": "List Unmanaged ACS Users",
27004
27173
  "x-undocumented": "No unmanaged users are currently implemented."
27005
27174
  }
27006
27175
  },
27007
27176
  "/acs/users/unsuspend": {
27008
27177
  post: {
27009
- 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.",
27010
27179
  operationId: "acsUsersUnsuspendPost",
27011
27180
  requestBody: {
27012
27181
  content: {
@@ -27014,7 +27183,7 @@ var openapi_default = {
27014
27183
  schema: {
27015
27184
  properties: {
27016
27185
  acs_user_id: {
27017
- description: "ID of the desired `acs_user`.",
27186
+ description: "ID of the access system user that you want to unsuspend.",
27018
27187
  format: "uuid",
27019
27188
  type: "string"
27020
27189
  }
@@ -27056,7 +27225,7 @@ var openapi_default = {
27056
27225
  },
27057
27226
  "/acs/users/update": {
27058
27227
  patch: {
27059
- 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).",
27060
27229
  operationId: "acsUsersUpdatePatch",
27061
27230
  requestBody: {
27062
27231
  content: {
@@ -27064,11 +27233,19 @@ var openapi_default = {
27064
27233
  schema: {
27065
27234
  properties: {
27066
27235
  access_schedule: {
27067
- 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`.",
27068
27237
  nullable: true,
27069
27238
  properties: {
27070
- ends_at: { format: "date-time", type: "string" },
27071
- 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
+ }
27072
27249
  },
27073
27250
  required: ["starts_at", "ends_at"],
27074
27251
  type: "object"
@@ -27134,7 +27311,7 @@ var openapi_default = {
27134
27311
  "x-title": "Update an ACS User"
27135
27312
  },
27136
27313
  post: {
27137
- 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).",
27138
27315
  operationId: "acsUsersUpdatePost",
27139
27316
  requestBody: {
27140
27317
  content: {
@@ -27142,11 +27319,19 @@ var openapi_default = {
27142
27319
  schema: {
27143
27320
  properties: {
27144
27321
  access_schedule: {
27145
- 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`.",
27146
27323
  nullable: true,
27147
27324
  properties: {
27148
- ends_at: { format: "date-time", type: "string" },
27149
- 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
+ }
27150
27335
  },
27151
27336
  required: ["starts_at", "ends_at"],
27152
27337
  type: "object"
@@ -27215,13 +27400,18 @@ var openapi_default = {
27215
27400
  },
27216
27401
  "/action_attempts/get": {
27217
27402
  post: {
27403
+ description: "Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
27218
27404
  operationId: "actionAttemptsGetPost",
27219
27405
  requestBody: {
27220
27406
  content: {
27221
27407
  "application/json": {
27222
27408
  schema: {
27223
27409
  properties: {
27224
- 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
+ }
27225
27415
  },
27226
27416
  required: ["action_attempt_id"],
27227
27417
  type: "object"
@@ -27261,11 +27451,13 @@ var openapi_default = {
27261
27451
  "x-fern-sdk-group-name": ["action_attempts"],
27262
27452
  "x-fern-sdk-method-name": "get",
27263
27453
  "x-fern-sdk-return-value": "action_attempt",
27264
- "x-response-key": "action_attempt"
27454
+ "x-response-key": "action_attempt",
27455
+ "x-title": "Get an Action Attempt"
27265
27456
  }
27266
27457
  },
27267
27458
  "/action_attempts/list": {
27268
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.",
27269
27461
  operationId: "actionAttemptsListPost",
27270
27462
  requestBody: {
27271
27463
  content: {
@@ -27273,6 +27465,7 @@ var openapi_default = {
27273
27465
  schema: {
27274
27466
  properties: {
27275
27467
  action_attempt_ids: {
27468
+ description: "IDs of the action attempts that you want to retrieve.",
27276
27469
  items: { format: "uuid", type: "string" },
27277
27470
  type: "array"
27278
27471
  }
@@ -27315,17 +27508,25 @@ var openapi_default = {
27315
27508
  "x-fern-sdk-group-name": ["action_attempts"],
27316
27509
  "x-fern-sdk-method-name": "list",
27317
27510
  "x-fern-sdk-return-value": "action_attempts",
27318
- "x-response-key": "action_attempts"
27511
+ "x-response-key": "action_attempts",
27512
+ "x-title": "List Action Attempts"
27319
27513
  }
27320
27514
  },
27321
27515
  "/bridges/get": {
27322
27516
  post: {
27517
+ description: "Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).",
27323
27518
  operationId: "bridgesGetPost",
27324
27519
  requestBody: {
27325
27520
  content: {
27326
27521
  "application/json": {
27327
27522
  schema: {
27328
- 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
+ },
27329
27530
  required: ["bridge_id"],
27330
27531
  type: "object"
27331
27532
  }
@@ -27371,11 +27572,14 @@ var openapi_default = {
27371
27572
  "x-fern-sdk-group-name": ["bridges"],
27372
27573
  "x-fern-sdk-method-name": "get",
27373
27574
  "x-fern-sdk-return-value": "bridge",
27374
- "x-response-key": "bridge"
27575
+ "x-response-key": "bridge",
27576
+ "x-title": "Get a Seam Bridge",
27577
+ "x-undocumented": "Not yet for customer use."
27375
27578
  }
27376
27579
  },
27377
27580
  "/bridges/list": {
27378
27581
  post: {
27582
+ description: "Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).",
27379
27583
  operationId: "bridgesListPost",
27380
27584
  requestBody: {
27381
27585
  content: {
@@ -27424,11 +27628,14 @@ var openapi_default = {
27424
27628
  "x-fern-sdk-group-name": ["bridges"],
27425
27629
  "x-fern-sdk-method-name": "list",
27426
27630
  "x-fern-sdk-return-value": "bridges",
27427
- "x-response-key": "bridges"
27631
+ "x-response-key": "bridges",
27632
+ "x-title": "List Seam Bridges",
27633
+ "x-undocumented": "Not yet for customer use."
27428
27634
  }
27429
27635
  },
27430
27636
  "/client_sessions/create": {
27431
27637
  post: {
27638
+ description: "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27432
27639
  operationId: "clientSessionsCreatePost",
27433
27640
  requestBody: {
27434
27641
  content: {
@@ -27436,16 +27643,27 @@ var openapi_default = {
27436
27643
  schema: {
27437
27644
  properties: {
27438
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.",
27439
27647
  items: { type: "string" },
27440
27648
  type: "array"
27441
27649
  },
27442
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.",
27443
27652
  items: { type: "string" },
27444
27653
  type: "array"
27445
27654
  },
27446
- expires_at: { format: "date-time", type: "string" },
27447
- 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
+ },
27448
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.",
27449
27667
  items: { type: "string" },
27450
27668
  type: "array"
27451
27669
  }
@@ -27487,9 +27705,11 @@ var openapi_default = {
27487
27705
  "x-fern-sdk-group-name": ["client_sessions"],
27488
27706
  "x-fern-sdk-method-name": "create",
27489
27707
  "x-fern-sdk-return-value": "client_session",
27490
- "x-response-key": "client_session"
27708
+ "x-response-key": "client_session",
27709
+ "x-title": "Create a Client Session"
27491
27710
  },
27492
27711
  put: {
27712
+ description: "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27493
27713
  operationId: "clientSessionsCreatePut",
27494
27714
  requestBody: {
27495
27715
  content: {
@@ -27497,16 +27717,27 @@ var openapi_default = {
27497
27717
  schema: {
27498
27718
  properties: {
27499
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.",
27500
27721
  items: { type: "string" },
27501
27722
  type: "array"
27502
27723
  },
27503
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.",
27504
27726
  items: { type: "string" },
27505
27727
  type: "array"
27506
27728
  },
27507
- expires_at: { format: "date-time", type: "string" },
27508
- 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
+ },
27509
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.",
27510
27741
  items: { type: "string" },
27511
27742
  type: "array"
27512
27743
  }
@@ -27546,18 +27777,24 @@ var openapi_default = {
27546
27777
  summary: "/client_sessions/create",
27547
27778
  tags: ["/client_sessions"],
27548
27779
  "x-fern-ignore": true,
27549
- "x-response-key": "client_session"
27780
+ "x-response-key": "client_session",
27781
+ "x-title": "Create a Client Session"
27550
27782
  }
27551
27783
  },
27552
27784
  "/client_sessions/delete": {
27553
27785
  post: {
27786
+ description: "Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27554
27787
  operationId: "clientSessionsDeletePost",
27555
27788
  requestBody: {
27556
27789
  content: {
27557
27790
  "application/json": {
27558
27791
  schema: {
27559
27792
  properties: {
27560
- 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
+ }
27561
27798
  },
27562
27799
  required: ["client_session_id"],
27563
27800
  type: "object"
@@ -27590,19 +27827,27 @@ var openapi_default = {
27590
27827
  tags: ["/client_sessions"],
27591
27828
  "x-fern-sdk-group-name": ["client_sessions"],
27592
27829
  "x-fern-sdk-method-name": "delete",
27593
- "x-response-key": null
27830
+ "x-response-key": null,
27831
+ "x-title": "Delete a Client Session"
27594
27832
  }
27595
27833
  },
27596
27834
  "/client_sessions/get": {
27597
27835
  post: {
27836
+ description: "Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27598
27837
  operationId: "clientSessionsGetPost",
27599
27838
  requestBody: {
27600
27839
  content: {
27601
27840
  "application/json": {
27602
27841
  schema: {
27603
27842
  properties: {
27604
- client_session_id: { type: "string" },
27605
- 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
+ }
27606
27851
  },
27607
27852
  type: "object"
27608
27853
  }
@@ -27641,11 +27886,13 @@ var openapi_default = {
27641
27886
  "x-fern-sdk-group-name": ["client_sessions"],
27642
27887
  "x-fern-sdk-method-name": "get",
27643
27888
  "x-fern-sdk-return-value": "client_session",
27644
- "x-response-key": "client_session"
27889
+ "x-response-key": "client_session",
27890
+ "x-title": "Get a Client Session"
27645
27891
  }
27646
27892
  },
27647
27893
  "/client_sessions/get_or_create": {
27648
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.",
27649
27896
  operationId: "clientSessionsGetOrCreatePost",
27650
27897
  requestBody: {
27651
27898
  content: {
@@ -27653,16 +27900,27 @@ var openapi_default = {
27653
27900
  schema: {
27654
27901
  properties: {
27655
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).",
27656
27904
  items: { type: "string" },
27657
27905
  type: "array"
27658
27906
  },
27659
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).",
27660
27909
  items: { type: "string" },
27661
27910
  type: "array"
27662
27911
  },
27663
- expires_at: { format: "date-time", type: "string" },
27664
- 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
+ },
27665
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).",
27666
27924
  items: { type: "string" },
27667
27925
  type: "array"
27668
27926
  }
@@ -27704,28 +27962,39 @@ var openapi_default = {
27704
27962
  "x-fern-sdk-group-name": ["client_sessions"],
27705
27963
  "x-fern-sdk-method-name": "get_or_create",
27706
27964
  "x-fern-sdk-return-value": "client_session",
27707
- "x-response-key": "client_session"
27965
+ "x-response-key": "client_session",
27966
+ "x-title": "Get or Create a Client Session"
27708
27967
  }
27709
27968
  },
27710
27969
  "/client_sessions/grant_access": {
27711
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.",
27712
27972
  operationId: "clientSessionsGrantAccessPatch",
27713
27973
  requestBody: {
27714
27974
  content: {
27715
27975
  "application/json": {
27716
27976
  schema: {
27717
27977
  properties: {
27718
- 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
+ },
27719
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.",
27720
27984
  items: { type: "string" },
27721
27985
  type: "array"
27722
27986
  },
27723
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.",
27724
27989
  items: { type: "string" },
27725
27990
  type: "array"
27726
27991
  },
27727
- 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
+ },
27728
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.",
27729
27998
  items: { type: "string" },
27730
27999
  type: "array"
27731
28000
  }
@@ -27764,26 +28033,37 @@ var openapi_default = {
27764
28033
  summary: "/client_sessions/grant_access",
27765
28034
  tags: ["/client_sessions"],
27766
28035
  "x-fern-ignore": true,
27767
- "x-response-key": null
28036
+ "x-response-key": null,
28037
+ "x-title": "Grant Access to a Client Session"
27768
28038
  },
27769
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.",
27770
28041
  operationId: "clientSessionsGrantAccessPost",
27771
28042
  requestBody: {
27772
28043
  content: {
27773
28044
  "application/json": {
27774
28045
  schema: {
27775
28046
  properties: {
27776
- 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
+ },
27777
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.",
27778
28053
  items: { type: "string" },
27779
28054
  type: "array"
27780
28055
  },
27781
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.",
27782
28058
  items: { type: "string" },
27783
28059
  type: "array"
27784
28060
  },
27785
- 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
+ },
27786
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.",
27787
28067
  items: { type: "string" },
27788
28068
  type: "array"
27789
28069
  }
@@ -27823,22 +28103,39 @@ var openapi_default = {
27823
28103
  tags: ["/client_sessions"],
27824
28104
  "x-fern-sdk-group-name": ["client_sessions"],
27825
28105
  "x-fern-sdk-method-name": "grant_access",
27826
- "x-response-key": null
28106
+ "x-response-key": null,
28107
+ "x-title": "Grant Access to a Client Session"
27827
28108
  }
27828
28109
  },
27829
28110
  "/client_sessions/list": {
27830
28111
  post: {
28112
+ description: "Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
27831
28113
  operationId: "clientSessionsListPost",
27832
28114
  requestBody: {
27833
28115
  content: {
27834
28116
  "application/json": {
27835
28117
  schema: {
27836
28118
  properties: {
27837
- client_session_id: { type: "string" },
27838
- connect_webview_id: { type: "string" },
27839
- user_identifier_key: { type: "string" },
27840
- user_identity_id: { type: "string" },
27841
- 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
+ }
27842
28139
  },
27843
28140
  type: "object"
27844
28141
  }
@@ -27877,18 +28174,24 @@ var openapi_default = {
27877
28174
  "x-fern-sdk-group-name": ["client_sessions"],
27878
28175
  "x-fern-sdk-method-name": "list",
27879
28176
  "x-fern-sdk-return-value": "client_sessions",
27880
- "x-response-key": "client_sessions"
28177
+ "x-response-key": "client_sessions",
28178
+ "x-title": "List Client Sessions"
27881
28179
  }
27882
28180
  },
27883
28181
  "/client_sessions/revoke": {
27884
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.",
27885
28184
  operationId: "clientSessionsRevokePost",
27886
28185
  requestBody: {
27887
28186
  content: {
27888
28187
  "application/json": {
27889
28188
  schema: {
27890
28189
  properties: {
27891
- 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
+ }
27892
28195
  },
27893
28196
  required: ["client_session_id"],
27894
28197
  type: "object"
@@ -27921,11 +28224,13 @@ var openapi_default = {
27921
28224
  tags: ["/client_sessions"],
27922
28225
  "x-fern-sdk-group-name": ["client_sessions"],
27923
28226
  "x-fern-sdk-method-name": "revoke",
27924
- "x-response-key": null
28227
+ "x-response-key": null,
28228
+ "x-title": "Revoke a Client Session"
27925
28229
  }
27926
28230
  },
27927
28231
  "/connect_webviews/create": {
27928
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).",
27929
28234
  operationId: "connectWebviewsCreatePost",
27930
28235
  requestBody: {
27931
28236
  content: {
@@ -27933,6 +28238,7 @@ var openapi_default = {
27933
28238
  schema: {
27934
28239
  properties: {
27935
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.",
27936
28242
  items: {
27937
28243
  enum: [
27938
28244
  "dormakaba_community",
@@ -27992,6 +28298,7 @@ var openapi_default = {
27992
28298
  },
27993
28299
  automatically_manage_new_devices: {
27994
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).",
27995
28302
  type: "boolean"
27996
28303
  },
27997
28304
  custom_metadata: {
@@ -28002,15 +28309,24 @@ var openapi_default = {
28002
28309
  { type: "boolean" }
28003
28310
  ]
28004
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).",
28005
28313
  type: "object"
28006
28314
  },
28007
- custom_redirect_failure_url: { type: "string" },
28008
- 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
+ },
28009
28323
  device_selection_mode: {
28010
28324
  enum: ["none", "single", "multiple"],
28011
- type: "string"
28325
+ type: "string",
28326
+ "x-undocumented": "Not supported."
28012
28327
  },
28013
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.",
28014
28330
  enum: [
28015
28331
  "stable",
28016
28332
  "consumer_smartlocks",
@@ -28021,7 +28337,11 @@ var openapi_default = {
28021
28337
  ],
28022
28338
  type: "string"
28023
28339
  },
28024
- 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
+ }
28025
28345
  },
28026
28346
  type: "object"
28027
28347
  }
@@ -28060,18 +28380,24 @@ var openapi_default = {
28060
28380
  "x-fern-sdk-group-name": ["connect_webviews"],
28061
28381
  "x-fern-sdk-method-name": "create",
28062
28382
  "x-fern-sdk-return-value": "connect_webview",
28063
- "x-response-key": "connect_webview"
28383
+ "x-response-key": "connect_webview",
28384
+ "x-title": "Create a Connect Webview"
28064
28385
  }
28065
28386
  },
28066
28387
  "/connect_webviews/delete": {
28067
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.",
28068
28390
  operationId: "connectWebviewsDeletePost",
28069
28391
  requestBody: {
28070
28392
  content: {
28071
28393
  "application/json": {
28072
28394
  schema: {
28073
28395
  properties: {
28074
- 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
+ }
28075
28401
  },
28076
28402
  required: ["connect_webview_id"],
28077
28403
  type: "object"
@@ -28104,18 +28430,24 @@ var openapi_default = {
28104
28430
  tags: ["/connect_webviews"],
28105
28431
  "x-fern-sdk-group-name": ["connect_webviews"],
28106
28432
  "x-fern-sdk-method-name": "delete",
28107
- "x-response-key": null
28433
+ "x-response-key": null,
28434
+ "x-title": "Delete a Connect Webview"
28108
28435
  }
28109
28436
  },
28110
28437
  "/connect_webviews/get": {
28111
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.",
28112
28440
  operationId: "connectWebviewsGetPost",
28113
28441
  requestBody: {
28114
28442
  content: {
28115
28443
  "application/json": {
28116
28444
  schema: {
28117
28445
  properties: {
28118
- 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
+ }
28119
28451
  },
28120
28452
  required: ["connect_webview_id"],
28121
28453
  type: "object"
@@ -28155,11 +28487,13 @@ var openapi_default = {
28155
28487
  "x-fern-sdk-group-name": ["connect_webviews"],
28156
28488
  "x-fern-sdk-method-name": "get",
28157
28489
  "x-fern-sdk-return-value": "connect_webview",
28158
- "x-response-key": "connect_webview"
28490
+ "x-response-key": "connect_webview",
28491
+ "x-title": "Get a Connect Webview"
28159
28492
  }
28160
28493
  },
28161
28494
  "/connect_webviews/list": {
28162
28495
  post: {
28496
+ description: "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).",
28163
28497
  operationId: "connectWebviewsListPost",
28164
28498
  requestBody: {
28165
28499
  content: {
@@ -28170,12 +28504,17 @@ var openapi_default = {
28170
28504
  additionalProperties: {
28171
28505
  oneOf: [{ type: "string" }, { type: "boolean" }]
28172
28506
  },
28173
- 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.",
28174
28508
  type: "object"
28175
28509
  },
28176
- 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
+ },
28177
28516
  user_identifier_key: {
28178
- 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.",
28179
28518
  type: "string"
28180
28519
  }
28181
28520
  },
@@ -28217,19 +28556,29 @@ var openapi_default = {
28217
28556
  "x-fern-sdk-group-name": ["connect_webviews"],
28218
28557
  "x-fern-sdk-method-name": "list",
28219
28558
  "x-fern-sdk-return-value": "connect_webviews",
28220
- "x-response-key": "connect_webviews"
28559
+ "x-response-key": "connect_webviews",
28560
+ "x-title": "List Connect Webviews"
28221
28561
  }
28222
28562
  },
28223
28563
  "/connected_accounts/delete": {
28224
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.",
28225
28566
  operationId: "connectedAccountsDeletePost",
28226
28567
  requestBody: {
28227
28568
  content: {
28228
28569
  "application/json": {
28229
28570
  schema: {
28230
28571
  properties: {
28231
- connected_account_id: { format: "uuid", type: "string" },
28232
- 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
+ }
28233
28582
  },
28234
28583
  required: ["connected_account_id"],
28235
28584
  type: "object"
@@ -28268,6 +28617,7 @@ var openapi_default = {
28268
28617
  },
28269
28618
  "/connected_accounts/get": {
28270
28619
  post: {
28620
+ description: "Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
28271
28621
  operationId: "connectedAccountsGetPost",
28272
28622
  requestBody: {
28273
28623
  content: {
@@ -28276,13 +28626,23 @@ var openapi_default = {
28276
28626
  oneOf: [
28277
28627
  {
28278
28628
  properties: {
28279
- 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
+ }
28280
28634
  },
28281
28635
  required: ["connected_account_id"],
28282
28636
  type: "object"
28283
28637
  },
28284
28638
  {
28285
- 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
+ },
28286
28646
  required: ["email"],
28287
28647
  type: "object"
28288
28648
  }
@@ -28329,6 +28689,7 @@ var openapi_default = {
28329
28689
  },
28330
28690
  "/connected_accounts/list": {
28331
28691
  post: {
28692
+ description: "Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).",
28332
28693
  operationId: "connectedAccountsListPost",
28333
28694
  requestBody: {
28334
28695
  content: {
@@ -28339,7 +28700,7 @@ var openapi_default = {
28339
28700
  additionalProperties: {
28340
28701
  oneOf: [{ type: "string" }, { type: "boolean" }]
28341
28702
  },
28342
- 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.",
28343
28704
  type: "object"
28344
28705
  },
28345
28706
  customer_ids: {
@@ -28359,7 +28720,7 @@ var openapi_default = {
28359
28720
  type: "string"
28360
28721
  },
28361
28722
  user_identifier_key: {
28362
- 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.",
28363
28724
  type: "string"
28364
28725
  }
28365
28726
  },
@@ -28407,14 +28768,22 @@ var openapi_default = {
28407
28768
  },
28408
28769
  "/connected_accounts/update": {
28409
28770
  post: {
28771
+ description: "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
28410
28772
  operationId: "connectedAccountsUpdatePost",
28411
28773
  requestBody: {
28412
28774
  content: {
28413
28775
  "application/json": {
28414
28776
  schema: {
28415
28777
  properties: {
28416
- automatically_manage_new_devices: { type: "boolean" },
28417
- 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
+ },
28418
28787
  custom_metadata: {
28419
28788
  additionalProperties: {
28420
28789
  nullable: true,
@@ -28423,6 +28792,7 @@ var openapi_default = {
28423
28792
  { type: "boolean" }
28424
28793
  ]
28425
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).",
28426
28796
  type: "object"
28427
28797
  }
28428
28798
  },
@@ -28468,12 +28838,19 @@ var openapi_default = {
28468
28838
  },
28469
28839
  "/devices/delete": {
28470
28840
  post: {
28841
+ description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
28471
28842
  operationId: "devicesDeletePost",
28472
28843
  requestBody: {
28473
28844
  content: {
28474
28845
  "application/json": {
28475
28846
  schema: {
28476
- 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
+ },
28477
28854
  required: ["device_id"],
28478
28855
  type: "object"
28479
28856
  }
@@ -28507,19 +28884,28 @@ var openapi_default = {
28507
28884
  "x-fern-sdk-group-name": ["devices"],
28508
28885
  "x-fern-sdk-method-name": "delete",
28509
28886
  "x-response-key": null,
28887
+ "x-title": "Delete a Device",
28510
28888
  "x-undocumented": "Deleting a device is no longer supported and will be removed."
28511
28889
  }
28512
28890
  },
28513
28891
  "/devices/get": {
28514
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`.",
28515
28894
  operationId: "devicesGetPost",
28516
28895
  requestBody: {
28517
28896
  content: {
28518
28897
  "application/json": {
28519
28898
  schema: {
28520
28899
  properties: {
28521
- device_id: { format: "uuid", type: "string" },
28522
- 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
+ }
28523
28909
  },
28524
28910
  type: "object"
28525
28911
  }
@@ -28556,7 +28942,8 @@ var openapi_default = {
28556
28942
  "x-fern-sdk-group-name": ["devices"],
28557
28943
  "x-fern-sdk-method-name": "get",
28558
28944
  "x-fern-sdk-return-value": "device",
28559
- "x-response-key": "device"
28945
+ "x-response-key": "device",
28946
+ "x-title": "Get a Device"
28560
28947
  }
28561
28948
  },
28562
28949
  "/devices/list": {
@@ -28569,22 +28956,22 @@ var openapi_default = {
28569
28956
  schema: {
28570
28957
  properties: {
28571
28958
  connect_webview_id: {
28572
- 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.",
28573
28960
  format: "uuid",
28574
28961
  type: "string"
28575
28962
  },
28576
28963
  connected_account_id: {
28577
- description: "ID of the connected account by which to filter.",
28964
+ description: "ID of the connected account for which you want to list devices.",
28578
28965
  format: "uuid",
28579
28966
  type: "string"
28580
28967
  },
28581
28968
  connected_account_ids: {
28582
- 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.",
28583
28970
  items: { format: "uuid", type: "string" },
28584
28971
  type: "array"
28585
28972
  },
28586
28973
  created_before: {
28587
- 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.",
28588
28975
  format: "date-time",
28589
28976
  type: "string"
28590
28977
  },
@@ -28592,7 +28979,7 @@ var openapi_default = {
28592
28979
  additionalProperties: {
28593
28980
  oneOf: [{ type: "string" }, { type: "boolean" }]
28594
28981
  },
28595
- 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.",
28596
28983
  type: "object"
28597
28984
  },
28598
28985
  customer_ids: {
@@ -28600,12 +28987,12 @@ var openapi_default = {
28600
28987
  type: "array"
28601
28988
  },
28602
28989
  device_ids: {
28603
- description: "Array of device IDs by which to filter devices.",
28990
+ description: "Array of device IDs for which you want to list devices.",
28604
28991
  items: { format: "uuid", type: "string" },
28605
28992
  type: "array"
28606
28993
  },
28607
28994
  device_type: {
28608
- description: "Device type by which to filter devices.",
28995
+ description: "Device type for which you want to list devices.",
28609
28996
  oneOf: [
28610
28997
  {
28611
28998
  enum: [
@@ -28662,7 +29049,7 @@ var openapi_default = {
28662
29049
  ]
28663
29050
  },
28664
29051
  device_types: {
28665
- description: "Array of device types by which to filter devices.",
29052
+ description: "Array of device types for which you want to list devices.",
28666
29053
  items: {
28667
29054
  oneOf: [
28668
29055
  {
@@ -28768,7 +29155,7 @@ var openapi_default = {
28768
29155
  type: "number"
28769
29156
  },
28770
29157
  manufacturer: {
28771
- description: "Manufacturer by which to filter devices.",
29158
+ description: "Manufacturer for which you want to list devices.",
28772
29159
  enum: [
28773
29160
  "akuvox",
28774
29161
  "august",
@@ -28817,13 +29204,14 @@ var openapi_default = {
28817
29204
  type: "string"
28818
29205
  },
28819
29206
  unstable_location_id: {
29207
+ description: "ID of the location for which you want to list devices.",
28820
29208
  format: "uuid",
28821
29209
  nullable: true,
28822
29210
  type: "string",
28823
29211
  "x-undocumented": "Experimental locations."
28824
29212
  },
28825
29213
  user_identifier_key: {
28826
- 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.",
28827
29215
  type: "string"
28828
29216
  }
28829
29217
  },
@@ -28872,6 +29260,7 @@ var openapi_default = {
28872
29260
  },
28873
29261
  "/devices/list_device_providers": {
28874
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).",
28875
29264
  operationId: "devicesListDeviceProvidersPost",
28876
29265
  requestBody: {
28877
29266
  content: {
@@ -28879,6 +29268,7 @@ var openapi_default = {
28879
29268
  schema: {
28880
29269
  properties: {
28881
29270
  provider_category: {
29271
+ description: "Category for which you want to list providers.",
28882
29272
  enum: [
28883
29273
  "stable",
28884
29274
  "consumer_smartlocks",
@@ -28927,17 +29317,25 @@ var openapi_default = {
28927
29317
  "x-fern-sdk-group-name": ["devices"],
28928
29318
  "x-fern-sdk-method-name": "list_device_providers",
28929
29319
  "x-fern-sdk-return-value": "device_providers",
28930
- "x-response-key": "device_providers"
29320
+ "x-response-key": "device_providers",
29321
+ "x-title": "List Device Providers"
28931
29322
  }
28932
29323
  },
28933
29324
  "/devices/simulate/connect": {
28934
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).",
28935
29327
  operationId: "devicesSimulateConnectPost",
28936
29328
  requestBody: {
28937
29329
  content: {
28938
29330
  "application/json": {
28939
29331
  schema: {
28940
- 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
+ },
28941
29339
  required: ["device_id"],
28942
29340
  type: "object"
28943
29341
  }
@@ -28969,17 +29367,25 @@ var openapi_default = {
28969
29367
  tags: ["/devices"],
28970
29368
  "x-fern-sdk-group-name": ["devices", "simulate"],
28971
29369
  "x-fern-sdk-method-name": "connect",
28972
- "x-response-key": null
29370
+ "x-response-key": null,
29371
+ "x-title": "Simulate Device Connection"
28973
29372
  }
28974
29373
  },
28975
29374
  "/devices/simulate/disconnect": {
28976
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).",
28977
29377
  operationId: "devicesSimulateDisconnectPost",
28978
29378
  requestBody: {
28979
29379
  content: {
28980
29380
  "application/json": {
28981
29381
  schema: {
28982
- 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
+ },
28983
29389
  required: ["device_id"],
28984
29390
  type: "object"
28985
29391
  }
@@ -29011,17 +29417,25 @@ var openapi_default = {
29011
29417
  tags: ["/devices"],
29012
29418
  "x-fern-sdk-group-name": ["devices", "simulate"],
29013
29419
  "x-fern-sdk-method-name": "disconnect",
29014
- "x-response-key": null
29420
+ "x-response-key": null,
29421
+ "x-title": "Simulate Device Disconnection"
29015
29422
  }
29016
29423
  },
29017
29424
  "/devices/simulate/remove": {
29018
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).",
29019
29427
  operationId: "devicesSimulateRemovePost",
29020
29428
  requestBody: {
29021
29429
  content: {
29022
29430
  "application/json": {
29023
29431
  schema: {
29024
- 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
+ },
29025
29439
  required: ["device_id"],
29026
29440
  type: "object"
29027
29441
  }
@@ -29053,19 +29467,28 @@ var openapi_default = {
29053
29467
  tags: ["/devices"],
29054
29468
  "x-fern-sdk-group-name": ["devices", "simulate"],
29055
29469
  "x-fern-sdk-method-name": "remove",
29056
- "x-response-key": null
29470
+ "x-response-key": null,
29471
+ "x-title": "Simulate Device Removal"
29057
29472
  }
29058
29473
  },
29059
29474
  "/devices/unmanaged/get": {
29060
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`.",
29061
29477
  operationId: "devicesUnmanagedGetPost",
29062
29478
  requestBody: {
29063
29479
  content: {
29064
29480
  "application/json": {
29065
29481
  schema: {
29066
29482
  properties: {
29067
- device_id: { format: "uuid", type: "string" },
29068
- 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
+ }
29069
29492
  },
29070
29493
  type: "object"
29071
29494
  }
@@ -29102,11 +29525,13 @@ var openapi_default = {
29102
29525
  "x-fern-sdk-group-name": ["devices", "unmanaged"],
29103
29526
  "x-fern-sdk-method-name": "get",
29104
29527
  "x-fern-sdk-return-value": "device",
29105
- "x-response-key": "device"
29528
+ "x-response-key": "device",
29529
+ "x-title": "Get an Unmanaged Device"
29106
29530
  }
29107
29531
  },
29108
29532
  "/devices/unmanaged/list": {
29109
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).",
29110
29535
  operationId: "devicesUnmanagedListPost",
29111
29536
  requestBody: {
29112
29537
  content: {
@@ -29114,22 +29539,22 @@ var openapi_default = {
29114
29539
  schema: {
29115
29540
  properties: {
29116
29541
  connect_webview_id: {
29117
- 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.",
29118
29543
  format: "uuid",
29119
29544
  type: "string"
29120
29545
  },
29121
29546
  connected_account_id: {
29122
- description: "ID of the connected account by which to filter.",
29547
+ description: "ID of the connected account for which you want to list devices.",
29123
29548
  format: "uuid",
29124
29549
  type: "string"
29125
29550
  },
29126
29551
  connected_account_ids: {
29127
- 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.",
29128
29553
  items: { format: "uuid", type: "string" },
29129
29554
  type: "array"
29130
29555
  },
29131
29556
  created_before: {
29132
- 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.",
29133
29558
  format: "date-time",
29134
29559
  type: "string"
29135
29560
  },
@@ -29137,7 +29562,7 @@ var openapi_default = {
29137
29562
  additionalProperties: {
29138
29563
  oneOf: [{ type: "string" }, { type: "boolean" }]
29139
29564
  },
29140
- 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.",
29141
29566
  type: "object"
29142
29567
  },
29143
29568
  customer_ids: {
@@ -29145,12 +29570,12 @@ var openapi_default = {
29145
29570
  type: "array"
29146
29571
  },
29147
29572
  device_ids: {
29148
- description: "Array of device IDs by which to filter devices.",
29573
+ description: "Array of device IDs for which you want to list devices.",
29149
29574
  items: { format: "uuid", type: "string" },
29150
29575
  type: "array"
29151
29576
  },
29152
29577
  device_type: {
29153
- description: "Device type by which to filter devices.",
29578
+ description: "Device type for which you want to list devices.",
29154
29579
  oneOf: [
29155
29580
  {
29156
29581
  enum: [
@@ -29207,7 +29632,7 @@ var openapi_default = {
29207
29632
  ]
29208
29633
  },
29209
29634
  device_types: {
29210
- description: "Array of device types by which to filter devices.",
29635
+ description: "Array of device types for which you want to list devices.",
29211
29636
  items: {
29212
29637
  oneOf: [
29213
29638
  {
@@ -29313,7 +29738,7 @@ var openapi_default = {
29313
29738
  type: "number"
29314
29739
  },
29315
29740
  manufacturer: {
29316
- description: "Manufacturer by which to filter devices.",
29741
+ description: "Manufacturer for which you want to list devices.",
29317
29742
  enum: [
29318
29743
  "akuvox",
29319
29744
  "august",
@@ -29362,13 +29787,14 @@ var openapi_default = {
29362
29787
  type: "string"
29363
29788
  },
29364
29789
  unstable_location_id: {
29790
+ description: "ID of the location for which you want to list devices.",
29365
29791
  format: "uuid",
29366
29792
  nullable: true,
29367
29793
  type: "string",
29368
29794
  "x-undocumented": "Experimental locations."
29369
29795
  },
29370
29796
  user_identifier_key: {
29371
- 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.",
29372
29798
  type: "string"
29373
29799
  }
29374
29800
  },
@@ -29409,19 +29835,29 @@ var openapi_default = {
29409
29835
  "x-fern-sdk-group-name": ["devices", "unmanaged"],
29410
29836
  "x-fern-sdk-method-name": "list",
29411
29837
  "x-fern-sdk-return-value": "devices",
29412
- "x-response-key": "devices"
29838
+ "x-response-key": "devices",
29839
+ "x-title": "List Unmanaged Devices"
29413
29840
  }
29414
29841
  },
29415
29842
  "/devices/unmanaged/update": {
29416
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).",
29417
29845
  operationId: "devicesUnmanagedUpdatePatch",
29418
29846
  requestBody: {
29419
29847
  content: {
29420
29848
  "application/json": {
29421
29849
  schema: {
29422
29850
  properties: {
29423
- device_id: { format: "uuid", type: "string" },
29424
- 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
+ }
29425
29861
  },
29426
29862
  required: ["device_id", "is_managed"],
29427
29863
  type: "object"
@@ -29453,17 +29889,27 @@ var openapi_default = {
29453
29889
  summary: "/devices/unmanaged/update",
29454
29890
  tags: ["/devices"],
29455
29891
  "x-fern-ignore": true,
29456
- "x-response-key": null
29892
+ "x-response-key": null,
29893
+ "x-title": "Update an Unmanaged Device"
29457
29894
  },
29458
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).",
29459
29897
  operationId: "devicesUnmanagedUpdatePost",
29460
29898
  requestBody: {
29461
29899
  content: {
29462
29900
  "application/json": {
29463
29901
  schema: {
29464
29902
  properties: {
29465
- device_id: { format: "uuid", type: "string" },
29466
- 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
+ }
29467
29913
  },
29468
29914
  required: ["device_id", "is_managed"],
29469
29915
  type: "object"
@@ -29496,11 +29942,13 @@ var openapi_default = {
29496
29942
  tags: ["/devices"],
29497
29943
  "x-fern-sdk-group-name": ["devices", "unmanaged"],
29498
29944
  "x-fern-sdk-method-name": "update",
29499
- "x-response-key": null
29945
+ "x-response-key": null,
29946
+ "x-title": "Update an Unmanaged Device"
29500
29947
  }
29501
29948
  },
29502
29949
  "/devices/update": {
29503
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).",
29504
29952
  operationId: "devicesUpdatePatch",
29505
29953
  requestBody: {
29506
29954
  content: {
@@ -29515,13 +29963,32 @@ var openapi_default = {
29515
29963
  { type: "boolean" }
29516
29964
  ]
29517
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).",
29518
29967
  type: "object"
29519
29968
  },
29520
- device_id: { format: "uuid", type: "string" },
29521
- is_managed: { default: true, type: "boolean" },
29522
- 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
+ },
29523
29984
  properties: {
29524
- properties: { name: { nullable: true, type: "string" } },
29985
+ properties: {
29986
+ name: {
29987
+ description: "Name for the device.",
29988
+ nullable: true,
29989
+ type: "string"
29990
+ }
29991
+ },
29525
29992
  type: "object"
29526
29993
  }
29527
29994
  },
@@ -29556,9 +30023,11 @@ var openapi_default = {
29556
30023
  summary: "/devices/update",
29557
30024
  tags: ["/devices"],
29558
30025
  "x-fern-ignore": true,
29559
- "x-response-key": null
30026
+ "x-response-key": null,
30027
+ "x-title": "Update a Device"
29560
30028
  },
29561
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).",
29562
30031
  operationId: "devicesUpdatePost",
29563
30032
  requestBody: {
29564
30033
  content: {
@@ -29573,13 +30042,32 @@ var openapi_default = {
29573
30042
  { type: "boolean" }
29574
30043
  ]
29575
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).",
29576
30046
  type: "object"
29577
30047
  },
29578
- device_id: { format: "uuid", type: "string" },
29579
- is_managed: { default: true, type: "boolean" },
29580
- 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
+ },
29581
30063
  properties: {
29582
- properties: { name: { nullable: true, type: "string" } },
30064
+ properties: {
30065
+ name: {
30066
+ description: "Name for the device.",
30067
+ nullable: true,
30068
+ type: "string"
30069
+ }
30070
+ },
29583
30071
  type: "object"
29584
30072
  }
29585
30073
  },
@@ -29615,11 +30103,13 @@ var openapi_default = {
29615
30103
  tags: ["/devices"],
29616
30104
  "x-fern-sdk-group-name": ["devices"],
29617
30105
  "x-fern-sdk-method-name": "update",
29618
- "x-response-key": null
30106
+ "x-response-key": null,
30107
+ "x-title": "Update a Device"
29619
30108
  }
29620
30109
  },
29621
30110
  "/events/get": {
29622
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.",
29623
30113
  operationId: "eventsGetPost",
29624
30114
  requestBody: {
29625
30115
  content: {
@@ -29666,11 +30156,13 @@ var openapi_default = {
29666
30156
  "x-fern-sdk-group-name": ["events"],
29667
30157
  "x-fern-sdk-method-name": "get",
29668
30158
  "x-fern-sdk-return-value": "event",
29669
- "x-response-key": "event"
30159
+ "x-response-key": "event",
30160
+ "x-title": "Get an Event"
29670
30161
  }
29671
30162
  },
29672
30163
  "/events/list": {
29673
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.",
29674
30166
  operationId: "eventsListPost",
29675
30167
  requestBody: {
29676
30168
  content: {
@@ -29944,7 +30436,8 @@ var openapi_default = {
29944
30436
  "x-fern-sdk-group-name": ["events"],
29945
30437
  "x-fern-sdk-method-name": "list",
29946
30438
  "x-fern-sdk-return-value": "events",
29947
- "x-response-key": "events"
30439
+ "x-response-key": "events",
30440
+ "x-title": "List Events"
29948
30441
  }
29949
30442
  },
29950
30443
  "/locks/get": {
@@ -30007,22 +30500,22 @@ var openapi_default = {
30007
30500
  schema: {
30008
30501
  properties: {
30009
30502
  connect_webview_id: {
30010
- 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.",
30011
30504
  format: "uuid",
30012
30505
  type: "string"
30013
30506
  },
30014
30507
  connected_account_id: {
30015
- description: "ID of the connected account by which to filter.",
30508
+ description: "ID of the connected account for which you want to list devices.",
30016
30509
  format: "uuid",
30017
30510
  type: "string"
30018
30511
  },
30019
30512
  connected_account_ids: {
30020
- 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.",
30021
30514
  items: { format: "uuid", type: "string" },
30022
30515
  type: "array"
30023
30516
  },
30024
30517
  created_before: {
30025
- 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.",
30026
30519
  format: "date-time",
30027
30520
  type: "string"
30028
30521
  },
@@ -30030,7 +30523,7 @@ var openapi_default = {
30030
30523
  additionalProperties: {
30031
30524
  oneOf: [{ type: "string" }, { type: "boolean" }]
30032
30525
  },
30033
- 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.",
30034
30527
  type: "object"
30035
30528
  },
30036
30529
  customer_ids: {
@@ -30038,7 +30531,7 @@ var openapi_default = {
30038
30531
  type: "array"
30039
30532
  },
30040
30533
  device_ids: {
30041
- description: "Array of device IDs by which to filter devices.",
30534
+ description: "Array of device IDs for which you want to list devices.",
30042
30535
  items: { format: "uuid", type: "string" },
30043
30536
  type: "array"
30044
30537
  },
@@ -30196,13 +30689,14 @@ var openapi_default = {
30196
30689
  type: "string"
30197
30690
  },
30198
30691
  unstable_location_id: {
30692
+ description: "ID of the location for which you want to list devices.",
30199
30693
  format: "uuid",
30200
30694
  nullable: true,
30201
30695
  type: "string",
30202
30696
  "x-undocumented": "Experimental locations."
30203
30697
  },
30204
30698
  user_identifier_key: {
30205
- 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.",
30206
30700
  type: "string"
30207
30701
  }
30208
30702
  },
@@ -30558,22 +31052,22 @@ var openapi_default = {
30558
31052
  schema: {
30559
31053
  properties: {
30560
31054
  connect_webview_id: {
30561
- 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.",
30562
31056
  format: "uuid",
30563
31057
  type: "string"
30564
31058
  },
30565
31059
  connected_account_id: {
30566
- description: "ID of the connected account by which to filter.",
31060
+ description: "ID of the connected account for which you want to list devices.",
30567
31061
  format: "uuid",
30568
31062
  type: "string"
30569
31063
  },
30570
31064
  connected_account_ids: {
30571
- 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.",
30572
31066
  items: { format: "uuid", type: "string" },
30573
31067
  type: "array"
30574
31068
  },
30575
31069
  created_before: {
30576
- 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.",
30577
31071
  format: "date-time",
30578
31072
  type: "string"
30579
31073
  },
@@ -30581,7 +31075,7 @@ var openapi_default = {
30581
31075
  additionalProperties: {
30582
31076
  oneOf: [{ type: "string" }, { type: "boolean" }]
30583
31077
  },
30584
- 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.",
30585
31079
  type: "object"
30586
31080
  },
30587
31081
  customer_ids: {
@@ -30589,7 +31083,7 @@ var openapi_default = {
30589
31083
  type: "array"
30590
31084
  },
30591
31085
  device_ids: {
30592
- description: "Array of device IDs by which to filter devices.",
31086
+ description: "Array of device IDs for which you want to list devices.",
30593
31087
  items: { format: "uuid", type: "string" },
30594
31088
  type: "array"
30595
31089
  },
@@ -30663,13 +31157,14 @@ var openapi_default = {
30663
31157
  type: "string"
30664
31158
  },
30665
31159
  unstable_location_id: {
31160
+ description: "ID of the location for which you want to list devices.",
30666
31161
  format: "uuid",
30667
31162
  nullable: true,
30668
31163
  type: "string",
30669
31164
  "x-undocumented": "Experimental locations."
30670
31165
  },
30671
31166
  user_identifier_key: {
30672
- 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.",
30673
31168
  type: "string"
30674
31169
  }
30675
31170
  },
@@ -33451,22 +33946,22 @@ var openapi_default = {
33451
33946
  schema: {
33452
33947
  properties: {
33453
33948
  connect_webview_id: {
33454
- 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.",
33455
33950
  format: "uuid",
33456
33951
  type: "string"
33457
33952
  },
33458
33953
  connected_account_id: {
33459
- description: "ID of the connected account by which to filter.",
33954
+ description: "ID of the connected account for which you want to list devices.",
33460
33955
  format: "uuid",
33461
33956
  type: "string"
33462
33957
  },
33463
33958
  connected_account_ids: {
33464
- 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.",
33465
33960
  items: { format: "uuid", type: "string" },
33466
33961
  type: "array"
33467
33962
  },
33468
33963
  created_before: {
33469
- 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.",
33470
33965
  format: "date-time",
33471
33966
  type: "string"
33472
33967
  },
@@ -33474,7 +33969,7 @@ var openapi_default = {
33474
33969
  additionalProperties: {
33475
33970
  oneOf: [{ type: "string" }, { type: "boolean" }]
33476
33971
  },
33477
- 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.",
33478
33973
  type: "object"
33479
33974
  },
33480
33975
  customer_ids: {
@@ -33482,7 +33977,7 @@ var openapi_default = {
33482
33977
  type: "array"
33483
33978
  },
33484
33979
  device_ids: {
33485
- description: "Array of device IDs by which to filter devices.",
33980
+ description: "Array of device IDs for which you want to list devices.",
33486
33981
  items: { format: "uuid", type: "string" },
33487
33982
  type: "array"
33488
33983
  },
@@ -33576,13 +34071,14 @@ var openapi_default = {
33576
34071
  type: "string"
33577
34072
  },
33578
34073
  unstable_location_id: {
34074
+ description: "ID of the location for which you want to list devices.",
33579
34075
  format: "uuid",
33580
34076
  nullable: true,
33581
34077
  type: "string",
33582
34078
  "x-undocumented": "Experimental locations."
33583
34079
  },
33584
34080
  user_identifier_key: {
33585
- 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.",
33586
34082
  type: "string"
33587
34083
  }
33588
34084
  },
@@ -36721,6 +37217,101 @@ var openapi_default = {
36721
37217
  "x-undocumented": "Experimental locations."
36722
37218
  }
36723
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
+ },
36724
37315
  "/user_identities/add_acs_user": {
36725
37316
  post: {
36726
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).",
@@ -36908,7 +37499,7 @@ var openapi_default = {
36908
37499
  },
36909
37500
  "/user_identities/delete": {
36910
37501
  post: {
36911
- 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.",
36912
37503
  operationId: "userIdentitiesDeletePost",
36913
37504
  requestBody: {
36914
37505
  content: {
@@ -38474,6 +39065,7 @@ var openapi_default = {
38474
39065
  },
38475
39066
  "/workspaces/reset_sandbox": {
38476
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.",
38477
39069
  operationId: "workspacesResetSandboxPost",
38478
39070
  responses: {
38479
39071
  200: {