@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
@@ -2,7 +2,7 @@ export default {
2
2
  components: {
3
3
  schemas: {
4
4
  access_code: {
5
- 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—and you do not need to be near the locks—to 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.',
5
+ 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—and you do not need to be near the locks—to 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.',
6
6
  properties: {
7
7
  access_code_id: {
8
8
  description: 'Unique identifier for the access code.',
@@ -1042,7 +1042,7 @@ export default {
1042
1042
  type: 'boolean',
1043
1043
  },
1044
1044
  name: {
1045
- description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
1045
+ 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).",
1046
1046
  nullable: true,
1047
1047
  type: 'string',
1048
1048
  },
@@ -6403,6 +6403,7 @@ export default {
6403
6403
  'x-route-path': '/action_attempts',
6404
6404
  },
6405
6405
  client_session: {
6406
+ 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).",
6406
6407
  properties: {
6407
6408
  client_session_id: { format: 'uuid', type: 'string' },
6408
6409
  connect_webview_ids: {
@@ -6440,18 +6441,21 @@ export default {
6440
6441
  'x-route-path': '/client_sessions',
6441
6442
  },
6442
6443
  connect_webview: {
6444
+ 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—once your user has completed the authorization through your app—you 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.',
6443
6445
  properties: {
6444
6446
  accepted_devices: {
6445
6447
  deprecated: true,
6446
6448
  items: { type: 'string' },
6447
6449
  type: 'array',
6448
6450
  'x-deprecated': 'Unused. Will be removed.',
6451
+ 'x-undocumented': 'Unused. Will be removed.',
6449
6452
  },
6450
6453
  accepted_providers: { items: { type: 'string' }, type: 'array' },
6451
6454
  any_device_allowed: {
6452
6455
  deprecated: true,
6453
6456
  type: 'boolean',
6454
6457
  'x-deprecated': 'Unused. Will be removed.',
6458
+ 'x-undocumented': 'Unused. Will be removed.',
6455
6459
  },
6456
6460
  any_provider_allowed: { type: 'boolean' },
6457
6461
  authorized_at: {
@@ -6519,6 +6523,7 @@ export default {
6519
6523
  'x-route-path': '/connect_webviews',
6520
6524
  },
6521
6525
  connected_account: {
6526
+ 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.',
6522
6527
  properties: {
6523
6528
  account_type: { type: 'string' },
6524
6529
  account_type_display_name: { type: 'string' },
@@ -6774,6 +6779,7 @@ export default {
6774
6779
  'x-route-path': '/connected_accounts',
6775
6780
  },
6776
6781
  device: {
6782
+ description: 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.',
6777
6783
  properties: {
6778
6784
  can_hvac_cool: { type: 'boolean' },
6779
6785
  can_hvac_heat: { type: 'boolean' },
@@ -7311,7 +7317,7 @@ export default {
7311
7317
  type: 'string',
7312
7318
  },
7313
7319
  manufacturer: {
7314
- description: 'Manufacturer of the device.',
7320
+ 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.',
7315
7321
  type: 'string',
7316
7322
  },
7317
7323
  model: {
@@ -7987,6 +7993,7 @@ export default {
7987
7993
  type: 'array',
7988
7994
  },
7989
7995
  code_constraints: {
7996
+ 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.',
7990
7997
  items: {
7991
7998
  oneOf: [
7992
7999
  {
@@ -9002,6 +9009,7 @@ export default {
9002
9009
  'x-route-path': '/user_identities/enrollment_automations',
9003
9010
  },
9004
9011
  event: {
9012
+ 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.",
9005
9013
  discriminator: { propertyName: 'event_type' },
9006
9014
  oneOf: [
9007
9015
  {
@@ -13926,7 +13934,7 @@ export default {
13926
13934
  'x-route-path': '/thermostats/schedules',
13927
13935
  },
13928
13936
  unmanaged_access_code: {
13929
- 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.',
13937
+ 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)',
13930
13938
  properties: {
13931
13939
  access_code_id: {
13932
13940
  description: 'Unique identifier for the access code.',
@@ -14933,7 +14941,7 @@ export default {
14933
14941
  type: 'boolean',
14934
14942
  },
14935
14943
  name: {
14936
- description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
14944
+ 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).",
14937
14945
  nullable: true,
14938
14946
  type: 'string',
14939
14947
  },
@@ -16230,6 +16238,7 @@ export default {
16230
16238
  'x-route-path': '/acs/users/unmanaged',
16231
16239
  },
16232
16240
  unmanaged_device: {
16241
+ 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).',
16233
16242
  properties: {
16234
16243
  can_hvac_cool: { type: 'boolean' },
16235
16244
  can_hvac_heat: { type: 'boolean' },
@@ -16724,7 +16733,7 @@ export default {
16724
16733
  type: 'string',
16725
16734
  },
16726
16735
  manufacturer: {
16727
- description: 'Manufacturer of the device.',
16736
+ 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.',
16728
16737
  type: 'string',
16729
16738
  },
16730
16739
  model: {
@@ -17054,7 +17063,7 @@ export default {
17054
17063
  'x-route-path': '/devices/unmanaged',
17055
17064
  },
17056
17065
  user_identity: {
17057
- 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.',
17066
+ 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.',
17058
17067
  properties: {
17059
17068
  created_at: {
17060
17069
  description: 'Date and time at which the user identity was created.',
@@ -17116,6 +17125,7 @@ export default {
17116
17125
  'x-route-path': '/webhooks',
17117
17126
  },
17118
17127
  workspace: {
17128
+ 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).',
17119
17129
  properties: {
17120
17130
  company_name: { type: 'string' },
17121
17131
  connect_partner_name: {
@@ -17247,7 +17257,7 @@ export default {
17247
17257
  type: 'string',
17248
17258
  },
17249
17259
  device_id: {
17250
- description: 'ID of the device for which to create the new access code.',
17260
+ description: 'ID of the device for which you want to create the new access code.',
17251
17261
  format: 'uuid',
17252
17262
  type: 'string',
17253
17263
  },
@@ -17274,7 +17284,7 @@ export default {
17274
17284
  type: 'string',
17275
17285
  },
17276
17286
  name: {
17277
- description: 'Name of the new access code.',
17287
+ 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).",
17278
17288
  type: 'string',
17279
17289
  },
17280
17290
  prefer_native_scheduling: {
@@ -17376,7 +17386,7 @@ export default {
17376
17386
  type: 'string',
17377
17387
  },
17378
17388
  device_ids: {
17379
- description: 'IDs of the devices for which to create the new access codes.',
17389
+ description: 'IDs of the devices for which you want to create the new access codes.',
17380
17390
  items: { format: 'uuid', type: 'string' },
17381
17391
  type: 'array',
17382
17392
  },
@@ -17403,7 +17413,7 @@ export default {
17403
17413
  type: 'string',
17404
17414
  },
17405
17415
  name: {
17406
- description: 'Name of the new access code.',
17416
+ 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).",
17407
17417
  type: 'string',
17408
17418
  },
17409
17419
  prefer_native_scheduling: {
@@ -17497,7 +17507,7 @@ export default {
17497
17507
  type: 'string',
17498
17508
  },
17499
17509
  device_ids: {
17500
- description: 'IDs of the devices for which to create the new access codes.',
17510
+ description: 'IDs of the devices for which you want to create the new access codes.',
17501
17511
  items: { format: 'uuid', type: 'string' },
17502
17512
  type: 'array',
17503
17513
  },
@@ -17524,7 +17534,7 @@ export default {
17524
17534
  type: 'string',
17525
17535
  },
17526
17536
  name: {
17527
- description: 'Name of the new access code.',
17537
+ 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).",
17528
17538
  type: 'string',
17529
17539
  },
17530
17540
  prefer_native_scheduling: {
@@ -17597,12 +17607,12 @@ export default {
17597
17607
  schema: {
17598
17608
  properties: {
17599
17609
  access_code_id: {
17600
- description: 'ID of the access code to delete.',
17610
+ description: 'ID of the access code that you want to delete.',
17601
17611
  format: 'uuid',
17602
17612
  type: 'string',
17603
17613
  },
17604
17614
  device_id: {
17605
- description: 'ID of the device for which to delete the access code.',
17615
+ description: 'ID of the device for which you want to delete the access code.',
17606
17616
  format: 'uuid',
17607
17617
  type: 'string',
17608
17618
  },
@@ -17656,12 +17666,19 @@ export default {
17656
17666
  },
17657
17667
  '/access_codes/generate_code': {
17658
17668
  post: {
17669
+ description: 'Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.',
17659
17670
  operationId: 'accessCodesGenerateCodePost',
17660
17671
  requestBody: {
17661
17672
  content: {
17662
17673
  'application/json': {
17663
17674
  schema: {
17664
- properties: { device_id: { format: 'uuid', type: 'string' } },
17675
+ properties: {
17676
+ device_id: {
17677
+ description: 'ID of the device for which you want to generate a code.',
17678
+ format: 'uuid',
17679
+ type: 'string',
17680
+ },
17681
+ },
17665
17682
  required: ['device_id'],
17666
17683
  type: 'object',
17667
17684
  },
@@ -17701,6 +17718,7 @@ export default {
17701
17718
  'x-fern-sdk-method-name': 'generate_code',
17702
17719
  'x-fern-sdk-return-value': 'generated_code',
17703
17720
  'x-response-key': 'generated_code',
17721
+ 'x-title': 'Generate a Code',
17704
17722
  },
17705
17723
  },
17706
17724
  '/access_codes/get': {
@@ -17846,7 +17864,7 @@ export default {
17846
17864
  },
17847
17865
  '/access_codes/pull_backup_access_code': {
17848
17866
  post: {
17849
- 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—be it due to intermittent connectivity, manual removal from a device, or provider outages—a 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.",
17867
+ 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—be it due to intermittent connectivity, manual removal from a device, or provider outages—a 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.",
17850
17868
  operationId: 'accessCodesPullBackupAccessCodePost',
17851
17869
  requestBody: {
17852
17870
  content: {
@@ -17904,7 +17922,7 @@ export default {
17904
17922
  },
17905
17923
  '/access_codes/report_device_constraints': {
17906
17924
  post: {
17907
- description: 'Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.',
17925
+ 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`.',
17908
17926
  operationId: 'accessCodesReportDeviceConstraintsPost',
17909
17927
  requestBody: {
17910
17928
  content: {
@@ -17912,7 +17930,7 @@ export default {
17912
17930
  schema: {
17913
17931
  properties: {
17914
17932
  device_id: {
17915
- description: 'ID of the device for which to report constraints.',
17933
+ description: 'ID of the device for which you want to report constraints.',
17916
17934
  format: 'uuid',
17917
17935
  type: 'string',
17918
17936
  },
@@ -18054,7 +18072,7 @@ export default {
18054
18072
  type: 'string',
18055
18073
  },
18056
18074
  allow_external_modification: {
18057
- description: 'Indicates whether external modification of the access code is allowed.',
18075
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
18058
18076
  type: 'boolean',
18059
18077
  },
18060
18078
  force: {
@@ -18062,7 +18080,7 @@ export default {
18062
18080
  type: 'boolean',
18063
18081
  },
18064
18082
  is_external_modification_allowed: {
18065
- description: 'Indicates whether external modification of the access code is allowed.',
18083
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
18066
18084
  type: 'boolean',
18067
18085
  },
18068
18086
  sync: {
@@ -18120,7 +18138,7 @@ export default {
18120
18138
  type: 'string',
18121
18139
  },
18122
18140
  allow_external_modification: {
18123
- description: 'Indicates whether external modification of the access code is allowed.',
18141
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
18124
18142
  type: 'boolean',
18125
18143
  },
18126
18144
  force: {
@@ -18128,7 +18146,7 @@ export default {
18128
18146
  type: 'boolean',
18129
18147
  },
18130
18148
  is_external_modification_allowed: {
18131
- description: 'Indicates whether external modification of the access code is allowed.',
18149
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
18132
18150
  type: 'boolean',
18133
18151
  },
18134
18152
  sync: {
@@ -18184,7 +18202,7 @@ export default {
18184
18202
  schema: {
18185
18203
  properties: {
18186
18204
  access_code_id: {
18187
- description: 'ID of the unmanaged access code to delete.',
18205
+ description: 'ID of the unmanaged access code that you want to delete.',
18188
18206
  format: 'uuid',
18189
18207
  type: 'string',
18190
18208
  },
@@ -18551,7 +18569,7 @@ export default {
18551
18569
  type: 'string',
18552
18570
  },
18553
18571
  name: {
18554
- description: 'Name of the new access code.',
18572
+ 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).",
18555
18573
  type: 'string',
18556
18574
  },
18557
18575
  prefer_native_scheduling: {
@@ -18683,7 +18701,7 @@ export default {
18683
18701
  type: 'string',
18684
18702
  },
18685
18703
  name: {
18686
- description: 'Name of the new access code.',
18704
+ 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).",
18687
18705
  type: 'string',
18688
18706
  },
18689
18707
  prefer_native_scheduling: {
@@ -18816,7 +18834,7 @@ export default {
18816
18834
  type: 'string',
18817
18835
  },
18818
18836
  name: {
18819
- description: 'Name of the new access code.',
18837
+ 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).",
18820
18838
  type: 'string',
18821
18839
  },
18822
18840
  prefer_native_scheduling: {
@@ -18907,7 +18925,7 @@ export default {
18907
18925
  type: 'string',
18908
18926
  },
18909
18927
  name: {
18910
- description: 'Name of the new access code.',
18928
+ 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).",
18911
18929
  type: 'string',
18912
18930
  },
18913
18931
  starts_at: {
@@ -18966,7 +18984,7 @@ export default {
18966
18984
  type: 'string',
18967
18985
  },
18968
18986
  name: {
18969
- description: 'Name of the new access code.',
18987
+ 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).",
18970
18988
  type: 'string',
18971
18989
  },
18972
18990
  starts_at: {
@@ -19012,7 +19030,7 @@ export default {
19012
19030
  },
19013
19031
  '/acs/access_groups/add_user': {
19014
19032
  post: {
19015
- 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).',
19033
+ 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).',
19016
19034
  operationId: 'acsAccessGroupsAddUserPost',
19017
19035
  requestBody: {
19018
19036
  content: {
@@ -19020,12 +19038,12 @@ export default {
19020
19038
  schema: {
19021
19039
  properties: {
19022
19040
  acs_access_group_id: {
19023
- description: 'ID of the desired access group.',
19041
+ description: 'ID of the access group to which you want to add an access system user.',
19024
19042
  format: 'uuid',
19025
19043
  type: 'string',
19026
19044
  },
19027
19045
  acs_user_id: {
19028
- description: 'ID of the desired user.',
19046
+ description: 'ID of the access system user that you want to add to an access group.',
19029
19047
  format: 'uuid',
19030
19048
  type: 'string',
19031
19049
  },
@@ -19065,7 +19083,7 @@ export default {
19065
19083
  'x-title': 'Add an ACS User to an Access Group',
19066
19084
  },
19067
19085
  put: {
19068
- 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).',
19086
+ 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).',
19069
19087
  operationId: 'acsAccessGroupsAddUserPut',
19070
19088
  requestBody: {
19071
19089
  content: {
@@ -19073,12 +19091,12 @@ export default {
19073
19091
  schema: {
19074
19092
  properties: {
19075
19093
  acs_access_group_id: {
19076
- description: 'ID of the desired access group.',
19094
+ description: 'ID of the access group to which you want to add an access system user.',
19077
19095
  format: 'uuid',
19078
19096
  type: 'string',
19079
19097
  },
19080
19098
  acs_user_id: {
19081
- description: 'ID of the desired user.',
19099
+ description: 'ID of the access system user that you want to add to an access group.',
19082
19100
  format: 'uuid',
19083
19101
  type: 'string',
19084
19102
  },
@@ -19127,7 +19145,7 @@ export default {
19127
19145
  schema: {
19128
19146
  properties: {
19129
19147
  acs_access_group_id: {
19130
- description: 'ID of the desired access group.',
19148
+ description: 'ID of the access group that you want to get.',
19131
19149
  format: 'uuid',
19132
19150
  type: 'string',
19133
19151
  },
@@ -19183,12 +19201,12 @@ export default {
19183
19201
  schema: {
19184
19202
  properties: {
19185
19203
  acs_system_id: {
19186
- description: 'ID of the access control system for which you want to retrieve all access groups.',
19204
+ description: 'ID of the access system for which you want to retrieve all access groups.',
19187
19205
  format: 'uuid',
19188
19206
  type: 'string',
19189
19207
  },
19190
19208
  acs_user_id: {
19191
- description: 'ID of the user for which you want to retrieve all access groups.',
19209
+ description: 'ID of the access system user for which you want to retrieve all access groups.',
19192
19210
  format: 'uuid',
19193
19211
  type: 'string',
19194
19212
  },
@@ -19298,7 +19316,7 @@ export default {
19298
19316
  },
19299
19317
  '/acs/access_groups/list_users': {
19300
19318
  post: {
19301
- 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).',
19319
+ 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).',
19302
19320
  operationId: 'acsAccessGroupsListUsersPost',
19303
19321
  requestBody: {
19304
19322
  content: {
@@ -19306,7 +19324,7 @@ export default {
19306
19324
  schema: {
19307
19325
  properties: {
19308
19326
  acs_access_group_id: {
19309
- description: 'ID of the access group for which you want to retrieve all users.',
19327
+ description: 'ID of the access group for which you want to retrieve all access system users.',
19310
19328
  format: 'uuid',
19311
19329
  type: 'string',
19312
19330
  },
@@ -19355,7 +19373,7 @@ export default {
19355
19373
  },
19356
19374
  '/acs/access_groups/remove_user': {
19357
19375
  post: {
19358
- 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).',
19376
+ 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).',
19359
19377
  operationId: 'acsAccessGroupsRemoveUserPost',
19360
19378
  requestBody: {
19361
19379
  content: {
@@ -19363,17 +19381,17 @@ export default {
19363
19381
  schema: {
19364
19382
  properties: {
19365
19383
  acs_access_group_id: {
19366
- description: 'ID of the desired access group.',
19384
+ description: 'ID of the access group from which you want to remove an access system user.',
19367
19385
  format: 'uuid',
19368
19386
  type: 'string',
19369
19387
  },
19370
19388
  acs_user_id: {
19371
- description: 'ID of the desired user.',
19389
+ description: 'ID of the access system user that you want to remove from an access group.',
19372
19390
  format: 'uuid',
19373
19391
  type: 'string',
19374
19392
  },
19375
19393
  user_identity_id: {
19376
- description: 'ID of the desired user identity.',
19394
+ description: 'ID of the user identity associated with the user that you want to remove from an access group.',
19377
19395
  format: 'uuid',
19378
19396
  type: 'string',
19379
19397
  },
@@ -19423,7 +19441,7 @@ export default {
19423
19441
  schema: {
19424
19442
  properties: {
19425
19443
  acs_access_group_id: {
19426
- description: 'ID of the desired unmanaged access group.',
19444
+ description: 'ID of the unmanaged access group that you want to get.',
19427
19445
  format: 'uuid',
19428
19446
  type: 'string',
19429
19447
  },
@@ -19466,6 +19484,7 @@ export default {
19466
19484
  'x-fern-sdk-method-name': 'get',
19467
19485
  'x-fern-sdk-return-value': 'acs_access_group',
19468
19486
  'x-response-key': 'acs_access_group',
19487
+ 'x-title': 'Get an Unmanaged Access Group',
19469
19488
  'x-undocumented': 'No unmanaged access groups are currently implemented.',
19470
19489
  },
19471
19490
  },
@@ -19479,12 +19498,12 @@ export default {
19479
19498
  schema: {
19480
19499
  properties: {
19481
19500
  acs_system_id: {
19482
- description: 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
19501
+ description: 'ID of the access system for which you want to retrieve all unmanaged access groups.',
19483
19502
  format: 'uuid',
19484
19503
  type: 'string',
19485
19504
  },
19486
19505
  acs_user_id: {
19487
- description: 'ID of the user for which you want to retrieve all unmanaged access groups.',
19506
+ description: 'ID of the access system user for which you want to retrieve all unmanaged access groups.',
19488
19507
  format: 'uuid',
19489
19508
  type: 'string',
19490
19509
  },
@@ -19529,18 +19548,24 @@ export default {
19529
19548
  'x-fern-sdk-method-name': 'list',
19530
19549
  'x-fern-sdk-return-value': 'acs_access_groups',
19531
19550
  'x-response-key': 'acs_access_groups',
19551
+ 'x-title': 'List Unmanaged Access Groups',
19532
19552
  'x-undocumented': 'No unmanaged access groups are currently implemented.',
19533
19553
  },
19534
19554
  },
19535
19555
  '/acs/credential_pools/list': {
19536
19556
  post: {
19557
+ description: 'Returns a list of all credential pools.',
19537
19558
  operationId: 'acsCredentialPoolsListPost',
19538
19559
  requestBody: {
19539
19560
  content: {
19540
19561
  'application/json': {
19541
19562
  schema: {
19542
19563
  properties: {
19543
- acs_system_id: { format: 'uuid', type: 'string' },
19564
+ acs_system_id: {
19565
+ description: 'ID of the access system for which you want to list credential pools.',
19566
+ format: 'uuid',
19567
+ type: 'string',
19568
+ },
19544
19569
  },
19545
19570
  required: ['acs_system_id'],
19546
19571
  type: 'object',
@@ -19584,28 +19609,43 @@ export default {
19584
19609
  'x-fern-sdk-method-name': 'list',
19585
19610
  'x-fern-sdk-return-value': 'acs_credential_pools',
19586
19611
  'x-response-key': 'acs_credential_pools',
19612
+ 'x-title': 'List Credential Pools',
19587
19613
  'x-undocumented': 'Replaced by enrollment automations.',
19588
19614
  },
19589
19615
  },
19590
19616
  '/acs/credential_provisioning_automations/launch': {
19591
19617
  post: {
19618
+ description: 'Launches a credential provisioning automation.',
19592
19619
  operationId: 'acsCredentialProvisioningAutomationsLaunchPost',
19593
19620
  requestBody: {
19594
19621
  content: {
19595
19622
  'application/json': {
19596
19623
  schema: {
19597
19624
  properties: {
19598
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
19599
- create_credential_manager_user: { type: 'boolean' },
19625
+ acs_credential_pool_id: {
19626
+ description: 'ID of the credential pool for which you want to launch a credential provisioning automation.',
19627
+ format: 'uuid',
19628
+ type: 'string',
19629
+ },
19630
+ create_credential_manager_user: {
19631
+ 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`.',
19632
+ type: 'boolean',
19633
+ },
19600
19634
  credential_manager_acs_system_id: {
19635
+ description: 'Access system ID of the credential manager for which you want to launch a credential provisioning automation.',
19601
19636
  format: 'uuid',
19602
19637
  type: 'string',
19603
19638
  },
19604
19639
  credential_manager_acs_user_id: {
19640
+ 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`.',
19641
+ format: 'uuid',
19642
+ type: 'string',
19643
+ },
19644
+ user_identity_id: {
19645
+ description: 'ID of the user identity for which you want to launch a credential provisioning automation.',
19605
19646
  format: 'uuid',
19606
19647
  type: 'string',
19607
19648
  },
19608
- user_identity_id: { format: 'uuid', type: 'string' },
19609
19649
  },
19610
19650
  required: [
19611
19651
  'user_identity_id',
@@ -19649,12 +19689,13 @@ export default {
19649
19689
  'x-fern-sdk-method-name': 'launch',
19650
19690
  'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
19651
19691
  'x-response-key': 'acs_credential_provisioning_automation',
19692
+ 'x-title': 'Launch a Credential Provisioning Automation',
19652
19693
  'x-undocumented': 'Replaced by enrollment automations.',
19653
19694
  },
19654
19695
  },
19655
19696
  '/acs/credentials/assign': {
19656
19697
  patch: {
19657
- 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).',
19698
+ 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).',
19658
19699
  operationId: 'acsCredentialsAssignPatch',
19659
19700
  requestBody: {
19660
19701
  content: {
@@ -19662,12 +19703,12 @@ export default {
19662
19703
  schema: {
19663
19704
  properties: {
19664
19705
  acs_credential_id: {
19665
- description: 'ID of the desired credential.',
19706
+ description: 'ID of the credential that you want to assign to an access system user.',
19666
19707
  format: 'uuid',
19667
19708
  type: 'string',
19668
19709
  },
19669
19710
  acs_user_id: {
19670
- description: 'ID of the desired user.',
19711
+ description: 'ID of the access system user to whom you want to assign a credential.',
19671
19712
  format: 'uuid',
19672
19713
  type: 'string',
19673
19714
  },
@@ -19711,7 +19752,7 @@ export default {
19711
19752
  'x-title': 'Assign a Credential to an ACS User',
19712
19753
  },
19713
19754
  post: {
19714
- 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).',
19755
+ 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).',
19715
19756
  operationId: 'acsCredentialsAssignPost',
19716
19757
  requestBody: {
19717
19758
  content: {
@@ -19719,12 +19760,12 @@ export default {
19719
19760
  schema: {
19720
19761
  properties: {
19721
19762
  acs_credential_id: {
19722
- description: 'ID of the desired credential.',
19763
+ description: 'ID of the credential that you want to assign to an access system user.',
19723
19764
  format: 'uuid',
19724
19765
  type: 'string',
19725
19766
  },
19726
19767
  acs_user_id: {
19727
- description: 'ID of the desired user.',
19768
+ description: 'ID of the access system user to whom you want to assign a credential.',
19728
19769
  format: 'uuid',
19729
19770
  type: 'string',
19730
19771
  },
@@ -19783,8 +19824,13 @@ export default {
19783
19824
  enum: ['code', 'card', 'mobile_key'],
19784
19825
  type: 'string',
19785
19826
  },
19827
+ acs_system_id: {
19828
+ 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`.',
19829
+ format: 'uuid',
19830
+ type: 'string',
19831
+ },
19786
19832
  acs_user_id: {
19787
- description: 'ID of the ACS user to whom the new credential belongs.',
19833
+ 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`.',
19788
19834
  format: 'uuid',
19789
19835
  type: 'string',
19790
19836
  },
@@ -19830,8 +19876,14 @@ export default {
19830
19876
  salto_space_metadata: {
19831
19877
  description: 'Salto Space-specific metadata for the new credential.',
19832
19878
  properties: {
19833
- assign_new_key: { type: 'boolean' },
19834
- update_current_key: { type: 'boolean' },
19879
+ assign_new_key: {
19880
+ 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).',
19881
+ type: 'boolean',
19882
+ },
19883
+ update_current_key: {
19884
+ 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).",
19885
+ type: 'boolean',
19886
+ },
19835
19887
  },
19836
19888
  type: 'object',
19837
19889
  },
@@ -19840,6 +19892,11 @@ export default {
19840
19892
  format: 'date-time',
19841
19893
  type: 'string',
19842
19894
  },
19895
+ user_identity_id: {
19896
+ 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.',
19897
+ format: 'uuid',
19898
+ type: 'string',
19899
+ },
19843
19900
  visionline_metadata: {
19844
19901
  description: 'Visionline-specific metadata for the new credential.',
19845
19902
  properties: {
@@ -19875,7 +19932,7 @@ export default {
19875
19932
  type: 'object',
19876
19933
  },
19877
19934
  },
19878
- required: ['acs_user_id', 'access_method'],
19935
+ required: ['access_method'],
19879
19936
  type: 'object',
19880
19937
  },
19881
19938
  },
@@ -19918,7 +19975,7 @@ export default {
19918
19975
  },
19919
19976
  '/acs/credentials/create_offline_code': {
19920
19977
  post: {
19921
- 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).',
19978
+ 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).',
19922
19979
  operationId: 'acsCredentialsCreateOfflineCodePost',
19923
19980
  requestBody: {
19924
19981
  content: {
@@ -19926,7 +19983,7 @@ export default {
19926
19983
  schema: {
19927
19984
  properties: {
19928
19985
  acs_user_id: {
19929
- description: 'ID of the ACS user to whom the new credential belongs.',
19986
+ description: 'ID of the access system user to whom the new credential belongs.',
19930
19987
  format: 'uuid',
19931
19988
  type: 'string',
19932
19989
  },
@@ -20003,7 +20060,7 @@ export default {
20003
20060
  schema: {
20004
20061
  properties: {
20005
20062
  acs_credential_id: {
20006
- description: 'ID of the desired credential.',
20063
+ description: 'ID of the credential that you want to delete.',
20007
20064
  format: 'uuid',
20008
20065
  type: 'string',
20009
20066
  },
@@ -20053,7 +20110,7 @@ export default {
20053
20110
  schema: {
20054
20111
  properties: {
20055
20112
  acs_credential_id: {
20056
- description: 'ID of the desired credential.',
20113
+ description: 'ID of the credential that you want to get.',
20057
20114
  format: 'uuid',
20058
20115
  type: 'string',
20059
20116
  },
@@ -20113,7 +20170,7 @@ export default {
20113
20170
  {
20114
20171
  properties: {
20115
20172
  acs_user_id: {
20116
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20173
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20117
20174
  format: 'uuid',
20118
20175
  type: 'string',
20119
20176
  },
@@ -20124,7 +20181,7 @@ export default {
20124
20181
  {
20125
20182
  properties: {
20126
20183
  acs_system_id: {
20127
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20184
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20128
20185
  format: 'uuid',
20129
20186
  type: 'string',
20130
20187
  },
@@ -20135,12 +20192,12 @@ export default {
20135
20192
  {
20136
20193
  properties: {
20137
20194
  acs_system_id: {
20138
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20195
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20139
20196
  format: 'uuid',
20140
20197
  type: 'string',
20141
20198
  },
20142
20199
  acs_user_id: {
20143
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20200
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20144
20201
  format: 'uuid',
20145
20202
  type: 'string',
20146
20203
  },
@@ -20234,7 +20291,7 @@ export default {
20234
20291
  schema: {
20235
20292
  properties: {
20236
20293
  acs_credential_id: {
20237
- description: 'ID of the credential for which you want to retrieve all entrances to which this credential grants access.',
20294
+ description: 'ID of the credential for which you want to retrieve all entrances to which the credential grants access.',
20238
20295
  format: 'uuid',
20239
20296
  type: 'string',
20240
20297
  },
@@ -20283,7 +20340,7 @@ export default {
20283
20340
  },
20284
20341
  '/acs/credentials/unassign': {
20285
20342
  patch: {
20286
- 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).',
20343
+ 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).',
20287
20344
  operationId: 'acsCredentialsUnassignPatch',
20288
20345
  requestBody: {
20289
20346
  content: {
@@ -20291,12 +20348,12 @@ export default {
20291
20348
  schema: {
20292
20349
  properties: {
20293
20350
  acs_credential_id: {
20294
- description: 'ID of the desired credential.',
20351
+ description: 'ID of the credential that you want to unassign from an access system user.',
20295
20352
  format: 'uuid',
20296
20353
  type: 'string',
20297
20354
  },
20298
20355
  acs_user_id: {
20299
- description: 'ID of the desired user.',
20356
+ description: 'ID of the access system user from which you want to unassign a credential.',
20300
20357
  format: 'uuid',
20301
20358
  type: 'string',
20302
20359
  },
@@ -20340,7 +20397,7 @@ export default {
20340
20397
  'x-title': 'Unassign a Credential from an ACS User',
20341
20398
  },
20342
20399
  post: {
20343
- 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).',
20400
+ 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).',
20344
20401
  operationId: 'acsCredentialsUnassignPost',
20345
20402
  requestBody: {
20346
20403
  content: {
@@ -20348,12 +20405,12 @@ export default {
20348
20405
  schema: {
20349
20406
  properties: {
20350
20407
  acs_credential_id: {
20351
- description: 'ID of the desired credential.',
20408
+ description: 'ID of the credential that you want to unassign from an access system user.',
20352
20409
  format: 'uuid',
20353
20410
  type: 'string',
20354
20411
  },
20355
20412
  acs_user_id: {
20356
- description: 'ID of the desired user.',
20413
+ description: 'ID of the access system user from which you want to unassign a credential.',
20357
20414
  format: 'uuid',
20358
20415
  type: 'string',
20359
20416
  },
@@ -20408,7 +20465,7 @@ export default {
20408
20465
  schema: {
20409
20466
  properties: {
20410
20467
  acs_credential_id: {
20411
- description: 'ID of the desired unmanaged credential.',
20468
+ description: 'ID of the unmanaged credential that you want to get.',
20412
20469
  format: 'uuid',
20413
20470
  type: 'string',
20414
20471
  },
@@ -20465,9 +20522,10 @@ export default {
20465
20522
  schema: {
20466
20523
  oneOf: [
20467
20524
  {
20525
+ description: 'ID of the access system user for which you want to list unmanaged credentials.',
20468
20526
  properties: {
20469
20527
  acs_user_id: {
20470
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20528
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20471
20529
  format: 'uuid',
20472
20530
  type: 'string',
20473
20531
  },
@@ -20476,9 +20534,10 @@ export default {
20476
20534
  type: 'object',
20477
20535
  },
20478
20536
  {
20537
+ description: 'ID of the access system for which you want to list unmanaged credentials.',
20479
20538
  properties: {
20480
20539
  acs_system_id: {
20481
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20540
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20482
20541
  format: 'uuid',
20483
20542
  type: 'string',
20484
20543
  },
@@ -20487,14 +20546,15 @@ export default {
20487
20546
  type: 'object',
20488
20547
  },
20489
20548
  {
20549
+ description: 'ID of the access system and ID of the access system user for which you want to list unmanaged credentials.',
20490
20550
  properties: {
20491
20551
  acs_system_id: {
20492
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20552
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20493
20553
  format: 'uuid',
20494
20554
  type: 'string',
20495
20555
  },
20496
20556
  acs_user_id: {
20497
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20557
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20498
20558
  format: 'uuid',
20499
20559
  type: 'string',
20500
20560
  },
@@ -20503,6 +20563,7 @@ export default {
20503
20563
  type: 'object',
20504
20564
  },
20505
20565
  {
20566
+ description: 'ID of the user identity for which you want to list unmanaged credentials.',
20506
20567
  properties: {
20507
20568
  user_identity_id: {
20508
20569
  description: 'ID of the user identity for which you want to retrieve all credentials.',
@@ -20567,11 +20628,11 @@ export default {
20567
20628
  schema: {
20568
20629
  properties: {
20569
20630
  acs_credential_id: {
20570
- description: 'ID of the desired credential.',
20631
+ description: 'ID of the credential that you want to update.',
20571
20632
  type: 'string',
20572
20633
  },
20573
20634
  code: {
20574
- description: 'Replacement access (PIN) code for the credential.',
20635
+ description: 'Replacement access (PIN) code for the credential that you want to update.',
20575
20636
  pattern: '^\\d+$',
20576
20637
  type: 'string',
20577
20638
  },
@@ -20628,11 +20689,11 @@ export default {
20628
20689
  schema: {
20629
20690
  properties: {
20630
20691
  acs_credential_id: {
20631
- description: 'ID of the desired credential.',
20692
+ description: 'ID of the credential that you want to update.',
20632
20693
  type: 'string',
20633
20694
  },
20634
20695
  code: {
20635
- description: 'Replacement access (PIN) code for the credential.',
20696
+ description: 'Replacement access (PIN) code for the credential that you want to update.',
20636
20697
  pattern: '^\\d+$',
20637
20698
  type: 'string',
20638
20699
  },
@@ -20816,7 +20877,7 @@ export default {
20816
20877
  schema: {
20817
20878
  properties: {
20818
20879
  acs_encoder_id: {
20819
- description: 'ID of the desired encoder.',
20880
+ description: 'ID of the encoder that you want to get.',
20820
20881
  format: 'uuid',
20821
20882
  type: 'string',
20822
20883
  },
@@ -20872,13 +20933,13 @@ export default {
20872
20933
  {
20873
20934
  properties: {
20874
20935
  acs_system_id: {
20875
- description: 'ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.',
20936
+ description: 'ID of the access system for which you want to retrieve all encoders.',
20876
20937
  format: 'uuid',
20877
20938
  type: 'string',
20878
20939
  },
20879
20940
  limit: {
20880
20941
  default: 500,
20881
- description: 'Number of `acs_encoders` to return.',
20942
+ description: 'Number of encoders to return.',
20882
20943
  format: 'float',
20883
20944
  type: 'number',
20884
20945
  },
@@ -20889,13 +20950,13 @@ export default {
20889
20950
  {
20890
20951
  properties: {
20891
20952
  acs_system_ids: {
20892
- description: 'IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.',
20953
+ description: 'IDs of the access systems for which you want to retrieve all encoders.',
20893
20954
  items: { format: 'uuid', type: 'string' },
20894
20955
  type: 'array',
20895
20956
  },
20896
20957
  limit: {
20897
20958
  default: 500,
20898
- description: 'Number of `acs_encoders` to return.',
20959
+ description: 'Number of encoders to return.',
20899
20960
  format: 'float',
20900
20961
  type: 'number',
20901
20962
  },
@@ -20906,13 +20967,13 @@ export default {
20906
20967
  {
20907
20968
  properties: {
20908
20969
  acs_encoder_ids: {
20909
- description: 'IDs of the `acs_encoder`s that you want to retrieve.',
20970
+ description: 'IDs of the encoders that you want to retrieve.',
20910
20971
  items: { format: 'uuid', type: 'string' },
20911
20972
  type: 'array',
20912
20973
  },
20913
20974
  limit: {
20914
20975
  default: 500,
20915
- description: 'Number of `acs_encoders` to return.',
20976
+ description: 'Number of encoders to return.',
20916
20977
  format: 'float',
20917
20978
  type: 'number',
20918
20979
  },
@@ -20971,7 +21032,7 @@ export default {
20971
21032
  schema: {
20972
21033
  properties: {
20973
21034
  acs_encoder_id: {
20974
- description: 'ID of the `acs_encoder` to use for the scan.',
21035
+ description: 'ID of the encoder to use for the scan.',
20975
21036
  format: 'uuid',
20976
21037
  type: 'string',
20977
21038
  },
@@ -21343,14 +21404,18 @@ export default {
21343
21404
  },
21344
21405
  '/acs/entrances/get': {
21345
21406
  post: {
21346
- description: 'Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21407
+ description: 'Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21347
21408
  operationId: 'acsEntrancesGetPost',
21348
21409
  requestBody: {
21349
21410
  content: {
21350
21411
  'application/json': {
21351
21412
  schema: {
21352
21413
  properties: {
21353
- acs_entrance_id: { format: 'uuid', type: 'string' },
21414
+ acs_entrance_id: {
21415
+ description: 'ID of the entrance that you want to get.',
21416
+ format: 'uuid',
21417
+ type: 'string',
21418
+ },
21354
21419
  },
21355
21420
  required: ['acs_entrance_id'],
21356
21421
  type: 'object',
@@ -21394,14 +21459,23 @@ export default {
21394
21459
  },
21395
21460
  '/acs/entrances/grant_access': {
21396
21461
  post: {
21462
+ 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).',
21397
21463
  operationId: 'acsEntrancesGrantAccessPost',
21398
21464
  requestBody: {
21399
21465
  content: {
21400
21466
  'application/json': {
21401
21467
  schema: {
21402
21468
  properties: {
21403
- acs_entrance_id: { format: 'uuid', type: 'string' },
21404
- acs_user_id: { format: 'uuid', type: 'string' },
21469
+ acs_entrance_id: {
21470
+ description: 'ID of the entrance to which you want to grant an access system user access.',
21471
+ format: 'uuid',
21472
+ type: 'string',
21473
+ },
21474
+ acs_user_id: {
21475
+ description: 'ID of the access system user to whom you want to grant access to an entrance.',
21476
+ format: 'uuid',
21477
+ type: 'string',
21478
+ },
21405
21479
  },
21406
21480
  required: ['acs_entrance_id', 'acs_user_id'],
21407
21481
  type: 'object',
@@ -21440,16 +21514,25 @@ export default {
21440
21514
  },
21441
21515
  '/acs/entrances/list': {
21442
21516
  post: {
21443
- description: 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21517
+ description: 'Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21444
21518
  operationId: 'acsEntrancesListPost',
21445
21519
  requestBody: {
21446
21520
  content: {
21447
21521
  'application/json': {
21448
21522
  schema: {
21449
21523
  properties: {
21450
- acs_credential_id: { format: 'uuid', type: 'string' },
21451
- acs_system_id: { format: 'uuid', type: 'string' },
21524
+ acs_credential_id: {
21525
+ description: 'ID of the credential for which you want to retrieve all entrances.',
21526
+ format: 'uuid',
21527
+ type: 'string',
21528
+ },
21529
+ acs_system_id: {
21530
+ description: 'ID of the access system for which you want to retrieve all entrances.',
21531
+ format: 'uuid',
21532
+ type: 'string',
21533
+ },
21452
21534
  location_id: {
21535
+ description: 'ID of the location for which you want to retrieve all entrances.',
21453
21536
  format: 'uuid',
21454
21537
  nullable: true,
21455
21538
  type: 'string',
@@ -21507,8 +21590,13 @@ export default {
21507
21590
  'application/json': {
21508
21591
  schema: {
21509
21592
  properties: {
21510
- acs_entrance_id: { format: 'uuid', type: 'string' },
21593
+ acs_entrance_id: {
21594
+ description: 'ID of the entrance for which you want to list all credentials that grant access.',
21595
+ format: 'uuid',
21596
+ type: 'string',
21597
+ },
21511
21598
  include_if: {
21599
+ description: 'Conditions that credentials must meet to be included in the returned list.',
21512
21600
  items: {
21513
21601
  enum: ['visionline_metadata.is_valid'],
21514
21602
  type: 'string',
@@ -21561,7 +21649,7 @@ export default {
21561
21649
  },
21562
21650
  '/acs/systems/get': {
21563
21651
  post: {
21564
- 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.',
21652
+ description: 'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',
21565
21653
  operationId: 'acsSystemsGetPost',
21566
21654
  requestBody: {
21567
21655
  content: {
@@ -21569,7 +21657,7 @@ export default {
21569
21657
  schema: {
21570
21658
  properties: {
21571
21659
  acs_system_id: {
21572
- description: 'ID of the desired access control system.',
21660
+ description: 'ID of the access system that you want to get.',
21573
21661
  format: 'uuid',
21574
21662
  type: 'string',
21575
21663
  },
@@ -21615,7 +21703,7 @@ export default {
21615
21703
  },
21616
21704
  '/acs/systems/list': {
21617
21705
  post: {
21618
- 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.',
21706
+ 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.',
21619
21707
  operationId: 'acsSystemsListPost',
21620
21708
  requestBody: {
21621
21709
  content: {
@@ -21623,7 +21711,7 @@ export default {
21623
21711
  schema: {
21624
21712
  properties: {
21625
21713
  connected_account_id: {
21626
- description: 'ID of the connected account by which to filter the list of returned access control systems.',
21714
+ description: 'ID of the connected account by which you want to filter the list of access systems.',
21627
21715
  format: 'uuid',
21628
21716
  type: 'string',
21629
21717
  },
@@ -21672,7 +21760,7 @@ export default {
21672
21760
  },
21673
21761
  '/acs/systems/list_compatible_credential_manager_acs_systems': {
21674
21762
  post: {
21675
- 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.',
21763
+ 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.',
21676
21764
  operationId: 'acsSystemsListCompatibleCredentialManagerAcsSystemsPost',
21677
21765
  requestBody: {
21678
21766
  content: {
@@ -21680,7 +21768,7 @@ export default {
21680
21768
  schema: {
21681
21769
  properties: {
21682
21770
  acs_system_id: {
21683
- description: 'ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.',
21771
+ description: 'ID of the access system for which you want to retrieve all compatible credential manager systems.',
21684
21772
  format: 'uuid',
21685
21773
  type: 'string',
21686
21774
  },
@@ -21729,7 +21817,7 @@ export default {
21729
21817
  },
21730
21818
  '/acs/users/add_to_access_group': {
21731
21819
  post: {
21732
- 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).',
21820
+ 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).',
21733
21821
  operationId: 'acsUsersAddToAccessGroupPost',
21734
21822
  requestBody: {
21735
21823
  content: {
@@ -21737,12 +21825,12 @@ export default {
21737
21825
  schema: {
21738
21826
  properties: {
21739
21827
  acs_access_group_id: {
21740
- description: 'ID of the desired access group.',
21828
+ description: 'ID of the access group to which you want to add an access system user.',
21741
21829
  format: 'uuid',
21742
21830
  type: 'string',
21743
21831
  },
21744
21832
  acs_user_id: {
21745
- description: 'ID of the desired `acs_user`.',
21833
+ description: 'ID of the access system user that you want to add to an access group.',
21746
21834
  format: 'uuid',
21747
21835
  type: 'string',
21748
21836
  },
@@ -21782,7 +21870,7 @@ export default {
21782
21870
  'x-title': 'Add an ACS User to an Access Group',
21783
21871
  },
21784
21872
  put: {
21785
- 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).',
21873
+ 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).',
21786
21874
  operationId: 'acsUsersAddToAccessGroupPut',
21787
21875
  requestBody: {
21788
21876
  content: {
@@ -21790,12 +21878,12 @@ export default {
21790
21878
  schema: {
21791
21879
  properties: {
21792
21880
  acs_access_group_id: {
21793
- description: 'ID of the desired access group.',
21881
+ description: 'ID of the access group to which you want to add an access system user.',
21794
21882
  format: 'uuid',
21795
21883
  type: 'string',
21796
21884
  },
21797
21885
  acs_user_id: {
21798
- description: 'ID of the desired `acs_user`.',
21886
+ description: 'ID of the access system user that you want to add to an access group.',
21799
21887
  format: 'uuid',
21800
21888
  type: 'string',
21801
21889
  },
@@ -21836,7 +21924,7 @@ export default {
21836
21924
  },
21837
21925
  '/acs/users/create': {
21838
21926
  post: {
21839
- description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21927
+ description: 'Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21840
21928
  operationId: 'acsUsersCreatePost',
21841
21929
  requestBody: {
21842
21930
  content: {
@@ -21844,25 +21932,30 @@ export default {
21844
21932
  schema: {
21845
21933
  properties: {
21846
21934
  access_schedule: {
21847
- 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`.",
21935
+ 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`.",
21848
21936
  properties: {
21849
21937
  ends_at: {
21938
+ description: "Ending timestamp for the new access system user's access.",
21850
21939
  format: 'date-time',
21851
21940
  nullable: true,
21852
21941
  type: 'string',
21853
21942
  },
21854
- starts_at: { format: 'date-time', type: 'string' },
21943
+ starts_at: {
21944
+ description: "Starting timestamp for the new access system user's access.",
21945
+ format: 'date-time',
21946
+ type: 'string',
21947
+ },
21855
21948
  },
21856
21949
  type: 'object',
21857
21950
  },
21858
21951
  acs_access_group_ids: {
21859
21952
  default: [],
21860
- description: 'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.',
21953
+ description: 'Array of access group IDs to indicate the access groups to which you want to add the new access system user.',
21861
21954
  items: { format: 'uuid', type: 'string' },
21862
21955
  type: 'array',
21863
21956
  },
21864
21957
  acs_system_id: {
21865
- description: 'ID of the `acs_system` to which to add the new `acs_user`.',
21958
+ description: 'ID of the access system to which you want to add the new access system user.',
21866
21959
  format: 'uuid',
21867
21960
  type: 'string',
21868
21961
  },
@@ -21878,7 +21971,7 @@ export default {
21878
21971
  type: 'string',
21879
21972
  },
21880
21973
  full_name: {
21881
- description: 'Full name of the new `acs_user`.',
21974
+ description: 'Full name of the new access system user.',
21882
21975
  type: 'string',
21883
21976
  },
21884
21977
  phone_number: {
@@ -21886,7 +21979,7 @@ export default {
21886
21979
  type: 'string',
21887
21980
  },
21888
21981
  user_identity_id: {
21889
- description: 'ID of the user identity with which to associate the new `acs_user`.',
21982
+ description: 'ID of the user identity with which you want to associate the new access system user.',
21890
21983
  format: 'uuid',
21891
21984
  type: 'string',
21892
21985
  },
@@ -21932,7 +22025,7 @@ export default {
21932
22025
  },
21933
22026
  '/acs/users/delete': {
21934
22027
  post: {
21935
- 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).",
22028
+ 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).",
21936
22029
  operationId: 'acsUsersDeletePost',
21937
22030
  requestBody: {
21938
22031
  content: {
@@ -21940,7 +22033,7 @@ export default {
21940
22033
  schema: {
21941
22034
  properties: {
21942
22035
  acs_user_id: {
21943
- description: 'ID of the desired `acs_user`.',
22036
+ description: 'ID of the access system user that you want to delete.',
21944
22037
  format: 'uuid',
21945
22038
  type: 'string',
21946
22039
  },
@@ -21982,7 +22075,7 @@ export default {
21982
22075
  },
21983
22076
  '/acs/users/get': {
21984
22077
  post: {
21985
- description: 'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22078
+ description: 'Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21986
22079
  operationId: 'acsUsersGetPost',
21987
22080
  requestBody: {
21988
22081
  content: {
@@ -21990,7 +22083,7 @@ export default {
21990
22083
  schema: {
21991
22084
  properties: {
21992
22085
  acs_user_id: {
21993
- description: 'ID of the desired `acs_user`.',
22086
+ description: 'ID of the access system user that you want to get.',
21994
22087
  format: 'uuid',
21995
22088
  type: 'string',
21996
22089
  },
@@ -22036,7 +22129,7 @@ export default {
22036
22129
  },
22037
22130
  '/acs/users/list': {
22038
22131
  post: {
22039
- description: 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22132
+ description: 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22040
22133
  operationId: 'acsUsersListPost',
22041
22134
  requestBody: {
22042
22135
  content: {
@@ -22044,11 +22137,15 @@ export default {
22044
22137
  schema: {
22045
22138
  properties: {
22046
22139
  acs_system_id: {
22047
- description: 'ID of the `acs_system` for which you want to retrieve all `acs_user`s.',
22140
+ description: 'ID of the `acs_system` for which you want to retrieve all access system users.',
22048
22141
  format: 'uuid',
22049
22142
  type: 'string',
22050
22143
  },
22051
- created_before: { format: 'date-time', type: 'string' },
22144
+ created_before: {
22145
+ description: 'Timestamp by which to limit returned access system users. Returns users created before this timestamp.',
22146
+ format: 'date-time',
22147
+ type: 'string',
22148
+ },
22052
22149
  limit: {
22053
22150
  default: 500,
22054
22151
  description: 'Maximum number of records to return per page.',
@@ -22062,21 +22159,21 @@ export default {
22062
22159
  type: 'string',
22063
22160
  },
22064
22161
  search: {
22065
- 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`.',
22162
+ 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`.',
22066
22163
  minLength: 1,
22067
22164
  type: 'string',
22068
22165
  },
22069
22166
  user_identity_email_address: {
22070
- description: 'Email address of the user identity for which you want to retrieve all `acs_user`s.',
22167
+ description: 'Email address of the user identity for which you want to retrieve all access system users.',
22071
22168
  type: 'string',
22072
22169
  },
22073
22170
  user_identity_id: {
22074
- description: 'ID of the user identity for which you want to retrieve all `acs_user`s.',
22171
+ description: 'ID of the user identity for which you want to retrieve all access system users.',
22075
22172
  format: 'uuid',
22076
22173
  type: 'string',
22077
22174
  },
22078
22175
  user_identity_phone_number: {
22079
- 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`).',
22176
+ 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`).',
22080
22177
  type: 'string',
22081
22178
  },
22082
22179
  },
@@ -22125,7 +22222,7 @@ export default {
22125
22222
  },
22126
22223
  '/acs/users/list_accessible_entrances': {
22127
22224
  post: {
22128
- 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.',
22225
+ 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.',
22129
22226
  operationId: 'acsUsersListAccessibleEntrancesPost',
22130
22227
  requestBody: {
22131
22228
  content: {
@@ -22133,7 +22230,7 @@ export default {
22133
22230
  schema: {
22134
22231
  properties: {
22135
22232
  acs_user_id: {
22136
- description: 'ID of the desired `acs_user`.',
22233
+ description: 'ID of the access system user for whom you want to list accessible entrances.',
22137
22234
  format: 'uuid',
22138
22235
  type: 'string',
22139
22236
  },
@@ -22183,7 +22280,7 @@ export default {
22183
22280
  },
22184
22281
  '/acs/users/remove_from_access_group': {
22185
22282
  post: {
22186
- 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).',
22283
+ 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).',
22187
22284
  operationId: 'acsUsersRemoveFromAccessGroupPost',
22188
22285
  requestBody: {
22189
22286
  content: {
@@ -22191,12 +22288,12 @@ export default {
22191
22288
  schema: {
22192
22289
  properties: {
22193
22290
  acs_access_group_id: {
22194
- description: 'ID of the desired access group.',
22291
+ description: 'ID of the access group from which you want to remove an access system user.',
22195
22292
  format: 'uuid',
22196
22293
  type: 'string',
22197
22294
  },
22198
22295
  acs_user_id: {
22199
- description: 'ID of the desired `acs_user`.',
22296
+ description: 'ID of the access system user that you want to remove from an access group.',
22200
22297
  format: 'uuid',
22201
22298
  type: 'string',
22202
22299
  },
@@ -22238,7 +22335,7 @@ export default {
22238
22335
  },
22239
22336
  '/acs/users/revoke_access_to_all_entrances': {
22240
22337
  post: {
22241
- 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).',
22338
+ 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).',
22242
22339
  operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
22243
22340
  requestBody: {
22244
22341
  content: {
@@ -22246,7 +22343,7 @@ export default {
22246
22343
  schema: {
22247
22344
  properties: {
22248
22345
  acs_user_id: {
22249
- description: 'ID of the desired `acs_user`.',
22346
+ description: 'ID of the access system user for whom you want to revoke access.',
22250
22347
  format: 'uuid',
22251
22348
  type: 'string',
22252
22349
  },
@@ -22288,7 +22385,7 @@ export default {
22288
22385
  },
22289
22386
  '/acs/users/suspend': {
22290
22387
  post: {
22291
- 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.",
22388
+ 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.",
22292
22389
  operationId: 'acsUsersSuspendPost',
22293
22390
  requestBody: {
22294
22391
  content: {
@@ -22296,7 +22393,7 @@ export default {
22296
22393
  schema: {
22297
22394
  properties: {
22298
22395
  acs_user_id: {
22299
- description: 'ID of the desired `acs_user`.',
22396
+ description: 'ID of the access system user that you want to suspend.',
22300
22397
  format: 'uuid',
22301
22398
  type: 'string',
22302
22399
  },
@@ -22338,12 +22435,19 @@ export default {
22338
22435
  },
22339
22436
  '/acs/users/unmanaged/get': {
22340
22437
  post: {
22438
+ description: 'Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22341
22439
  operationId: 'acsUsersUnmanagedGetPost',
22342
22440
  requestBody: {
22343
22441
  content: {
22344
22442
  'application/json': {
22345
22443
  schema: {
22346
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
22444
+ properties: {
22445
+ acs_user_id: {
22446
+ description: 'ID of the unmanaged access system user that you want to get.',
22447
+ format: 'uuid',
22448
+ type: 'string',
22449
+ },
22450
+ },
22347
22451
  required: ['acs_user_id'],
22348
22452
  type: 'object',
22349
22453
  },
@@ -22382,22 +22486,43 @@ export default {
22382
22486
  'x-fern-sdk-method-name': 'get',
22383
22487
  'x-fern-sdk-return-value': 'acs_user',
22384
22488
  'x-response-key': 'acs_user',
22489
+ 'x-title': 'Get an Unmanaged ACS User',
22385
22490
  'x-undocumented': 'No unmanaged users are currently implemented.',
22386
22491
  },
22387
22492
  },
22388
22493
  '/acs/users/unmanaged/list': {
22389
22494
  post: {
22495
+ description: 'Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22390
22496
  operationId: 'acsUsersUnmanagedListPost',
22391
22497
  requestBody: {
22392
22498
  content: {
22393
22499
  'application/json': {
22394
22500
  schema: {
22395
22501
  properties: {
22396
- acs_system_id: { format: 'uuid', type: 'string' },
22397
- limit: { default: 500, format: 'float', type: 'number' },
22398
- user_identity_email_address: { type: 'string' },
22399
- user_identity_id: { format: 'uuid', type: 'string' },
22400
- user_identity_phone_number: { type: 'string' },
22502
+ acs_system_id: {
22503
+ description: 'ID of the access system for which you want to retrieve all unmanaged access system users.',
22504
+ format: 'uuid',
22505
+ type: 'string',
22506
+ },
22507
+ limit: {
22508
+ default: 500,
22509
+ description: 'Number of unmanaged access system users to return.',
22510
+ format: 'float',
22511
+ type: 'number',
22512
+ },
22513
+ user_identity_email_address: {
22514
+ description: 'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
22515
+ type: 'string',
22516
+ },
22517
+ user_identity_id: {
22518
+ description: 'ID of the user identity for which you want to retrieve all unmanaged access system users.',
22519
+ format: 'uuid',
22520
+ type: 'string',
22521
+ },
22522
+ user_identity_phone_number: {
22523
+ description: 'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
22524
+ type: 'string',
22525
+ },
22401
22526
  },
22402
22527
  type: 'object',
22403
22528
  },
@@ -22439,12 +22564,13 @@ export default {
22439
22564
  'x-fern-sdk-method-name': 'list',
22440
22565
  'x-fern-sdk-return-value': 'acs_users',
22441
22566
  'x-response-key': 'acs_users',
22567
+ 'x-title': 'List Unmanaged ACS Users',
22442
22568
  'x-undocumented': 'No unmanaged users are currently implemented.',
22443
22569
  },
22444
22570
  },
22445
22571
  '/acs/users/unsuspend': {
22446
22572
  post: {
22447
- 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.',
22573
+ 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.',
22448
22574
  operationId: 'acsUsersUnsuspendPost',
22449
22575
  requestBody: {
22450
22576
  content: {
@@ -22452,7 +22578,7 @@ export default {
22452
22578
  schema: {
22453
22579
  properties: {
22454
22580
  acs_user_id: {
22455
- description: 'ID of the desired `acs_user`.',
22581
+ description: 'ID of the access system user that you want to unsuspend.',
22456
22582
  format: 'uuid',
22457
22583
  type: 'string',
22458
22584
  },
@@ -22494,7 +22620,7 @@ export default {
22494
22620
  },
22495
22621
  '/acs/users/update': {
22496
22622
  patch: {
22497
- description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22623
+ description: 'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22498
22624
  operationId: 'acsUsersUpdatePatch',
22499
22625
  requestBody: {
22500
22626
  content: {
@@ -22502,11 +22628,19 @@ export default {
22502
22628
  schema: {
22503
22629
  properties: {
22504
22630
  access_schedule: {
22505
- 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`.",
22631
+ 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`.",
22506
22632
  nullable: true,
22507
22633
  properties: {
22508
- ends_at: { format: 'date-time', type: 'string' },
22509
- starts_at: { format: 'date-time', type: 'string' },
22634
+ ends_at: {
22635
+ description: "Ending timestamp for the access system user's access.",
22636
+ format: 'date-time',
22637
+ type: 'string',
22638
+ },
22639
+ starts_at: {
22640
+ description: "Starting timestamp for the access system user's access.",
22641
+ format: 'date-time',
22642
+ type: 'string',
22643
+ },
22510
22644
  },
22511
22645
  required: ['starts_at', 'ends_at'],
22512
22646
  type: 'object',
@@ -22572,7 +22706,7 @@ export default {
22572
22706
  'x-title': 'Update an ACS User',
22573
22707
  },
22574
22708
  post: {
22575
- description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22709
+ description: 'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22576
22710
  operationId: 'acsUsersUpdatePost',
22577
22711
  requestBody: {
22578
22712
  content: {
@@ -22580,11 +22714,19 @@ export default {
22580
22714
  schema: {
22581
22715
  properties: {
22582
22716
  access_schedule: {
22583
- 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`.",
22717
+ 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`.",
22584
22718
  nullable: true,
22585
22719
  properties: {
22586
- ends_at: { format: 'date-time', type: 'string' },
22587
- starts_at: { format: 'date-time', type: 'string' },
22720
+ ends_at: {
22721
+ description: "Ending timestamp for the access system user's access.",
22722
+ format: 'date-time',
22723
+ type: 'string',
22724
+ },
22725
+ starts_at: {
22726
+ description: "Starting timestamp for the access system user's access.",
22727
+ format: 'date-time',
22728
+ type: 'string',
22729
+ },
22588
22730
  },
22589
22731
  required: ['starts_at', 'ends_at'],
22590
22732
  type: 'object',
@@ -22653,13 +22795,18 @@ export default {
22653
22795
  },
22654
22796
  '/action_attempts/get': {
22655
22797
  post: {
22798
+ description: 'Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
22656
22799
  operationId: 'actionAttemptsGetPost',
22657
22800
  requestBody: {
22658
22801
  content: {
22659
22802
  'application/json': {
22660
22803
  schema: {
22661
22804
  properties: {
22662
- action_attempt_id: { format: 'uuid', type: 'string' },
22805
+ action_attempt_id: {
22806
+ description: 'ID of the action attempt that you want to get.',
22807
+ format: 'uuid',
22808
+ type: 'string',
22809
+ },
22663
22810
  },
22664
22811
  required: ['action_attempt_id'],
22665
22812
  type: 'object',
@@ -22700,10 +22847,12 @@ export default {
22700
22847
  'x-fern-sdk-method-name': 'get',
22701
22848
  'x-fern-sdk-return-value': 'action_attempt',
22702
22849
  'x-response-key': 'action_attempt',
22850
+ 'x-title': 'Get an Action Attempt',
22703
22851
  },
22704
22852
  },
22705
22853
  '/action_attempts/list': {
22706
22854
  post: {
22855
+ 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.',
22707
22856
  operationId: 'actionAttemptsListPost',
22708
22857
  requestBody: {
22709
22858
  content: {
@@ -22711,6 +22860,7 @@ export default {
22711
22860
  schema: {
22712
22861
  properties: {
22713
22862
  action_attempt_ids: {
22863
+ description: 'IDs of the action attempts that you want to retrieve.',
22714
22864
  items: { format: 'uuid', type: 'string' },
22715
22865
  type: 'array',
22716
22866
  },
@@ -22754,16 +22904,24 @@ export default {
22754
22904
  'x-fern-sdk-method-name': 'list',
22755
22905
  'x-fern-sdk-return-value': 'action_attempts',
22756
22906
  'x-response-key': 'action_attempts',
22907
+ 'x-title': 'List Action Attempts',
22757
22908
  },
22758
22909
  },
22759
22910
  '/bridges/get': {
22760
22911
  post: {
22912
+ description: 'Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
22761
22913
  operationId: 'bridgesGetPost',
22762
22914
  requestBody: {
22763
22915
  content: {
22764
22916
  'application/json': {
22765
22917
  schema: {
22766
- properties: { bridge_id: { format: 'uuid', type: 'string' } },
22918
+ properties: {
22919
+ bridge_id: {
22920
+ description: 'ID of the Seam Bridge that you want to get.',
22921
+ format: 'uuid',
22922
+ type: 'string',
22923
+ },
22924
+ },
22767
22925
  required: ['bridge_id'],
22768
22926
  type: 'object',
22769
22927
  },
@@ -22810,10 +22968,13 @@ export default {
22810
22968
  'x-fern-sdk-method-name': 'get',
22811
22969
  'x-fern-sdk-return-value': 'bridge',
22812
22970
  'x-response-key': 'bridge',
22971
+ 'x-title': 'Get a Seam Bridge',
22972
+ 'x-undocumented': 'Not yet for customer use.',
22813
22973
  },
22814
22974
  },
22815
22975
  '/bridges/list': {
22816
22976
  post: {
22977
+ description: 'Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).',
22817
22978
  operationId: 'bridgesListPost',
22818
22979
  requestBody: {
22819
22980
  content: {
@@ -22863,10 +23024,13 @@ export default {
22863
23024
  'x-fern-sdk-method-name': 'list',
22864
23025
  'x-fern-sdk-return-value': 'bridges',
22865
23026
  'x-response-key': 'bridges',
23027
+ 'x-title': 'List Seam Bridges',
23028
+ 'x-undocumented': 'Not yet for customer use.',
22866
23029
  },
22867
23030
  },
22868
23031
  '/client_sessions/create': {
22869
23032
  post: {
23033
+ description: 'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
22870
23034
  operationId: 'clientSessionsCreatePost',
22871
23035
  requestBody: {
22872
23036
  content: {
@@ -22874,16 +23038,27 @@ export default {
22874
23038
  schema: {
22875
23039
  properties: {
22876
23040
  connect_webview_ids: {
23041
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
22877
23042
  items: { type: 'string' },
22878
23043
  type: 'array',
22879
23044
  },
22880
23045
  connected_account_ids: {
23046
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
22881
23047
  items: { type: 'string' },
22882
23048
  type: 'array',
22883
23049
  },
22884
- expires_at: { format: 'date-time', type: 'string' },
22885
- user_identifier_key: { minLength: 1, type: 'string' },
23050
+ expires_at: {
23051
+ 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.',
23052
+ format: 'date-time',
23053
+ type: 'string',
23054
+ },
23055
+ user_identifier_key: {
23056
+ description: 'Your user ID for the user for whom you want to create a client session.',
23057
+ minLength: 1,
23058
+ type: 'string',
23059
+ },
22886
23060
  user_identity_ids: {
23061
+ 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.',
22887
23062
  items: { type: 'string' },
22888
23063
  type: 'array',
22889
23064
  },
@@ -22926,8 +23101,10 @@ export default {
22926
23101
  'x-fern-sdk-method-name': 'create',
22927
23102
  'x-fern-sdk-return-value': 'client_session',
22928
23103
  'x-response-key': 'client_session',
23104
+ 'x-title': 'Create a Client Session',
22929
23105
  },
22930
23106
  put: {
23107
+ description: 'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
22931
23108
  operationId: 'clientSessionsCreatePut',
22932
23109
  requestBody: {
22933
23110
  content: {
@@ -22935,16 +23112,27 @@ export default {
22935
23112
  schema: {
22936
23113
  properties: {
22937
23114
  connect_webview_ids: {
23115
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
22938
23116
  items: { type: 'string' },
22939
23117
  type: 'array',
22940
23118
  },
22941
23119
  connected_account_ids: {
23120
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
22942
23121
  items: { type: 'string' },
22943
23122
  type: 'array',
22944
23123
  },
22945
- expires_at: { format: 'date-time', type: 'string' },
22946
- user_identifier_key: { minLength: 1, type: 'string' },
23124
+ expires_at: {
23125
+ 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.',
23126
+ format: 'date-time',
23127
+ type: 'string',
23128
+ },
23129
+ user_identifier_key: {
23130
+ description: 'Your user ID for the user for whom you want to create a client session.',
23131
+ minLength: 1,
23132
+ type: 'string',
23133
+ },
22947
23134
  user_identity_ids: {
23135
+ 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.',
22948
23136
  items: { type: 'string' },
22949
23137
  type: 'array',
22950
23138
  },
@@ -22985,17 +23173,23 @@ export default {
22985
23173
  tags: ['/client_sessions'],
22986
23174
  'x-fern-ignore': true,
22987
23175
  'x-response-key': 'client_session',
23176
+ 'x-title': 'Create a Client Session',
22988
23177
  },
22989
23178
  },
22990
23179
  '/client_sessions/delete': {
22991
23180
  post: {
23181
+ description: 'Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
22992
23182
  operationId: 'clientSessionsDeletePost',
22993
23183
  requestBody: {
22994
23184
  content: {
22995
23185
  'application/json': {
22996
23186
  schema: {
22997
23187
  properties: {
22998
- client_session_id: { format: 'uuid', type: 'string' },
23188
+ client_session_id: {
23189
+ description: 'ID of the client session that you want to delete.',
23190
+ format: 'uuid',
23191
+ type: 'string',
23192
+ },
22999
23193
  },
23000
23194
  required: ['client_session_id'],
23001
23195
  type: 'object',
@@ -23029,18 +23223,26 @@ export default {
23029
23223
  'x-fern-sdk-group-name': ['client_sessions'],
23030
23224
  'x-fern-sdk-method-name': 'delete',
23031
23225
  'x-response-key': null,
23226
+ 'x-title': 'Delete a Client Session',
23032
23227
  },
23033
23228
  },
23034
23229
  '/client_sessions/get': {
23035
23230
  post: {
23231
+ description: 'Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
23036
23232
  operationId: 'clientSessionsGetPost',
23037
23233
  requestBody: {
23038
23234
  content: {
23039
23235
  'application/json': {
23040
23236
  schema: {
23041
23237
  properties: {
23042
- client_session_id: { type: 'string' },
23043
- user_identifier_key: { type: 'string' },
23238
+ client_session_id: {
23239
+ description: 'ID of the client session that you want to get.',
23240
+ type: 'string',
23241
+ },
23242
+ user_identifier_key: {
23243
+ description: 'User identifier key associated with the client session that you want to get.',
23244
+ type: 'string',
23245
+ },
23044
23246
  },
23045
23247
  type: 'object',
23046
23248
  },
@@ -23080,10 +23282,12 @@ export default {
23080
23282
  'x-fern-sdk-method-name': 'get',
23081
23283
  'x-fern-sdk-return-value': 'client_session',
23082
23284
  'x-response-key': 'client_session',
23285
+ 'x-title': 'Get a Client Session',
23083
23286
  },
23084
23287
  },
23085
23288
  '/client_sessions/get_or_create': {
23086
23289
  post: {
23290
+ 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.',
23087
23291
  operationId: 'clientSessionsGetOrCreatePost',
23088
23292
  requestBody: {
23089
23293
  content: {
@@ -23091,16 +23295,27 @@ export default {
23091
23295
  schema: {
23092
23296
  properties: {
23093
23297
  connect_webview_ids: {
23298
+ 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).',
23094
23299
  items: { type: 'string' },
23095
23300
  type: 'array',
23096
23301
  },
23097
23302
  connected_account_ids: {
23303
+ 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).',
23098
23304
  items: { type: 'string' },
23099
23305
  type: 'array',
23100
23306
  },
23101
- expires_at: { format: 'date-time', type: 'string' },
23102
- user_identifier_key: { minLength: 1, type: 'string' },
23307
+ expires_at: {
23308
+ 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.',
23309
+ format: 'date-time',
23310
+ type: 'string',
23311
+ },
23312
+ user_identifier_key: {
23313
+ 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).',
23314
+ minLength: 1,
23315
+ type: 'string',
23316
+ },
23103
23317
  user_identity_ids: {
23318
+ 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).',
23104
23319
  items: { type: 'string' },
23105
23320
  type: 'array',
23106
23321
  },
@@ -23143,27 +23358,38 @@ export default {
23143
23358
  'x-fern-sdk-method-name': 'get_or_create',
23144
23359
  'x-fern-sdk-return-value': 'client_session',
23145
23360
  'x-response-key': 'client_session',
23361
+ 'x-title': 'Get or Create a Client Session',
23146
23362
  },
23147
23363
  },
23148
23364
  '/client_sessions/grant_access': {
23149
23365
  patch: {
23366
+ 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.',
23150
23367
  operationId: 'clientSessionsGrantAccessPatch',
23151
23368
  requestBody: {
23152
23369
  content: {
23153
23370
  'application/json': {
23154
23371
  schema: {
23155
23372
  properties: {
23156
- client_session_id: { type: 'string' },
23373
+ client_session_id: {
23374
+ description: 'ID of the client session to which you want to grant access to resources.',
23375
+ type: 'string',
23376
+ },
23157
23377
  connect_webview_ids: {
23378
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
23158
23379
  items: { type: 'string' },
23159
23380
  type: 'array',
23160
23381
  },
23161
23382
  connected_account_ids: {
23383
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
23162
23384
  items: { type: 'string' },
23163
23385
  type: 'array',
23164
23386
  },
23165
- user_identifier_key: { type: 'string' },
23387
+ user_identifier_key: {
23388
+ description: 'Your user ID for the user that you want to associate with the client session.',
23389
+ type: 'string',
23390
+ },
23166
23391
  user_identity_ids: {
23392
+ 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.',
23167
23393
  items: { type: 'string' },
23168
23394
  type: 'array',
23169
23395
  },
@@ -23203,25 +23429,36 @@ export default {
23203
23429
  tags: ['/client_sessions'],
23204
23430
  'x-fern-ignore': true,
23205
23431
  'x-response-key': null,
23432
+ 'x-title': 'Grant Access to a Client Session',
23206
23433
  },
23207
23434
  post: {
23435
+ 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.',
23208
23436
  operationId: 'clientSessionsGrantAccessPost',
23209
23437
  requestBody: {
23210
23438
  content: {
23211
23439
  'application/json': {
23212
23440
  schema: {
23213
23441
  properties: {
23214
- client_session_id: { type: 'string' },
23442
+ client_session_id: {
23443
+ description: 'ID of the client session to which you want to grant access to resources.',
23444
+ type: 'string',
23445
+ },
23215
23446
  connect_webview_ids: {
23447
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
23216
23448
  items: { type: 'string' },
23217
23449
  type: 'array',
23218
23450
  },
23219
23451
  connected_account_ids: {
23452
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
23220
23453
  items: { type: 'string' },
23221
23454
  type: 'array',
23222
23455
  },
23223
- user_identifier_key: { type: 'string' },
23456
+ user_identifier_key: {
23457
+ description: 'Your user ID for the user that you want to associate with the client session.',
23458
+ type: 'string',
23459
+ },
23224
23460
  user_identity_ids: {
23461
+ 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.',
23225
23462
  items: { type: 'string' },
23226
23463
  type: 'array',
23227
23464
  },
@@ -23262,21 +23499,38 @@ export default {
23262
23499
  'x-fern-sdk-group-name': ['client_sessions'],
23263
23500
  'x-fern-sdk-method-name': 'grant_access',
23264
23501
  'x-response-key': null,
23502
+ 'x-title': 'Grant Access to a Client Session',
23265
23503
  },
23266
23504
  },
23267
23505
  '/client_sessions/list': {
23268
23506
  post: {
23507
+ description: 'Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
23269
23508
  operationId: 'clientSessionsListPost',
23270
23509
  requestBody: {
23271
23510
  content: {
23272
23511
  'application/json': {
23273
23512
  schema: {
23274
23513
  properties: {
23275
- client_session_id: { type: 'string' },
23276
- connect_webview_id: { type: 'string' },
23277
- user_identifier_key: { type: 'string' },
23278
- user_identity_id: { type: 'string' },
23279
- without_user_identifier_key: { type: 'boolean' },
23514
+ client_session_id: {
23515
+ description: 'ID of the client session that you want to retrieve.',
23516
+ type: 'string',
23517
+ },
23518
+ connect_webview_id: {
23519
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
23520
+ type: 'string',
23521
+ },
23522
+ user_identifier_key: {
23523
+ description: 'Your user ID for the user by which you want to filter client sessions.',
23524
+ type: 'string',
23525
+ },
23526
+ user_identity_id: {
23527
+ 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.',
23528
+ type: 'string',
23529
+ },
23530
+ without_user_identifier_key: {
23531
+ description: 'Indicates whether to retrieve only client sessions without associated user identifier keys.',
23532
+ type: 'boolean',
23533
+ },
23280
23534
  },
23281
23535
  type: 'object',
23282
23536
  },
@@ -23316,17 +23570,23 @@ export default {
23316
23570
  'x-fern-sdk-method-name': 'list',
23317
23571
  'x-fern-sdk-return-value': 'client_sessions',
23318
23572
  'x-response-key': 'client_sessions',
23573
+ 'x-title': 'List Client Sessions',
23319
23574
  },
23320
23575
  },
23321
23576
  '/client_sessions/revoke': {
23322
23577
  post: {
23578
+ 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.',
23323
23579
  operationId: 'clientSessionsRevokePost',
23324
23580
  requestBody: {
23325
23581
  content: {
23326
23582
  'application/json': {
23327
23583
  schema: {
23328
23584
  properties: {
23329
- client_session_id: { format: 'uuid', type: 'string' },
23585
+ client_session_id: {
23586
+ description: 'ID of the client session that you want to revoke.',
23587
+ format: 'uuid',
23588
+ type: 'string',
23589
+ },
23330
23590
  },
23331
23591
  required: ['client_session_id'],
23332
23592
  type: 'object',
@@ -23360,10 +23620,12 @@ export default {
23360
23620
  'x-fern-sdk-group-name': ['client_sessions'],
23361
23621
  'x-fern-sdk-method-name': 'revoke',
23362
23622
  'x-response-key': null,
23623
+ 'x-title': 'Revoke a Client Session',
23363
23624
  },
23364
23625
  },
23365
23626
  '/connect_webviews/create': {
23366
23627
  post: {
23628
+ 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).',
23367
23629
  operationId: 'connectWebviewsCreatePost',
23368
23630
  requestBody: {
23369
23631
  content: {
@@ -23371,6 +23633,7 @@ export default {
23371
23633
  schema: {
23372
23634
  properties: {
23373
23635
  accepted_providers: {
23636
+ 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.',
23374
23637
  items: {
23375
23638
  enum: [
23376
23639
  'dormakaba_community',
@@ -23430,6 +23693,7 @@ export default {
23430
23693
  },
23431
23694
  automatically_manage_new_devices: {
23432
23695
  default: true,
23696
+ 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).',
23433
23697
  type: 'boolean',
23434
23698
  },
23435
23699
  custom_metadata: {
@@ -23440,15 +23704,24 @@ export default {
23440
23704
  { type: 'boolean' },
23441
23705
  ],
23442
23706
  },
23707
+ 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).',
23443
23708
  type: 'object',
23444
23709
  },
23445
- custom_redirect_failure_url: { type: 'string' },
23446
- custom_redirect_url: { type: 'string' },
23710
+ custom_redirect_failure_url: {
23711
+ 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`.',
23712
+ type: 'string',
23713
+ },
23714
+ custom_redirect_url: {
23715
+ description: 'URL that you want to redirect the user to after the provider login is complete.',
23716
+ type: 'string',
23717
+ },
23447
23718
  device_selection_mode: {
23448
23719
  enum: ['none', 'single', 'multiple'],
23449
23720
  type: 'string',
23721
+ 'x-undocumented': 'Not supported.',
23450
23722
  },
23451
23723
  provider_category: {
23724
+ 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.',
23452
23725
  enum: [
23453
23726
  'stable',
23454
23727
  'consumer_smartlocks',
@@ -23459,7 +23732,11 @@ export default {
23459
23732
  ],
23460
23733
  type: 'string',
23461
23734
  },
23462
- wait_for_device_creation: { default: false, type: 'boolean' },
23735
+ wait_for_device_creation: {
23736
+ default: false,
23737
+ 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).',
23738
+ type: 'boolean',
23739
+ },
23463
23740
  },
23464
23741
  type: 'object',
23465
23742
  },
@@ -23499,17 +23776,23 @@ export default {
23499
23776
  'x-fern-sdk-method-name': 'create',
23500
23777
  'x-fern-sdk-return-value': 'connect_webview',
23501
23778
  'x-response-key': 'connect_webview',
23779
+ 'x-title': 'Create a Connect Webview',
23502
23780
  },
23503
23781
  },
23504
23782
  '/connect_webviews/delete': {
23505
23783
  post: {
23784
+ 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.',
23506
23785
  operationId: 'connectWebviewsDeletePost',
23507
23786
  requestBody: {
23508
23787
  content: {
23509
23788
  'application/json': {
23510
23789
  schema: {
23511
23790
  properties: {
23512
- connect_webview_id: { format: 'uuid', type: 'string' },
23791
+ connect_webview_id: {
23792
+ description: 'ID of the Connect Webview that you want to delete.',
23793
+ format: 'uuid',
23794
+ type: 'string',
23795
+ },
23513
23796
  },
23514
23797
  required: ['connect_webview_id'],
23515
23798
  type: 'object',
@@ -23543,17 +23826,23 @@ export default {
23543
23826
  'x-fern-sdk-group-name': ['connect_webviews'],
23544
23827
  'x-fern-sdk-method-name': 'delete',
23545
23828
  'x-response-key': null,
23829
+ 'x-title': 'Delete a Connect Webview',
23546
23830
  },
23547
23831
  },
23548
23832
  '/connect_webviews/get': {
23549
23833
  post: {
23834
+ 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.",
23550
23835
  operationId: 'connectWebviewsGetPost',
23551
23836
  requestBody: {
23552
23837
  content: {
23553
23838
  'application/json': {
23554
23839
  schema: {
23555
23840
  properties: {
23556
- connect_webview_id: { format: 'uuid', type: 'string' },
23841
+ connect_webview_id: {
23842
+ description: 'ID of the Connect Webview that you want to get.',
23843
+ format: 'uuid',
23844
+ type: 'string',
23845
+ },
23557
23846
  },
23558
23847
  required: ['connect_webview_id'],
23559
23848
  type: 'object',
@@ -23594,10 +23883,12 @@ export default {
23594
23883
  'x-fern-sdk-method-name': 'get',
23595
23884
  'x-fern-sdk-return-value': 'connect_webview',
23596
23885
  'x-response-key': 'connect_webview',
23886
+ 'x-title': 'Get a Connect Webview',
23597
23887
  },
23598
23888
  },
23599
23889
  '/connect_webviews/list': {
23600
23890
  post: {
23891
+ description: 'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
23601
23892
  operationId: 'connectWebviewsListPost',
23602
23893
  requestBody: {
23603
23894
  content: {
@@ -23608,12 +23899,17 @@ export default {
23608
23899
  additionalProperties: {
23609
23900
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
23610
23901
  },
23611
- description: 'Returns webviews whose custom_metadata contains all of the provided key/value pairs.',
23902
+ 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.',
23612
23903
  type: 'object',
23613
23904
  },
23614
- limit: { default: 500, format: 'float', type: 'number' },
23905
+ limit: {
23906
+ default: 500,
23907
+ description: 'Maximum number of records to return per page.',
23908
+ format: 'float',
23909
+ type: 'number',
23910
+ },
23615
23911
  user_identifier_key: {
23616
- description: 'Returns webviews that can be accessed by the provided user_identifier_key.',
23912
+ description: 'Your user ID for the user by which you want to filter Connect Webviews.',
23617
23913
  type: 'string',
23618
23914
  },
23619
23915
  },
@@ -23656,18 +23952,28 @@ export default {
23656
23952
  'x-fern-sdk-method-name': 'list',
23657
23953
  'x-fern-sdk-return-value': 'connect_webviews',
23658
23954
  'x-response-key': 'connect_webviews',
23955
+ 'x-title': 'List Connect Webviews',
23659
23956
  },
23660
23957
  },
23661
23958
  '/connected_accounts/delete': {
23662
23959
  post: {
23960
+ 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.',
23663
23961
  operationId: 'connectedAccountsDeletePost',
23664
23962
  requestBody: {
23665
23963
  content: {
23666
23964
  'application/json': {
23667
23965
  schema: {
23668
23966
  properties: {
23669
- connected_account_id: { format: 'uuid', type: 'string' },
23670
- sync: { default: false, type: 'boolean' },
23967
+ connected_account_id: {
23968
+ description: 'ID of the connected account that you want to delete.',
23969
+ format: 'uuid',
23970
+ type: 'string',
23971
+ },
23972
+ sync: {
23973
+ default: false,
23974
+ type: 'boolean',
23975
+ 'x-undocumented': 'Only used internally.',
23976
+ },
23671
23977
  },
23672
23978
  required: ['connected_account_id'],
23673
23979
  type: 'object',
@@ -23706,6 +24012,7 @@ export default {
23706
24012
  },
23707
24013
  '/connected_accounts/get': {
23708
24014
  post: {
24015
+ description: 'Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
23709
24016
  operationId: 'connectedAccountsGetPost',
23710
24017
  requestBody: {
23711
24018
  content: {
@@ -23714,13 +24021,23 @@ export default {
23714
24021
  oneOf: [
23715
24022
  {
23716
24023
  properties: {
23717
- connected_account_id: { format: 'uuid', type: 'string' },
24024
+ connected_account_id: {
24025
+ description: 'ID of the connected account that you want to get.',
24026
+ format: 'uuid',
24027
+ type: 'string',
24028
+ },
23718
24029
  },
23719
24030
  required: ['connected_account_id'],
23720
24031
  type: 'object',
23721
24032
  },
23722
24033
  {
23723
- properties: { email: { format: 'email', type: 'string' } },
24034
+ properties: {
24035
+ email: {
24036
+ description: 'Email address associated with the connected account that you want to get.',
24037
+ format: 'email',
24038
+ type: 'string',
24039
+ },
24040
+ },
23724
24041
  required: ['email'],
23725
24042
  type: 'object',
23726
24043
  },
@@ -23767,6 +24084,7 @@ export default {
23767
24084
  },
23768
24085
  '/connected_accounts/list': {
23769
24086
  post: {
24087
+ description: 'Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).',
23770
24088
  operationId: 'connectedAccountsListPost',
23771
24089
  requestBody: {
23772
24090
  content: {
@@ -23777,7 +24095,7 @@ export default {
23777
24095
  additionalProperties: {
23778
24096
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
23779
24097
  },
23780
- description: 'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
24098
+ 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.',
23781
24099
  type: 'object',
23782
24100
  },
23783
24101
  customer_ids: {
@@ -23797,7 +24115,7 @@ export default {
23797
24115
  type: 'string',
23798
24116
  },
23799
24117
  user_identifier_key: {
23800
- description: 'Returns accounts that can be accessed by the provided user_identifier_key.',
24118
+ description: 'Your user ID for the user by which you want to filter connected accounts.',
23801
24119
  type: 'string',
23802
24120
  },
23803
24121
  },
@@ -23845,14 +24163,22 @@ export default {
23845
24163
  },
23846
24164
  '/connected_accounts/update': {
23847
24165
  post: {
24166
+ description: 'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
23848
24167
  operationId: 'connectedAccountsUpdatePost',
23849
24168
  requestBody: {
23850
24169
  content: {
23851
24170
  'application/json': {
23852
24171
  schema: {
23853
24172
  properties: {
23854
- automatically_manage_new_devices: { type: 'boolean' },
23855
- connected_account_id: { format: 'uuid', type: 'string' },
24173
+ automatically_manage_new_devices: {
24174
+ description: 'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
24175
+ type: 'boolean',
24176
+ },
24177
+ connected_account_id: {
24178
+ description: 'ID of the connected account that you want to update.',
24179
+ format: 'uuid',
24180
+ type: 'string',
24181
+ },
23856
24182
  custom_metadata: {
23857
24183
  additionalProperties: {
23858
24184
  nullable: true,
@@ -23861,6 +24187,7 @@ export default {
23861
24187
  { type: 'boolean' },
23862
24188
  ],
23863
24189
  },
24190
+ 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).',
23864
24191
  type: 'object',
23865
24192
  },
23866
24193
  },
@@ -23906,12 +24233,19 @@ export default {
23906
24233
  },
23907
24234
  '/devices/delete': {
23908
24235
  post: {
24236
+ description: 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
23909
24237
  operationId: 'devicesDeletePost',
23910
24238
  requestBody: {
23911
24239
  content: {
23912
24240
  'application/json': {
23913
24241
  schema: {
23914
- properties: { device_id: { format: 'uuid', type: 'string' } },
24242
+ properties: {
24243
+ device_id: {
24244
+ description: 'ID of the device that you want to delete.',
24245
+ format: 'uuid',
24246
+ type: 'string',
24247
+ },
24248
+ },
23915
24249
  required: ['device_id'],
23916
24250
  type: 'object',
23917
24251
  },
@@ -23945,19 +24279,28 @@ export default {
23945
24279
  'x-fern-sdk-group-name': ['devices'],
23946
24280
  'x-fern-sdk-method-name': 'delete',
23947
24281
  'x-response-key': null,
24282
+ 'x-title': 'Delete a Device',
23948
24283
  'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
23949
24284
  },
23950
24285
  },
23951
24286
  '/devices/get': {
23952
24287
  post: {
24288
+ description: 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
23953
24289
  operationId: 'devicesGetPost',
23954
24290
  requestBody: {
23955
24291
  content: {
23956
24292
  'application/json': {
23957
24293
  schema: {
23958
24294
  properties: {
23959
- device_id: { format: 'uuid', type: 'string' },
23960
- name: { type: 'string' },
24295
+ device_id: {
24296
+ description: 'ID of the device that you want to get.',
24297
+ format: 'uuid',
24298
+ type: 'string',
24299
+ },
24300
+ name: {
24301
+ description: 'Name of the device that you want to get.',
24302
+ type: 'string',
24303
+ },
23961
24304
  },
23962
24305
  type: 'object',
23963
24306
  },
@@ -23995,6 +24338,7 @@ export default {
23995
24338
  'x-fern-sdk-method-name': 'get',
23996
24339
  'x-fern-sdk-return-value': 'device',
23997
24340
  'x-response-key': 'device',
24341
+ 'x-title': 'Get a Device',
23998
24342
  },
23999
24343
  },
24000
24344
  '/devices/list': {
@@ -24007,22 +24351,22 @@ export default {
24007
24351
  schema: {
24008
24352
  properties: {
24009
24353
  connect_webview_id: {
24010
- description: 'ID of the Connect Webview by which to filter devices.',
24354
+ description: 'ID of the Connect Webview for which you want to list devices.',
24011
24355
  format: 'uuid',
24012
24356
  type: 'string',
24013
24357
  },
24014
24358
  connected_account_id: {
24015
- description: 'ID of the connected account by which to filter.',
24359
+ description: 'ID of the connected account for which you want to list devices.',
24016
24360
  format: 'uuid',
24017
24361
  type: 'string',
24018
24362
  },
24019
24363
  connected_account_ids: {
24020
- description: 'Array of IDs of the connected accounts by which to filter devices.',
24364
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
24021
24365
  items: { format: 'uuid', type: 'string' },
24022
24366
  type: 'array',
24023
24367
  },
24024
24368
  created_before: {
24025
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
24369
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
24026
24370
  format: 'date-time',
24027
24371
  type: 'string',
24028
24372
  },
@@ -24030,7 +24374,7 @@ export default {
24030
24374
  additionalProperties: {
24031
24375
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
24032
24376
  },
24033
- 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.',
24377
+ 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.',
24034
24378
  type: 'object',
24035
24379
  },
24036
24380
  customer_ids: {
@@ -24038,12 +24382,12 @@ export default {
24038
24382
  type: 'array',
24039
24383
  },
24040
24384
  device_ids: {
24041
- description: 'Array of device IDs by which to filter devices.',
24385
+ description: 'Array of device IDs for which you want to list devices.',
24042
24386
  items: { format: 'uuid', type: 'string' },
24043
24387
  type: 'array',
24044
24388
  },
24045
24389
  device_type: {
24046
- description: 'Device type by which to filter devices.',
24390
+ description: 'Device type for which you want to list devices.',
24047
24391
  oneOf: [
24048
24392
  {
24049
24393
  enum: [
@@ -24100,7 +24444,7 @@ export default {
24100
24444
  ],
24101
24445
  },
24102
24446
  device_types: {
24103
- description: 'Array of device types by which to filter devices.',
24447
+ description: 'Array of device types for which you want to list devices.',
24104
24448
  items: {
24105
24449
  oneOf: [
24106
24450
  {
@@ -24206,7 +24550,7 @@ export default {
24206
24550
  type: 'number',
24207
24551
  },
24208
24552
  manufacturer: {
24209
- description: 'Manufacturer by which to filter devices.',
24553
+ description: 'Manufacturer for which you want to list devices.',
24210
24554
  enum: [
24211
24555
  'akuvox',
24212
24556
  'august',
@@ -24255,13 +24599,14 @@ export default {
24255
24599
  type: 'string',
24256
24600
  },
24257
24601
  unstable_location_id: {
24602
+ description: 'ID of the location for which you want to list devices.',
24258
24603
  format: 'uuid',
24259
24604
  nullable: true,
24260
24605
  type: 'string',
24261
24606
  'x-undocumented': 'Experimental locations.',
24262
24607
  },
24263
24608
  user_identifier_key: {
24264
- description: 'Your own internal user ID for the user by which to filter devices.',
24609
+ description: 'Your own internal user ID for the user for which you want to list devices.',
24265
24610
  type: 'string',
24266
24611
  },
24267
24612
  },
@@ -24310,6 +24655,7 @@ export default {
24310
24655
  },
24311
24656
  '/devices/list_device_providers': {
24312
24657
  post: {
24658
+ 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—that is, the brands—that 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).',
24313
24659
  operationId: 'devicesListDeviceProvidersPost',
24314
24660
  requestBody: {
24315
24661
  content: {
@@ -24317,6 +24663,7 @@ export default {
24317
24663
  schema: {
24318
24664
  properties: {
24319
24665
  provider_category: {
24666
+ description: 'Category for which you want to list providers.',
24320
24667
  enum: [
24321
24668
  'stable',
24322
24669
  'consumer_smartlocks',
@@ -24366,16 +24713,24 @@ export default {
24366
24713
  'x-fern-sdk-method-name': 'list_device_providers',
24367
24714
  'x-fern-sdk-return-value': 'device_providers',
24368
24715
  'x-response-key': 'device_providers',
24716
+ 'x-title': 'List Device Providers',
24369
24717
  },
24370
24718
  },
24371
24719
  '/devices/simulate/connect': {
24372
24720
  post: {
24721
+ 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).',
24373
24722
  operationId: 'devicesSimulateConnectPost',
24374
24723
  requestBody: {
24375
24724
  content: {
24376
24725
  'application/json': {
24377
24726
  schema: {
24378
- properties: { device_id: { format: 'uuid', type: 'string' } },
24727
+ properties: {
24728
+ device_id: {
24729
+ description: 'ID of the device that you want to simulate connecting to Seam.',
24730
+ format: 'uuid',
24731
+ type: 'string',
24732
+ },
24733
+ },
24379
24734
  required: ['device_id'],
24380
24735
  type: 'object',
24381
24736
  },
@@ -24408,16 +24763,24 @@ export default {
24408
24763
  'x-fern-sdk-group-name': ['devices', 'simulate'],
24409
24764
  'x-fern-sdk-method-name': 'connect',
24410
24765
  'x-response-key': null,
24766
+ 'x-title': 'Simulate Device Connection',
24411
24767
  },
24412
24768
  },
24413
24769
  '/devices/simulate/disconnect': {
24414
24770
  post: {
24771
+ 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).',
24415
24772
  operationId: 'devicesSimulateDisconnectPost',
24416
24773
  requestBody: {
24417
24774
  content: {
24418
24775
  'application/json': {
24419
24776
  schema: {
24420
- properties: { device_id: { format: 'uuid', type: 'string' } },
24777
+ properties: {
24778
+ device_id: {
24779
+ description: 'ID of the device that you want to simulate disconnecting from Seam.',
24780
+ format: 'uuid',
24781
+ type: 'string',
24782
+ },
24783
+ },
24421
24784
  required: ['device_id'],
24422
24785
  type: 'object',
24423
24786
  },
@@ -24450,16 +24813,24 @@ export default {
24450
24813
  'x-fern-sdk-group-name': ['devices', 'simulate'],
24451
24814
  'x-fern-sdk-method-name': 'disconnect',
24452
24815
  'x-response-key': null,
24816
+ 'x-title': 'Simulate Device Disconnection',
24453
24817
  },
24454
24818
  },
24455
24819
  '/devices/simulate/remove': {
24456
24820
  post: {
24821
+ 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).',
24457
24822
  operationId: 'devicesSimulateRemovePost',
24458
24823
  requestBody: {
24459
24824
  content: {
24460
24825
  'application/json': {
24461
24826
  schema: {
24462
- properties: { device_id: { format: 'uuid', type: 'string' } },
24827
+ properties: {
24828
+ device_id: {
24829
+ description: 'ID of the device that you want to simulate removing from Seam.',
24830
+ format: 'uuid',
24831
+ type: 'string',
24832
+ },
24833
+ },
24463
24834
  required: ['device_id'],
24464
24835
  type: 'object',
24465
24836
  },
@@ -24492,18 +24863,27 @@ export default {
24492
24863
  'x-fern-sdk-group-name': ['devices', 'simulate'],
24493
24864
  'x-fern-sdk-method-name': 'remove',
24494
24865
  'x-response-key': null,
24866
+ 'x-title': 'Simulate Device Removal',
24495
24867
  },
24496
24868
  },
24497
24869
  '/devices/unmanaged/get': {
24498
24870
  post: {
24871
+ 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`.',
24499
24872
  operationId: 'devicesUnmanagedGetPost',
24500
24873
  requestBody: {
24501
24874
  content: {
24502
24875
  'application/json': {
24503
24876
  schema: {
24504
24877
  properties: {
24505
- device_id: { format: 'uuid', type: 'string' },
24506
- name: { type: 'string' },
24878
+ device_id: {
24879
+ description: 'ID of the unmanaged device that you want to get.',
24880
+ format: 'uuid',
24881
+ type: 'string',
24882
+ },
24883
+ name: {
24884
+ description: 'Name of the unmanaged device that you want to get.',
24885
+ type: 'string',
24886
+ },
24507
24887
  },
24508
24888
  type: 'object',
24509
24889
  },
@@ -24541,10 +24921,12 @@ export default {
24541
24921
  'x-fern-sdk-method-name': 'get',
24542
24922
  'x-fern-sdk-return-value': 'device',
24543
24923
  'x-response-key': 'device',
24924
+ 'x-title': 'Get an Unmanaged Device',
24544
24925
  },
24545
24926
  },
24546
24927
  '/devices/unmanaged/list': {
24547
24928
  post: {
24929
+ 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).',
24548
24930
  operationId: 'devicesUnmanagedListPost',
24549
24931
  requestBody: {
24550
24932
  content: {
@@ -24552,22 +24934,22 @@ export default {
24552
24934
  schema: {
24553
24935
  properties: {
24554
24936
  connect_webview_id: {
24555
- description: 'ID of the Connect Webview by which to filter devices.',
24937
+ description: 'ID of the Connect Webview for which you want to list devices.',
24556
24938
  format: 'uuid',
24557
24939
  type: 'string',
24558
24940
  },
24559
24941
  connected_account_id: {
24560
- description: 'ID of the connected account by which to filter.',
24942
+ description: 'ID of the connected account for which you want to list devices.',
24561
24943
  format: 'uuid',
24562
24944
  type: 'string',
24563
24945
  },
24564
24946
  connected_account_ids: {
24565
- description: 'Array of IDs of the connected accounts by which to filter devices.',
24947
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
24566
24948
  items: { format: 'uuid', type: 'string' },
24567
24949
  type: 'array',
24568
24950
  },
24569
24951
  created_before: {
24570
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
24952
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
24571
24953
  format: 'date-time',
24572
24954
  type: 'string',
24573
24955
  },
@@ -24575,7 +24957,7 @@ export default {
24575
24957
  additionalProperties: {
24576
24958
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
24577
24959
  },
24578
- 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.',
24960
+ 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.',
24579
24961
  type: 'object',
24580
24962
  },
24581
24963
  customer_ids: {
@@ -24583,12 +24965,12 @@ export default {
24583
24965
  type: 'array',
24584
24966
  },
24585
24967
  device_ids: {
24586
- description: 'Array of device IDs by which to filter devices.',
24968
+ description: 'Array of device IDs for which you want to list devices.',
24587
24969
  items: { format: 'uuid', type: 'string' },
24588
24970
  type: 'array',
24589
24971
  },
24590
24972
  device_type: {
24591
- description: 'Device type by which to filter devices.',
24973
+ description: 'Device type for which you want to list devices.',
24592
24974
  oneOf: [
24593
24975
  {
24594
24976
  enum: [
@@ -24645,7 +25027,7 @@ export default {
24645
25027
  ],
24646
25028
  },
24647
25029
  device_types: {
24648
- description: 'Array of device types by which to filter devices.',
25030
+ description: 'Array of device types for which you want to list devices.',
24649
25031
  items: {
24650
25032
  oneOf: [
24651
25033
  {
@@ -24751,7 +25133,7 @@ export default {
24751
25133
  type: 'number',
24752
25134
  },
24753
25135
  manufacturer: {
24754
- description: 'Manufacturer by which to filter devices.',
25136
+ description: 'Manufacturer for which you want to list devices.',
24755
25137
  enum: [
24756
25138
  'akuvox',
24757
25139
  'august',
@@ -24800,13 +25182,14 @@ export default {
24800
25182
  type: 'string',
24801
25183
  },
24802
25184
  unstable_location_id: {
25185
+ description: 'ID of the location for which you want to list devices.',
24803
25186
  format: 'uuid',
24804
25187
  nullable: true,
24805
25188
  type: 'string',
24806
25189
  'x-undocumented': 'Experimental locations.',
24807
25190
  },
24808
25191
  user_identifier_key: {
24809
- description: 'Your own internal user ID for the user by which to filter devices.',
25192
+ description: 'Your own internal user ID for the user for which you want to list devices.',
24810
25193
  type: 'string',
24811
25194
  },
24812
25195
  },
@@ -24848,18 +25231,28 @@ export default {
24848
25231
  'x-fern-sdk-method-name': 'list',
24849
25232
  'x-fern-sdk-return-value': 'devices',
24850
25233
  'x-response-key': 'devices',
25234
+ 'x-title': 'List Unmanaged Devices',
24851
25235
  },
24852
25236
  },
24853
25237
  '/devices/unmanaged/update': {
24854
25238
  patch: {
25239
+ 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).',
24855
25240
  operationId: 'devicesUnmanagedUpdatePatch',
24856
25241
  requestBody: {
24857
25242
  content: {
24858
25243
  'application/json': {
24859
25244
  schema: {
24860
25245
  properties: {
24861
- device_id: { format: 'uuid', type: 'string' },
24862
- is_managed: { enum: [true], type: 'boolean' },
25246
+ device_id: {
25247
+ description: 'ID of the unmanaged device that you want to update.',
25248
+ format: 'uuid',
25249
+ type: 'string',
25250
+ },
25251
+ is_managed: {
25252
+ description: 'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
25253
+ enum: [true],
25254
+ type: 'boolean',
25255
+ },
24863
25256
  },
24864
25257
  required: ['device_id', 'is_managed'],
24865
25258
  type: 'object',
@@ -24892,16 +25285,26 @@ export default {
24892
25285
  tags: ['/devices'],
24893
25286
  'x-fern-ignore': true,
24894
25287
  'x-response-key': null,
25288
+ 'x-title': 'Update an Unmanaged Device',
24895
25289
  },
24896
25290
  post: {
25291
+ 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).',
24897
25292
  operationId: 'devicesUnmanagedUpdatePost',
24898
25293
  requestBody: {
24899
25294
  content: {
24900
25295
  'application/json': {
24901
25296
  schema: {
24902
25297
  properties: {
24903
- device_id: { format: 'uuid', type: 'string' },
24904
- is_managed: { enum: [true], type: 'boolean' },
25298
+ device_id: {
25299
+ description: 'ID of the unmanaged device that you want to update.',
25300
+ format: 'uuid',
25301
+ type: 'string',
25302
+ },
25303
+ is_managed: {
25304
+ description: 'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
25305
+ enum: [true],
25306
+ type: 'boolean',
25307
+ },
24905
25308
  },
24906
25309
  required: ['device_id', 'is_managed'],
24907
25310
  type: 'object',
@@ -24935,10 +25338,12 @@ export default {
24935
25338
  'x-fern-sdk-group-name': ['devices', 'unmanaged'],
24936
25339
  'x-fern-sdk-method-name': 'update',
24937
25340
  'x-response-key': null,
25341
+ 'x-title': 'Update an Unmanaged Device',
24938
25342
  },
24939
25343
  },
24940
25344
  '/devices/update': {
24941
25345
  patch: {
25346
+ 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).",
24942
25347
  operationId: 'devicesUpdatePatch',
24943
25348
  requestBody: {
24944
25349
  content: {
@@ -24953,13 +25358,32 @@ export default {
24953
25358
  { type: 'boolean' },
24954
25359
  ],
24955
25360
  },
25361
+ 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).',
24956
25362
  type: 'object',
24957
25363
  },
24958
- device_id: { format: 'uuid', type: 'string' },
24959
- is_managed: { default: true, type: 'boolean' },
24960
- name: { nullable: true, type: 'string' },
25364
+ device_id: {
25365
+ description: 'ID of the device that you want to update.',
25366
+ format: 'uuid',
25367
+ type: 'string',
25368
+ },
25369
+ is_managed: {
25370
+ default: true,
25371
+ description: 'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
25372
+ type: 'boolean',
25373
+ },
25374
+ name: {
25375
+ description: 'Name for the device.',
25376
+ nullable: true,
25377
+ type: 'string',
25378
+ },
24961
25379
  properties: {
24962
- properties: { name: { nullable: true, type: 'string' } },
25380
+ properties: {
25381
+ name: {
25382
+ description: 'Name for the device.',
25383
+ nullable: true,
25384
+ type: 'string',
25385
+ },
25386
+ },
24963
25387
  type: 'object',
24964
25388
  },
24965
25389
  },
@@ -24995,8 +25419,10 @@ export default {
24995
25419
  tags: ['/devices'],
24996
25420
  'x-fern-ignore': true,
24997
25421
  'x-response-key': null,
25422
+ 'x-title': 'Update a Device',
24998
25423
  },
24999
25424
  post: {
25425
+ 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).",
25000
25426
  operationId: 'devicesUpdatePost',
25001
25427
  requestBody: {
25002
25428
  content: {
@@ -25011,13 +25437,32 @@ export default {
25011
25437
  { type: 'boolean' },
25012
25438
  ],
25013
25439
  },
25440
+ 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).',
25014
25441
  type: 'object',
25015
25442
  },
25016
- device_id: { format: 'uuid', type: 'string' },
25017
- is_managed: { default: true, type: 'boolean' },
25018
- name: { nullable: true, type: 'string' },
25443
+ device_id: {
25444
+ description: 'ID of the device that you want to update.',
25445
+ format: 'uuid',
25446
+ type: 'string',
25447
+ },
25448
+ is_managed: {
25449
+ default: true,
25450
+ description: 'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
25451
+ type: 'boolean',
25452
+ },
25453
+ name: {
25454
+ description: 'Name for the device.',
25455
+ nullable: true,
25456
+ type: 'string',
25457
+ },
25019
25458
  properties: {
25020
- properties: { name: { nullable: true, type: 'string' } },
25459
+ properties: {
25460
+ name: {
25461
+ description: 'Name for the device.',
25462
+ nullable: true,
25463
+ type: 'string',
25464
+ },
25465
+ },
25021
25466
  type: 'object',
25022
25467
  },
25023
25468
  },
@@ -25054,10 +25499,12 @@ export default {
25054
25499
  'x-fern-sdk-group-name': ['devices'],
25055
25500
  'x-fern-sdk-method-name': 'update',
25056
25501
  'x-response-key': null,
25502
+ 'x-title': 'Update a Device',
25057
25503
  },
25058
25504
  },
25059
25505
  '/events/get': {
25060
25506
  post: {
25507
+ 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.',
25061
25508
  operationId: 'eventsGetPost',
25062
25509
  requestBody: {
25063
25510
  content: {
@@ -25105,10 +25552,12 @@ export default {
25105
25552
  'x-fern-sdk-method-name': 'get',
25106
25553
  'x-fern-sdk-return-value': 'event',
25107
25554
  'x-response-key': 'event',
25555
+ 'x-title': 'Get an Event',
25108
25556
  },
25109
25557
  },
25110
25558
  '/events/list': {
25111
25559
  post: {
25560
+ 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.',
25112
25561
  operationId: 'eventsListPost',
25113
25562
  requestBody: {
25114
25563
  content: {
@@ -25383,6 +25832,7 @@ export default {
25383
25832
  'x-fern-sdk-method-name': 'list',
25384
25833
  'x-fern-sdk-return-value': 'events',
25385
25834
  'x-response-key': 'events',
25835
+ 'x-title': 'List Events',
25386
25836
  },
25387
25837
  },
25388
25838
  '/locks/get': {
@@ -25445,22 +25895,22 @@ export default {
25445
25895
  schema: {
25446
25896
  properties: {
25447
25897
  connect_webview_id: {
25448
- description: 'ID of the Connect Webview by which to filter devices.',
25898
+ description: 'ID of the Connect Webview for which you want to list devices.',
25449
25899
  format: 'uuid',
25450
25900
  type: 'string',
25451
25901
  },
25452
25902
  connected_account_id: {
25453
- description: 'ID of the connected account by which to filter.',
25903
+ description: 'ID of the connected account for which you want to list devices.',
25454
25904
  format: 'uuid',
25455
25905
  type: 'string',
25456
25906
  },
25457
25907
  connected_account_ids: {
25458
- description: 'Array of IDs of the connected accounts by which to filter devices.',
25908
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
25459
25909
  items: { format: 'uuid', type: 'string' },
25460
25910
  type: 'array',
25461
25911
  },
25462
25912
  created_before: {
25463
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
25913
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
25464
25914
  format: 'date-time',
25465
25915
  type: 'string',
25466
25916
  },
@@ -25468,7 +25918,7 @@ export default {
25468
25918
  additionalProperties: {
25469
25919
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
25470
25920
  },
25471
- 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.',
25921
+ 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.',
25472
25922
  type: 'object',
25473
25923
  },
25474
25924
  customer_ids: {
@@ -25476,7 +25926,7 @@ export default {
25476
25926
  type: 'array',
25477
25927
  },
25478
25928
  device_ids: {
25479
- description: 'Array of device IDs by which to filter devices.',
25929
+ description: 'Array of device IDs for which you want to list devices.',
25480
25930
  items: { format: 'uuid', type: 'string' },
25481
25931
  type: 'array',
25482
25932
  },
@@ -25634,13 +26084,14 @@ export default {
25634
26084
  type: 'string',
25635
26085
  },
25636
26086
  unstable_location_id: {
26087
+ description: 'ID of the location for which you want to list devices.',
25637
26088
  format: 'uuid',
25638
26089
  nullable: true,
25639
26090
  type: 'string',
25640
26091
  'x-undocumented': 'Experimental locations.',
25641
26092
  },
25642
26093
  user_identifier_key: {
25643
- description: 'Your own internal user ID for the user by which to filter devices.',
26094
+ description: 'Your own internal user ID for the user for which you want to list devices.',
25644
26095
  type: 'string',
25645
26096
  },
25646
26097
  },
@@ -25996,22 +26447,22 @@ export default {
25996
26447
  schema: {
25997
26448
  properties: {
25998
26449
  connect_webview_id: {
25999
- description: 'ID of the Connect Webview by which to filter devices.',
26450
+ description: 'ID of the Connect Webview for which you want to list devices.',
26000
26451
  format: 'uuid',
26001
26452
  type: 'string',
26002
26453
  },
26003
26454
  connected_account_id: {
26004
- description: 'ID of the connected account by which to filter.',
26455
+ description: 'ID of the connected account for which you want to list devices.',
26005
26456
  format: 'uuid',
26006
26457
  type: 'string',
26007
26458
  },
26008
26459
  connected_account_ids: {
26009
- description: 'Array of IDs of the connected accounts by which to filter devices.',
26460
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
26010
26461
  items: { format: 'uuid', type: 'string' },
26011
26462
  type: 'array',
26012
26463
  },
26013
26464
  created_before: {
26014
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
26465
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
26015
26466
  format: 'date-time',
26016
26467
  type: 'string',
26017
26468
  },
@@ -26019,7 +26470,7 @@ export default {
26019
26470
  additionalProperties: {
26020
26471
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
26021
26472
  },
26022
- 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.',
26473
+ 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.',
26023
26474
  type: 'object',
26024
26475
  },
26025
26476
  customer_ids: {
@@ -26027,7 +26478,7 @@ export default {
26027
26478
  type: 'array',
26028
26479
  },
26029
26480
  device_ids: {
26030
- description: 'Array of device IDs by which to filter devices.',
26481
+ description: 'Array of device IDs for which you want to list devices.',
26031
26482
  items: { format: 'uuid', type: 'string' },
26032
26483
  type: 'array',
26033
26484
  },
@@ -26101,13 +26552,14 @@ export default {
26101
26552
  type: 'string',
26102
26553
  },
26103
26554
  unstable_location_id: {
26555
+ description: 'ID of the location for which you want to list devices.',
26104
26556
  format: 'uuid',
26105
26557
  nullable: true,
26106
26558
  type: 'string',
26107
26559
  'x-undocumented': 'Experimental locations.',
26108
26560
  },
26109
26561
  user_identifier_key: {
26110
- description: 'Your own internal user ID for the user by which to filter devices.',
26562
+ description: 'Your own internal user ID for the user for which you want to list devices.',
26111
26563
  type: 'string',
26112
26564
  },
26113
26565
  },
@@ -28889,22 +29341,22 @@ export default {
28889
29341
  schema: {
28890
29342
  properties: {
28891
29343
  connect_webview_id: {
28892
- description: 'ID of the Connect Webview by which to filter devices.',
29344
+ description: 'ID of the Connect Webview for which you want to list devices.',
28893
29345
  format: 'uuid',
28894
29346
  type: 'string',
28895
29347
  },
28896
29348
  connected_account_id: {
28897
- description: 'ID of the connected account by which to filter.',
29349
+ description: 'ID of the connected account for which you want to list devices.',
28898
29350
  format: 'uuid',
28899
29351
  type: 'string',
28900
29352
  },
28901
29353
  connected_account_ids: {
28902
- description: 'Array of IDs of the connected accounts by which to filter devices.',
29354
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
28903
29355
  items: { format: 'uuid', type: 'string' },
28904
29356
  type: 'array',
28905
29357
  },
28906
29358
  created_before: {
28907
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
29359
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
28908
29360
  format: 'date-time',
28909
29361
  type: 'string',
28910
29362
  },
@@ -28912,7 +29364,7 @@ export default {
28912
29364
  additionalProperties: {
28913
29365
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
28914
29366
  },
28915
- 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.',
29367
+ 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.',
28916
29368
  type: 'object',
28917
29369
  },
28918
29370
  customer_ids: {
@@ -28920,7 +29372,7 @@ export default {
28920
29372
  type: 'array',
28921
29373
  },
28922
29374
  device_ids: {
28923
- description: 'Array of device IDs by which to filter devices.',
29375
+ description: 'Array of device IDs for which you want to list devices.',
28924
29376
  items: { format: 'uuid', type: 'string' },
28925
29377
  type: 'array',
28926
29378
  },
@@ -29014,13 +29466,14 @@ export default {
29014
29466
  type: 'string',
29015
29467
  },
29016
29468
  unstable_location_id: {
29469
+ description: 'ID of the location for which you want to list devices.',
29017
29470
  format: 'uuid',
29018
29471
  nullable: true,
29019
29472
  type: 'string',
29020
29473
  'x-undocumented': 'Experimental locations.',
29021
29474
  },
29022
29475
  user_identifier_key: {
29023
- description: 'Your own internal user ID for the user by which to filter devices.',
29476
+ description: 'Your own internal user ID for the user for which you want to list devices.',
29024
29477
  type: 'string',
29025
29478
  },
29026
29479
  },
@@ -32159,6 +32612,101 @@ export default {
32159
32612
  'x-undocumented': 'Experimental locations.',
32160
32613
  },
32161
32614
  },
32615
+ '/unstable_partner/resources/push': {
32616
+ post: {
32617
+ description: 'Send Seam some of your resources.',
32618
+ operationId: 'unstablePartnerResourcesPushPost',
32619
+ requestBody: {
32620
+ content: {
32621
+ 'application/json': {
32622
+ schema: {
32623
+ oneOf: [
32624
+ {
32625
+ items: {
32626
+ properties: {
32627
+ custom_metadata: {
32628
+ additionalProperties: { type: 'string' },
32629
+ type: 'object',
32630
+ },
32631
+ customer_key: { type: 'string' },
32632
+ description: { type: 'string' },
32633
+ email_address: { type: 'string' },
32634
+ ends_at: { type: 'string' },
32635
+ icon_url: { type: 'string' },
32636
+ location_keys: {
32637
+ items: { type: 'string' },
32638
+ type: 'array',
32639
+ },
32640
+ name: { type: 'string' },
32641
+ partner_resource_key: { type: 'string' },
32642
+ partner_resource_type: { type: 'string' },
32643
+ phone_number: { type: 'string' },
32644
+ starts_at: { type: 'string' },
32645
+ user_identity_key: { type: 'string' },
32646
+ },
32647
+ type: 'object',
32648
+ },
32649
+ type: 'array',
32650
+ },
32651
+ {
32652
+ properties: {
32653
+ custom_metadata: {
32654
+ additionalProperties: { type: 'string' },
32655
+ type: 'object',
32656
+ },
32657
+ customer_key: { type: 'string' },
32658
+ description: { type: 'string' },
32659
+ email_address: { type: 'string' },
32660
+ ends_at: { type: 'string' },
32661
+ icon_url: { type: 'string' },
32662
+ location_keys: {
32663
+ items: { type: 'string' },
32664
+ type: 'array',
32665
+ },
32666
+ name: { type: 'string' },
32667
+ partner_resource_key: { type: 'string' },
32668
+ partner_resource_type: { type: 'string' },
32669
+ phone_number: { type: 'string' },
32670
+ starts_at: { type: 'string' },
32671
+ user_identity_key: { type: 'string' },
32672
+ },
32673
+ type: 'object',
32674
+ },
32675
+ ],
32676
+ },
32677
+ },
32678
+ },
32679
+ },
32680
+ responses: {
32681
+ 200: {
32682
+ content: {
32683
+ 'application/json': {
32684
+ schema: {
32685
+ properties: { ok: { type: 'boolean' } },
32686
+ required: ['ok'],
32687
+ type: 'object',
32688
+ },
32689
+ },
32690
+ },
32691
+ description: 'OK',
32692
+ },
32693
+ 400: { description: 'Bad Request' },
32694
+ 401: { description: 'Unauthorized' },
32695
+ },
32696
+ security: [
32697
+ { pat_with_workspace: [] },
32698
+ { console_session_with_workspace: [] },
32699
+ { api_key: [] },
32700
+ ],
32701
+ summary: '/unstable_partner/resources/push',
32702
+ tags: [],
32703
+ 'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
32704
+ 'x-fern-sdk-method-name': 'push',
32705
+ 'x-response-key': null,
32706
+ 'x-title': 'Push partner resources at Seam',
32707
+ 'x-undocumented': 'Experimental partner resources.',
32708
+ },
32709
+ },
32162
32710
  '/user_identities/add_acs_user': {
32163
32711
  post: {
32164
32712
  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).',
@@ -32346,7 +32894,7 @@ export default {
32346
32894
  },
32347
32895
  '/user_identities/delete': {
32348
32896
  post: {
32349
- 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.',
32897
+ 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.',
32350
32898
  operationId: 'userIdentitiesDeletePost',
32351
32899
  requestBody: {
32352
32900
  content: {
@@ -33912,6 +34460,7 @@ export default {
33912
34460
  },
33913
34461
  '/workspaces/reset_sandbox': {
33914
34462
  post: {
34463
+ 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.',
33915
34464
  operationId: 'workspacesResetSandboxPost',
33916
34465
  responses: {
33917
34466
  200: {