@seamapi/types 1.399.0 → 1.400.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/connect.cjs +889 -297
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +848 -179
  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 +807 -258
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +467 -179
  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 +1010 -258
  42. package/src/lib/seam/connect/route-types.ts +469 -179
@@ -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,17 +19038,22 @@ 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. You can only provide one of acs_user_id or user_identity_id.',
19047
+ format: 'uuid',
19048
+ type: 'string',
19049
+ },
19050
+ user_identity_id: {
19051
+ description: 'ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.',
19029
19052
  format: 'uuid',
19030
19053
  type: 'string',
19031
19054
  },
19032
19055
  },
19033
- required: ['acs_access_group_id', 'acs_user_id'],
19056
+ required: ['acs_access_group_id'],
19034
19057
  type: 'object',
19035
19058
  },
19036
19059
  },
@@ -19065,7 +19088,7 @@ export default {
19065
19088
  'x-title': 'Add an ACS User to an Access Group',
19066
19089
  },
19067
19090
  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).',
19091
+ 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
19092
  operationId: 'acsAccessGroupsAddUserPut',
19070
19093
  requestBody: {
19071
19094
  content: {
@@ -19073,17 +19096,22 @@ export default {
19073
19096
  schema: {
19074
19097
  properties: {
19075
19098
  acs_access_group_id: {
19076
- description: 'ID of the desired access group.',
19099
+ description: 'ID of the access group to which you want to add an access system user.',
19077
19100
  format: 'uuid',
19078
19101
  type: 'string',
19079
19102
  },
19080
19103
  acs_user_id: {
19081
- description: 'ID of the desired user.',
19104
+ description: 'ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.',
19105
+ format: 'uuid',
19106
+ type: 'string',
19107
+ },
19108
+ user_identity_id: {
19109
+ description: 'ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.',
19082
19110
  format: 'uuid',
19083
19111
  type: 'string',
19084
19112
  },
19085
19113
  },
19086
- required: ['acs_access_group_id', 'acs_user_id'],
19114
+ required: ['acs_access_group_id'],
19087
19115
  type: 'object',
19088
19116
  },
19089
19117
  },
@@ -19127,7 +19155,7 @@ export default {
19127
19155
  schema: {
19128
19156
  properties: {
19129
19157
  acs_access_group_id: {
19130
- description: 'ID of the desired access group.',
19158
+ description: 'ID of the access group that you want to get.',
19131
19159
  format: 'uuid',
19132
19160
  type: 'string',
19133
19161
  },
@@ -19183,12 +19211,12 @@ export default {
19183
19211
  schema: {
19184
19212
  properties: {
19185
19213
  acs_system_id: {
19186
- description: 'ID of the access control system for which you want to retrieve all access groups.',
19214
+ description: 'ID of the access system for which you want to retrieve all access groups.',
19187
19215
  format: 'uuid',
19188
19216
  type: 'string',
19189
19217
  },
19190
19218
  acs_user_id: {
19191
- description: 'ID of the user for which you want to retrieve all access groups.',
19219
+ description: 'ID of the access system user for which you want to retrieve all access groups.',
19192
19220
  format: 'uuid',
19193
19221
  type: 'string',
19194
19222
  },
@@ -19298,7 +19326,7 @@ export default {
19298
19326
  },
19299
19327
  '/acs/access_groups/list_users': {
19300
19328
  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).',
19329
+ 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
19330
  operationId: 'acsAccessGroupsListUsersPost',
19303
19331
  requestBody: {
19304
19332
  content: {
@@ -19306,7 +19334,7 @@ export default {
19306
19334
  schema: {
19307
19335
  properties: {
19308
19336
  acs_access_group_id: {
19309
- description: 'ID of the access group for which you want to retrieve all users.',
19337
+ description: 'ID of the access group for which you want to retrieve all access system users.',
19310
19338
  format: 'uuid',
19311
19339
  type: 'string',
19312
19340
  },
@@ -19355,7 +19383,7 @@ export default {
19355
19383
  },
19356
19384
  '/acs/access_groups/remove_user': {
19357
19385
  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).',
19386
+ 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
19387
  operationId: 'acsAccessGroupsRemoveUserPost',
19360
19388
  requestBody: {
19361
19389
  content: {
@@ -19363,17 +19391,17 @@ export default {
19363
19391
  schema: {
19364
19392
  properties: {
19365
19393
  acs_access_group_id: {
19366
- description: 'ID of the desired access group.',
19394
+ description: 'ID of the access group from which you want to remove an access system user.',
19367
19395
  format: 'uuid',
19368
19396
  type: 'string',
19369
19397
  },
19370
19398
  acs_user_id: {
19371
- description: 'ID of the desired user.',
19399
+ description: 'ID of the access system user that you want to remove from an access group.',
19372
19400
  format: 'uuid',
19373
19401
  type: 'string',
19374
19402
  },
19375
19403
  user_identity_id: {
19376
- description: 'ID of the desired user identity.',
19404
+ description: 'ID of the user identity associated with the user that you want to remove from an access group.',
19377
19405
  format: 'uuid',
19378
19406
  type: 'string',
19379
19407
  },
@@ -19423,7 +19451,7 @@ export default {
19423
19451
  schema: {
19424
19452
  properties: {
19425
19453
  acs_access_group_id: {
19426
- description: 'ID of the desired unmanaged access group.',
19454
+ description: 'ID of the unmanaged access group that you want to get.',
19427
19455
  format: 'uuid',
19428
19456
  type: 'string',
19429
19457
  },
@@ -19466,6 +19494,7 @@ export default {
19466
19494
  'x-fern-sdk-method-name': 'get',
19467
19495
  'x-fern-sdk-return-value': 'acs_access_group',
19468
19496
  'x-response-key': 'acs_access_group',
19497
+ 'x-title': 'Get an Unmanaged Access Group',
19469
19498
  'x-undocumented': 'No unmanaged access groups are currently implemented.',
19470
19499
  },
19471
19500
  },
@@ -19479,12 +19508,12 @@ export default {
19479
19508
  schema: {
19480
19509
  properties: {
19481
19510
  acs_system_id: {
19482
- description: 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
19511
+ description: 'ID of the access system for which you want to retrieve all unmanaged access groups.',
19483
19512
  format: 'uuid',
19484
19513
  type: 'string',
19485
19514
  },
19486
19515
  acs_user_id: {
19487
- description: 'ID of the user for which you want to retrieve all unmanaged access groups.',
19516
+ description: 'ID of the access system user for which you want to retrieve all unmanaged access groups.',
19488
19517
  format: 'uuid',
19489
19518
  type: 'string',
19490
19519
  },
@@ -19529,18 +19558,24 @@ export default {
19529
19558
  'x-fern-sdk-method-name': 'list',
19530
19559
  'x-fern-sdk-return-value': 'acs_access_groups',
19531
19560
  'x-response-key': 'acs_access_groups',
19561
+ 'x-title': 'List Unmanaged Access Groups',
19532
19562
  'x-undocumented': 'No unmanaged access groups are currently implemented.',
19533
19563
  },
19534
19564
  },
19535
19565
  '/acs/credential_pools/list': {
19536
19566
  post: {
19567
+ description: 'Returns a list of all credential pools.',
19537
19568
  operationId: 'acsCredentialPoolsListPost',
19538
19569
  requestBody: {
19539
19570
  content: {
19540
19571
  'application/json': {
19541
19572
  schema: {
19542
19573
  properties: {
19543
- acs_system_id: { format: 'uuid', type: 'string' },
19574
+ acs_system_id: {
19575
+ description: 'ID of the access system for which you want to list credential pools.',
19576
+ format: 'uuid',
19577
+ type: 'string',
19578
+ },
19544
19579
  },
19545
19580
  required: ['acs_system_id'],
19546
19581
  type: 'object',
@@ -19584,28 +19619,43 @@ export default {
19584
19619
  'x-fern-sdk-method-name': 'list',
19585
19620
  'x-fern-sdk-return-value': 'acs_credential_pools',
19586
19621
  'x-response-key': 'acs_credential_pools',
19622
+ 'x-title': 'List Credential Pools',
19587
19623
  'x-undocumented': 'Replaced by enrollment automations.',
19588
19624
  },
19589
19625
  },
19590
19626
  '/acs/credential_provisioning_automations/launch': {
19591
19627
  post: {
19628
+ description: 'Launches a credential provisioning automation.',
19592
19629
  operationId: 'acsCredentialProvisioningAutomationsLaunchPost',
19593
19630
  requestBody: {
19594
19631
  content: {
19595
19632
  'application/json': {
19596
19633
  schema: {
19597
19634
  properties: {
19598
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
19599
- create_credential_manager_user: { type: 'boolean' },
19635
+ acs_credential_pool_id: {
19636
+ description: 'ID of the credential pool for which you want to launch a credential provisioning automation.',
19637
+ format: 'uuid',
19638
+ type: 'string',
19639
+ },
19640
+ create_credential_manager_user: {
19641
+ 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`.',
19642
+ type: 'boolean',
19643
+ },
19600
19644
  credential_manager_acs_system_id: {
19645
+ description: 'Access system ID of the credential manager for which you want to launch a credential provisioning automation.',
19601
19646
  format: 'uuid',
19602
19647
  type: 'string',
19603
19648
  },
19604
19649
  credential_manager_acs_user_id: {
19650
+ 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`.',
19651
+ format: 'uuid',
19652
+ type: 'string',
19653
+ },
19654
+ user_identity_id: {
19655
+ description: 'ID of the user identity for which you want to launch a credential provisioning automation.',
19605
19656
  format: 'uuid',
19606
19657
  type: 'string',
19607
19658
  },
19608
- user_identity_id: { format: 'uuid', type: 'string' },
19609
19659
  },
19610
19660
  required: [
19611
19661
  'user_identity_id',
@@ -19649,12 +19699,13 @@ export default {
19649
19699
  'x-fern-sdk-method-name': 'launch',
19650
19700
  'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
19651
19701
  'x-response-key': 'acs_credential_provisioning_automation',
19702
+ 'x-title': 'Launch a Credential Provisioning Automation',
19652
19703
  'x-undocumented': 'Replaced by enrollment automations.',
19653
19704
  },
19654
19705
  },
19655
19706
  '/acs/credentials/assign': {
19656
19707
  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).',
19708
+ 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
19709
  operationId: 'acsCredentialsAssignPatch',
19659
19710
  requestBody: {
19660
19711
  content: {
@@ -19662,12 +19713,12 @@ export default {
19662
19713
  schema: {
19663
19714
  properties: {
19664
19715
  acs_credential_id: {
19665
- description: 'ID of the desired credential.',
19716
+ description: 'ID of the credential that you want to assign to an access system user.',
19666
19717
  format: 'uuid',
19667
19718
  type: 'string',
19668
19719
  },
19669
19720
  acs_user_id: {
19670
- description: 'ID of the desired user.',
19721
+ description: 'ID of the access system user to whom you want to assign a credential.',
19671
19722
  format: 'uuid',
19672
19723
  type: 'string',
19673
19724
  },
@@ -19711,7 +19762,7 @@ export default {
19711
19762
  'x-title': 'Assign a Credential to an ACS User',
19712
19763
  },
19713
19764
  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).',
19765
+ 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
19766
  operationId: 'acsCredentialsAssignPost',
19716
19767
  requestBody: {
19717
19768
  content: {
@@ -19719,12 +19770,12 @@ export default {
19719
19770
  schema: {
19720
19771
  properties: {
19721
19772
  acs_credential_id: {
19722
- description: 'ID of the desired credential.',
19773
+ description: 'ID of the credential that you want to assign to an access system user.',
19723
19774
  format: 'uuid',
19724
19775
  type: 'string',
19725
19776
  },
19726
19777
  acs_user_id: {
19727
- description: 'ID of the desired user.',
19778
+ description: 'ID of the access system user to whom you want to assign a credential.',
19728
19779
  format: 'uuid',
19729
19780
  type: 'string',
19730
19781
  },
@@ -19784,12 +19835,12 @@ export default {
19784
19835
  type: 'string',
19785
19836
  },
19786
19837
  acs_system_id: {
19787
- description: 'ID of the ACS system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.',
19838
+ 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`.',
19788
19839
  format: 'uuid',
19789
19840
  type: 'string',
19790
19841
  },
19791
19842
  acs_user_id: {
19792
- description: 'ID of the ACS user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.',
19843
+ 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`.',
19793
19844
  format: 'uuid',
19794
19845
  type: 'string',
19795
19846
  },
@@ -19835,8 +19886,14 @@ export default {
19835
19886
  salto_space_metadata: {
19836
19887
  description: 'Salto Space-specific metadata for the new credential.',
19837
19888
  properties: {
19838
- assign_new_key: { type: 'boolean' },
19839
- update_current_key: { type: 'boolean' },
19889
+ assign_new_key: {
19890
+ 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).',
19891
+ type: 'boolean',
19892
+ },
19893
+ update_current_key: {
19894
+ 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).",
19895
+ type: 'boolean',
19896
+ },
19840
19897
  },
19841
19898
  type: 'object',
19842
19899
  },
@@ -19846,7 +19903,7 @@ export default {
19846
19903
  type: 'string',
19847
19904
  },
19848
19905
  user_identity_id: {
19849
- description: 'ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.',
19906
+ 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.',
19850
19907
  format: 'uuid',
19851
19908
  type: 'string',
19852
19909
  },
@@ -19928,7 +19985,7 @@ export default {
19928
19985
  },
19929
19986
  '/acs/credentials/create_offline_code': {
19930
19987
  post: {
19931
- 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).',
19988
+ 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).',
19932
19989
  operationId: 'acsCredentialsCreateOfflineCodePost',
19933
19990
  requestBody: {
19934
19991
  content: {
@@ -19936,7 +19993,7 @@ export default {
19936
19993
  schema: {
19937
19994
  properties: {
19938
19995
  acs_user_id: {
19939
- description: 'ID of the ACS user to whom the new credential belongs.',
19996
+ description: 'ID of the access system user to whom the new credential belongs.',
19940
19997
  format: 'uuid',
19941
19998
  type: 'string',
19942
19999
  },
@@ -20013,7 +20070,7 @@ export default {
20013
20070
  schema: {
20014
20071
  properties: {
20015
20072
  acs_credential_id: {
20016
- description: 'ID of the desired credential.',
20073
+ description: 'ID of the credential that you want to delete.',
20017
20074
  format: 'uuid',
20018
20075
  type: 'string',
20019
20076
  },
@@ -20063,7 +20120,7 @@ export default {
20063
20120
  schema: {
20064
20121
  properties: {
20065
20122
  acs_credential_id: {
20066
- description: 'ID of the desired credential.',
20123
+ description: 'ID of the credential that you want to get.',
20067
20124
  format: 'uuid',
20068
20125
  type: 'string',
20069
20126
  },
@@ -20123,7 +20180,7 @@ export default {
20123
20180
  {
20124
20181
  properties: {
20125
20182
  acs_user_id: {
20126
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20183
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20127
20184
  format: 'uuid',
20128
20185
  type: 'string',
20129
20186
  },
@@ -20134,7 +20191,7 @@ export default {
20134
20191
  {
20135
20192
  properties: {
20136
20193
  acs_system_id: {
20137
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20194
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20138
20195
  format: 'uuid',
20139
20196
  type: 'string',
20140
20197
  },
@@ -20145,12 +20202,12 @@ export default {
20145
20202
  {
20146
20203
  properties: {
20147
20204
  acs_system_id: {
20148
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20205
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20149
20206
  format: 'uuid',
20150
20207
  type: 'string',
20151
20208
  },
20152
20209
  acs_user_id: {
20153
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20210
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20154
20211
  format: 'uuid',
20155
20212
  type: 'string',
20156
20213
  },
@@ -20244,7 +20301,7 @@ export default {
20244
20301
  schema: {
20245
20302
  properties: {
20246
20303
  acs_credential_id: {
20247
- description: 'ID of the credential for which you want to retrieve all entrances to which this credential grants access.',
20304
+ description: 'ID of the credential for which you want to retrieve all entrances to which the credential grants access.',
20248
20305
  format: 'uuid',
20249
20306
  type: 'string',
20250
20307
  },
@@ -20293,7 +20350,7 @@ export default {
20293
20350
  },
20294
20351
  '/acs/credentials/unassign': {
20295
20352
  patch: {
20296
- 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).',
20353
+ 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).',
20297
20354
  operationId: 'acsCredentialsUnassignPatch',
20298
20355
  requestBody: {
20299
20356
  content: {
@@ -20301,12 +20358,12 @@ export default {
20301
20358
  schema: {
20302
20359
  properties: {
20303
20360
  acs_credential_id: {
20304
- description: 'ID of the desired credential.',
20361
+ description: 'ID of the credential that you want to unassign from an access system user.',
20305
20362
  format: 'uuid',
20306
20363
  type: 'string',
20307
20364
  },
20308
20365
  acs_user_id: {
20309
- description: 'ID of the desired user.',
20366
+ description: 'ID of the access system user from which you want to unassign a credential.',
20310
20367
  format: 'uuid',
20311
20368
  type: 'string',
20312
20369
  },
@@ -20350,7 +20407,7 @@ export default {
20350
20407
  'x-title': 'Unassign a Credential from an ACS User',
20351
20408
  },
20352
20409
  post: {
20353
- 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).',
20410
+ 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).',
20354
20411
  operationId: 'acsCredentialsUnassignPost',
20355
20412
  requestBody: {
20356
20413
  content: {
@@ -20358,12 +20415,12 @@ export default {
20358
20415
  schema: {
20359
20416
  properties: {
20360
20417
  acs_credential_id: {
20361
- description: 'ID of the desired credential.',
20418
+ description: 'ID of the credential that you want to unassign from an access system user.',
20362
20419
  format: 'uuid',
20363
20420
  type: 'string',
20364
20421
  },
20365
20422
  acs_user_id: {
20366
- description: 'ID of the desired user.',
20423
+ description: 'ID of the access system user from which you want to unassign a credential.',
20367
20424
  format: 'uuid',
20368
20425
  type: 'string',
20369
20426
  },
@@ -20418,7 +20475,7 @@ export default {
20418
20475
  schema: {
20419
20476
  properties: {
20420
20477
  acs_credential_id: {
20421
- description: 'ID of the desired unmanaged credential.',
20478
+ description: 'ID of the unmanaged credential that you want to get.',
20422
20479
  format: 'uuid',
20423
20480
  type: 'string',
20424
20481
  },
@@ -20475,9 +20532,10 @@ export default {
20475
20532
  schema: {
20476
20533
  oneOf: [
20477
20534
  {
20535
+ description: 'ID of the access system user for which you want to list unmanaged credentials.',
20478
20536
  properties: {
20479
20537
  acs_user_id: {
20480
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20538
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20481
20539
  format: 'uuid',
20482
20540
  type: 'string',
20483
20541
  },
@@ -20486,9 +20544,10 @@ export default {
20486
20544
  type: 'object',
20487
20545
  },
20488
20546
  {
20547
+ description: 'ID of the access system for which you want to list unmanaged credentials.',
20489
20548
  properties: {
20490
20549
  acs_system_id: {
20491
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20550
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20492
20551
  format: 'uuid',
20493
20552
  type: 'string',
20494
20553
  },
@@ -20497,14 +20556,15 @@ export default {
20497
20556
  type: 'object',
20498
20557
  },
20499
20558
  {
20559
+ description: 'ID of the access system and ID of the access system user for which you want to list unmanaged credentials.',
20500
20560
  properties: {
20501
20561
  acs_system_id: {
20502
- description: 'ID of the access control system for which you want to retrieve all credentials.',
20562
+ description: 'ID of the access system for which you want to retrieve all credentials.',
20503
20563
  format: 'uuid',
20504
20564
  type: 'string',
20505
20565
  },
20506
20566
  acs_user_id: {
20507
- description: 'ID of the ACS user for which you want to retrieve all credentials.',
20567
+ description: 'ID of the access system user for which you want to retrieve all credentials.',
20508
20568
  format: 'uuid',
20509
20569
  type: 'string',
20510
20570
  },
@@ -20513,6 +20573,7 @@ export default {
20513
20573
  type: 'object',
20514
20574
  },
20515
20575
  {
20576
+ description: 'ID of the user identity for which you want to list unmanaged credentials.',
20516
20577
  properties: {
20517
20578
  user_identity_id: {
20518
20579
  description: 'ID of the user identity for which you want to retrieve all credentials.',
@@ -20577,11 +20638,11 @@ export default {
20577
20638
  schema: {
20578
20639
  properties: {
20579
20640
  acs_credential_id: {
20580
- description: 'ID of the desired credential.',
20641
+ description: 'ID of the credential that you want to update.',
20581
20642
  type: 'string',
20582
20643
  },
20583
20644
  code: {
20584
- description: 'Replacement access (PIN) code for the credential.',
20645
+ description: 'Replacement access (PIN) code for the credential that you want to update.',
20585
20646
  pattern: '^\\d+$',
20586
20647
  type: 'string',
20587
20648
  },
@@ -20638,11 +20699,11 @@ export default {
20638
20699
  schema: {
20639
20700
  properties: {
20640
20701
  acs_credential_id: {
20641
- description: 'ID of the desired credential.',
20702
+ description: 'ID of the credential that you want to update.',
20642
20703
  type: 'string',
20643
20704
  },
20644
20705
  code: {
20645
- description: 'Replacement access (PIN) code for the credential.',
20706
+ description: 'Replacement access (PIN) code for the credential that you want to update.',
20646
20707
  pattern: '^\\d+$',
20647
20708
  type: 'string',
20648
20709
  },
@@ -20826,7 +20887,7 @@ export default {
20826
20887
  schema: {
20827
20888
  properties: {
20828
20889
  acs_encoder_id: {
20829
- description: 'ID of the desired encoder.',
20890
+ description: 'ID of the encoder that you want to get.',
20830
20891
  format: 'uuid',
20831
20892
  type: 'string',
20832
20893
  },
@@ -20882,13 +20943,13 @@ export default {
20882
20943
  {
20883
20944
  properties: {
20884
20945
  acs_system_id: {
20885
- description: 'ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.',
20946
+ description: 'ID of the access system for which you want to retrieve all encoders.',
20886
20947
  format: 'uuid',
20887
20948
  type: 'string',
20888
20949
  },
20889
20950
  limit: {
20890
20951
  default: 500,
20891
- description: 'Number of `acs_encoders` to return.',
20952
+ description: 'Number of encoders to return.',
20892
20953
  format: 'float',
20893
20954
  type: 'number',
20894
20955
  },
@@ -20899,13 +20960,13 @@ export default {
20899
20960
  {
20900
20961
  properties: {
20901
20962
  acs_system_ids: {
20902
- description: 'IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.',
20963
+ description: 'IDs of the access systems for which you want to retrieve all encoders.',
20903
20964
  items: { format: 'uuid', type: 'string' },
20904
20965
  type: 'array',
20905
20966
  },
20906
20967
  limit: {
20907
20968
  default: 500,
20908
- description: 'Number of `acs_encoders` to return.',
20969
+ description: 'Number of encoders to return.',
20909
20970
  format: 'float',
20910
20971
  type: 'number',
20911
20972
  },
@@ -20916,13 +20977,13 @@ export default {
20916
20977
  {
20917
20978
  properties: {
20918
20979
  acs_encoder_ids: {
20919
- description: 'IDs of the `acs_encoder`s that you want to retrieve.',
20980
+ description: 'IDs of the encoders that you want to retrieve.',
20920
20981
  items: { format: 'uuid', type: 'string' },
20921
20982
  type: 'array',
20922
20983
  },
20923
20984
  limit: {
20924
20985
  default: 500,
20925
- description: 'Number of `acs_encoders` to return.',
20986
+ description: 'Number of encoders to return.',
20926
20987
  format: 'float',
20927
20988
  type: 'number',
20928
20989
  },
@@ -20981,7 +21042,7 @@ export default {
20981
21042
  schema: {
20982
21043
  properties: {
20983
21044
  acs_encoder_id: {
20984
- description: 'ID of the `acs_encoder` to use for the scan.',
21045
+ description: 'ID of the encoder to use for the scan.',
20985
21046
  format: 'uuid',
20986
21047
  type: 'string',
20987
21048
  },
@@ -21353,14 +21414,18 @@ export default {
21353
21414
  },
21354
21415
  '/acs/entrances/get': {
21355
21416
  post: {
21356
- description: 'Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21417
+ description: 'Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21357
21418
  operationId: 'acsEntrancesGetPost',
21358
21419
  requestBody: {
21359
21420
  content: {
21360
21421
  'application/json': {
21361
21422
  schema: {
21362
21423
  properties: {
21363
- acs_entrance_id: { format: 'uuid', type: 'string' },
21424
+ acs_entrance_id: {
21425
+ description: 'ID of the entrance that you want to get.',
21426
+ format: 'uuid',
21427
+ type: 'string',
21428
+ },
21364
21429
  },
21365
21430
  required: ['acs_entrance_id'],
21366
21431
  type: 'object',
@@ -21404,14 +21469,23 @@ export default {
21404
21469
  },
21405
21470
  '/acs/entrances/grant_access': {
21406
21471
  post: {
21472
+ 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).',
21407
21473
  operationId: 'acsEntrancesGrantAccessPost',
21408
21474
  requestBody: {
21409
21475
  content: {
21410
21476
  'application/json': {
21411
21477
  schema: {
21412
21478
  properties: {
21413
- acs_entrance_id: { format: 'uuid', type: 'string' },
21414
- acs_user_id: { format: 'uuid', type: 'string' },
21479
+ acs_entrance_id: {
21480
+ description: 'ID of the entrance to which you want to grant an access system user access.',
21481
+ format: 'uuid',
21482
+ type: 'string',
21483
+ },
21484
+ acs_user_id: {
21485
+ description: 'ID of the access system user to whom you want to grant access to an entrance.',
21486
+ format: 'uuid',
21487
+ type: 'string',
21488
+ },
21415
21489
  },
21416
21490
  required: ['acs_entrance_id', 'acs_user_id'],
21417
21491
  type: 'object',
@@ -21450,16 +21524,25 @@ export default {
21450
21524
  },
21451
21525
  '/acs/entrances/list': {
21452
21526
  post: {
21453
- description: 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21527
+ description: 'Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
21454
21528
  operationId: 'acsEntrancesListPost',
21455
21529
  requestBody: {
21456
21530
  content: {
21457
21531
  'application/json': {
21458
21532
  schema: {
21459
21533
  properties: {
21460
- acs_credential_id: { format: 'uuid', type: 'string' },
21461
- acs_system_id: { format: 'uuid', type: 'string' },
21534
+ acs_credential_id: {
21535
+ description: 'ID of the credential for which you want to retrieve all entrances.',
21536
+ format: 'uuid',
21537
+ type: 'string',
21538
+ },
21539
+ acs_system_id: {
21540
+ description: 'ID of the access system for which you want to retrieve all entrances.',
21541
+ format: 'uuid',
21542
+ type: 'string',
21543
+ },
21462
21544
  location_id: {
21545
+ description: 'ID of the location for which you want to retrieve all entrances.',
21463
21546
  format: 'uuid',
21464
21547
  nullable: true,
21465
21548
  type: 'string',
@@ -21517,8 +21600,13 @@ export default {
21517
21600
  'application/json': {
21518
21601
  schema: {
21519
21602
  properties: {
21520
- acs_entrance_id: { format: 'uuid', type: 'string' },
21603
+ acs_entrance_id: {
21604
+ description: 'ID of the entrance for which you want to list all credentials that grant access.',
21605
+ format: 'uuid',
21606
+ type: 'string',
21607
+ },
21521
21608
  include_if: {
21609
+ description: 'Conditions that credentials must meet to be included in the returned list.',
21522
21610
  items: {
21523
21611
  enum: ['visionline_metadata.is_valid'],
21524
21612
  type: 'string',
@@ -21571,7 +21659,7 @@ export default {
21571
21659
  },
21572
21660
  '/acs/systems/get': {
21573
21661
  post: {
21574
- 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.',
21662
+ description: 'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',
21575
21663
  operationId: 'acsSystemsGetPost',
21576
21664
  requestBody: {
21577
21665
  content: {
@@ -21579,7 +21667,7 @@ export default {
21579
21667
  schema: {
21580
21668
  properties: {
21581
21669
  acs_system_id: {
21582
- description: 'ID of the desired access control system.',
21670
+ description: 'ID of the access system that you want to get.',
21583
21671
  format: 'uuid',
21584
21672
  type: 'string',
21585
21673
  },
@@ -21625,7 +21713,7 @@ export default {
21625
21713
  },
21626
21714
  '/acs/systems/list': {
21627
21715
  post: {
21628
- 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.',
21716
+ 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.',
21629
21717
  operationId: 'acsSystemsListPost',
21630
21718
  requestBody: {
21631
21719
  content: {
@@ -21633,7 +21721,7 @@ export default {
21633
21721
  schema: {
21634
21722
  properties: {
21635
21723
  connected_account_id: {
21636
- description: 'ID of the connected account by which to filter the list of returned access control systems.',
21724
+ description: 'ID of the connected account by which you want to filter the list of access systems.',
21637
21725
  format: 'uuid',
21638
21726
  type: 'string',
21639
21727
  },
@@ -21682,7 +21770,7 @@ export default {
21682
21770
  },
21683
21771
  '/acs/systems/list_compatible_credential_manager_acs_systems': {
21684
21772
  post: {
21685
- 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.',
21773
+ 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.',
21686
21774
  operationId: 'acsSystemsListCompatibleCredentialManagerAcsSystemsPost',
21687
21775
  requestBody: {
21688
21776
  content: {
@@ -21690,7 +21778,7 @@ export default {
21690
21778
  schema: {
21691
21779
  properties: {
21692
21780
  acs_system_id: {
21693
- description: 'ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.',
21781
+ description: 'ID of the access system for which you want to retrieve all compatible credential manager systems.',
21694
21782
  format: 'uuid',
21695
21783
  type: 'string',
21696
21784
  },
@@ -21739,7 +21827,7 @@ export default {
21739
21827
  },
21740
21828
  '/acs/users/add_to_access_group': {
21741
21829
  post: {
21742
- 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).',
21830
+ 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).',
21743
21831
  operationId: 'acsUsersAddToAccessGroupPost',
21744
21832
  requestBody: {
21745
21833
  content: {
@@ -21747,12 +21835,12 @@ export default {
21747
21835
  schema: {
21748
21836
  properties: {
21749
21837
  acs_access_group_id: {
21750
- description: 'ID of the desired access group.',
21838
+ description: 'ID of the access group to which you want to add an access system user.',
21751
21839
  format: 'uuid',
21752
21840
  type: 'string',
21753
21841
  },
21754
21842
  acs_user_id: {
21755
- description: 'ID of the desired `acs_user`.',
21843
+ description: 'ID of the access system user that you want to add to an access group.',
21756
21844
  format: 'uuid',
21757
21845
  type: 'string',
21758
21846
  },
@@ -21792,7 +21880,7 @@ export default {
21792
21880
  'x-title': 'Add an ACS User to an Access Group',
21793
21881
  },
21794
21882
  put: {
21795
- 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).',
21883
+ 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).',
21796
21884
  operationId: 'acsUsersAddToAccessGroupPut',
21797
21885
  requestBody: {
21798
21886
  content: {
@@ -21800,12 +21888,12 @@ export default {
21800
21888
  schema: {
21801
21889
  properties: {
21802
21890
  acs_access_group_id: {
21803
- description: 'ID of the desired access group.',
21891
+ description: 'ID of the access group to which you want to add an access system user.',
21804
21892
  format: 'uuid',
21805
21893
  type: 'string',
21806
21894
  },
21807
21895
  acs_user_id: {
21808
- description: 'ID of the desired `acs_user`.',
21896
+ description: 'ID of the access system user that you want to add to an access group.',
21809
21897
  format: 'uuid',
21810
21898
  type: 'string',
21811
21899
  },
@@ -21846,7 +21934,7 @@ export default {
21846
21934
  },
21847
21935
  '/acs/users/create': {
21848
21936
  post: {
21849
- description: 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21937
+ description: 'Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21850
21938
  operationId: 'acsUsersCreatePost',
21851
21939
  requestBody: {
21852
21940
  content: {
@@ -21854,25 +21942,30 @@ export default {
21854
21942
  schema: {
21855
21943
  properties: {
21856
21944
  access_schedule: {
21857
- 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`.",
21945
+ 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`.",
21858
21946
  properties: {
21859
21947
  ends_at: {
21948
+ description: "Ending timestamp for the new access system user's access.",
21860
21949
  format: 'date-time',
21861
21950
  nullable: true,
21862
21951
  type: 'string',
21863
21952
  },
21864
- starts_at: { format: 'date-time', type: 'string' },
21953
+ starts_at: {
21954
+ description: "Starting timestamp for the new access system user's access.",
21955
+ format: 'date-time',
21956
+ type: 'string',
21957
+ },
21865
21958
  },
21866
21959
  type: 'object',
21867
21960
  },
21868
21961
  acs_access_group_ids: {
21869
21962
  default: [],
21870
- description: 'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.',
21963
+ description: 'Array of access group IDs to indicate the access groups to which you want to add the new access system user.',
21871
21964
  items: { format: 'uuid', type: 'string' },
21872
21965
  type: 'array',
21873
21966
  },
21874
21967
  acs_system_id: {
21875
- description: 'ID of the `acs_system` to which to add the new `acs_user`.',
21968
+ description: 'ID of the access system to which you want to add the new access system user.',
21876
21969
  format: 'uuid',
21877
21970
  type: 'string',
21878
21971
  },
@@ -21888,7 +21981,7 @@ export default {
21888
21981
  type: 'string',
21889
21982
  },
21890
21983
  full_name: {
21891
- description: 'Full name of the new `acs_user`.',
21984
+ description: 'Full name of the new access system user.',
21892
21985
  type: 'string',
21893
21986
  },
21894
21987
  phone_number: {
@@ -21896,7 +21989,7 @@ export default {
21896
21989
  type: 'string',
21897
21990
  },
21898
21991
  user_identity_id: {
21899
- description: 'ID of the user identity with which to associate the new `acs_user`.',
21992
+ description: 'ID of the user identity with which you want to associate the new access system user.',
21900
21993
  format: 'uuid',
21901
21994
  type: 'string',
21902
21995
  },
@@ -21942,7 +22035,7 @@ export default {
21942
22035
  },
21943
22036
  '/acs/users/delete': {
21944
22037
  post: {
21945
- 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).",
22038
+ 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).",
21946
22039
  operationId: 'acsUsersDeletePost',
21947
22040
  requestBody: {
21948
22041
  content: {
@@ -21950,7 +22043,7 @@ export default {
21950
22043
  schema: {
21951
22044
  properties: {
21952
22045
  acs_user_id: {
21953
- description: 'ID of the desired `acs_user`.',
22046
+ description: 'ID of the access system user that you want to delete.',
21954
22047
  format: 'uuid',
21955
22048
  type: 'string',
21956
22049
  },
@@ -21992,7 +22085,7 @@ export default {
21992
22085
  },
21993
22086
  '/acs/users/get': {
21994
22087
  post: {
21995
- description: 'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22088
+ description: 'Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
21996
22089
  operationId: 'acsUsersGetPost',
21997
22090
  requestBody: {
21998
22091
  content: {
@@ -22000,7 +22093,7 @@ export default {
22000
22093
  schema: {
22001
22094
  properties: {
22002
22095
  acs_user_id: {
22003
- description: 'ID of the desired `acs_user`.',
22096
+ description: 'ID of the access system user that you want to get.',
22004
22097
  format: 'uuid',
22005
22098
  type: 'string',
22006
22099
  },
@@ -22046,7 +22139,7 @@ export default {
22046
22139
  },
22047
22140
  '/acs/users/list': {
22048
22141
  post: {
22049
- description: 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22142
+ description: 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22050
22143
  operationId: 'acsUsersListPost',
22051
22144
  requestBody: {
22052
22145
  content: {
@@ -22054,11 +22147,15 @@ export default {
22054
22147
  schema: {
22055
22148
  properties: {
22056
22149
  acs_system_id: {
22057
- description: 'ID of the `acs_system` for which you want to retrieve all `acs_user`s.',
22150
+ description: 'ID of the `acs_system` for which you want to retrieve all access system users.',
22058
22151
  format: 'uuid',
22059
22152
  type: 'string',
22060
22153
  },
22061
- created_before: { format: 'date-time', type: 'string' },
22154
+ created_before: {
22155
+ description: 'Timestamp by which to limit returned access system users. Returns users created before this timestamp.',
22156
+ format: 'date-time',
22157
+ type: 'string',
22158
+ },
22062
22159
  limit: {
22063
22160
  default: 500,
22064
22161
  description: 'Maximum number of records to return per page.',
@@ -22072,21 +22169,21 @@ export default {
22072
22169
  type: 'string',
22073
22170
  },
22074
22171
  search: {
22075
- 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`.',
22172
+ 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`.',
22076
22173
  minLength: 1,
22077
22174
  type: 'string',
22078
22175
  },
22079
22176
  user_identity_email_address: {
22080
- description: 'Email address of the user identity for which you want to retrieve all `acs_user`s.',
22177
+ description: 'Email address of the user identity for which you want to retrieve all access system users.',
22081
22178
  type: 'string',
22082
22179
  },
22083
22180
  user_identity_id: {
22084
- description: 'ID of the user identity for which you want to retrieve all `acs_user`s.',
22181
+ description: 'ID of the user identity for which you want to retrieve all access system users.',
22085
22182
  format: 'uuid',
22086
22183
  type: 'string',
22087
22184
  },
22088
22185
  user_identity_phone_number: {
22089
- 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`).',
22186
+ 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`).',
22090
22187
  type: 'string',
22091
22188
  },
22092
22189
  },
@@ -22135,7 +22232,7 @@ export default {
22135
22232
  },
22136
22233
  '/acs/users/list_accessible_entrances': {
22137
22234
  post: {
22138
- 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.',
22235
+ 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.',
22139
22236
  operationId: 'acsUsersListAccessibleEntrancesPost',
22140
22237
  requestBody: {
22141
22238
  content: {
@@ -22143,7 +22240,7 @@ export default {
22143
22240
  schema: {
22144
22241
  properties: {
22145
22242
  acs_user_id: {
22146
- description: 'ID of the desired `acs_user`.',
22243
+ description: 'ID of the access system user for whom you want to list accessible entrances.',
22147
22244
  format: 'uuid',
22148
22245
  type: 'string',
22149
22246
  },
@@ -22193,7 +22290,7 @@ export default {
22193
22290
  },
22194
22291
  '/acs/users/remove_from_access_group': {
22195
22292
  post: {
22196
- 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).',
22293
+ 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).',
22197
22294
  operationId: 'acsUsersRemoveFromAccessGroupPost',
22198
22295
  requestBody: {
22199
22296
  content: {
@@ -22201,12 +22298,12 @@ export default {
22201
22298
  schema: {
22202
22299
  properties: {
22203
22300
  acs_access_group_id: {
22204
- description: 'ID of the desired access group.',
22301
+ description: 'ID of the access group from which you want to remove an access system user.',
22205
22302
  format: 'uuid',
22206
22303
  type: 'string',
22207
22304
  },
22208
22305
  acs_user_id: {
22209
- description: 'ID of the desired `acs_user`.',
22306
+ description: 'ID of the access system user that you want to remove from an access group.',
22210
22307
  format: 'uuid',
22211
22308
  type: 'string',
22212
22309
  },
@@ -22248,7 +22345,7 @@ export default {
22248
22345
  },
22249
22346
  '/acs/users/revoke_access_to_all_entrances': {
22250
22347
  post: {
22251
- 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).',
22348
+ 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).',
22252
22349
  operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
22253
22350
  requestBody: {
22254
22351
  content: {
@@ -22256,7 +22353,7 @@ export default {
22256
22353
  schema: {
22257
22354
  properties: {
22258
22355
  acs_user_id: {
22259
- description: 'ID of the desired `acs_user`.',
22356
+ description: 'ID of the access system user for whom you want to revoke access.',
22260
22357
  format: 'uuid',
22261
22358
  type: 'string',
22262
22359
  },
@@ -22298,7 +22395,7 @@ export default {
22298
22395
  },
22299
22396
  '/acs/users/suspend': {
22300
22397
  post: {
22301
- 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.",
22398
+ 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.",
22302
22399
  operationId: 'acsUsersSuspendPost',
22303
22400
  requestBody: {
22304
22401
  content: {
@@ -22306,7 +22403,7 @@ export default {
22306
22403
  schema: {
22307
22404
  properties: {
22308
22405
  acs_user_id: {
22309
- description: 'ID of the desired `acs_user`.',
22406
+ description: 'ID of the access system user that you want to suspend.',
22310
22407
  format: 'uuid',
22311
22408
  type: 'string',
22312
22409
  },
@@ -22348,12 +22445,19 @@ export default {
22348
22445
  },
22349
22446
  '/acs/users/unmanaged/get': {
22350
22447
  post: {
22448
+ description: 'Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22351
22449
  operationId: 'acsUsersUnmanagedGetPost',
22352
22450
  requestBody: {
22353
22451
  content: {
22354
22452
  'application/json': {
22355
22453
  schema: {
22356
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
22454
+ properties: {
22455
+ acs_user_id: {
22456
+ description: 'ID of the unmanaged access system user that you want to get.',
22457
+ format: 'uuid',
22458
+ type: 'string',
22459
+ },
22460
+ },
22357
22461
  required: ['acs_user_id'],
22358
22462
  type: 'object',
22359
22463
  },
@@ -22392,22 +22496,43 @@ export default {
22392
22496
  'x-fern-sdk-method-name': 'get',
22393
22497
  'x-fern-sdk-return-value': 'acs_user',
22394
22498
  'x-response-key': 'acs_user',
22499
+ 'x-title': 'Get an Unmanaged ACS User',
22395
22500
  'x-undocumented': 'No unmanaged users are currently implemented.',
22396
22501
  },
22397
22502
  },
22398
22503
  '/acs/users/unmanaged/list': {
22399
22504
  post: {
22505
+ description: 'Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22400
22506
  operationId: 'acsUsersUnmanagedListPost',
22401
22507
  requestBody: {
22402
22508
  content: {
22403
22509
  'application/json': {
22404
22510
  schema: {
22405
22511
  properties: {
22406
- acs_system_id: { format: 'uuid', type: 'string' },
22407
- limit: { default: 500, format: 'float', type: 'number' },
22408
- user_identity_email_address: { type: 'string' },
22409
- user_identity_id: { format: 'uuid', type: 'string' },
22410
- user_identity_phone_number: { type: 'string' },
22512
+ acs_system_id: {
22513
+ description: 'ID of the access system for which you want to retrieve all unmanaged access system users.',
22514
+ format: 'uuid',
22515
+ type: 'string',
22516
+ },
22517
+ limit: {
22518
+ default: 500,
22519
+ description: 'Number of unmanaged access system users to return.',
22520
+ format: 'float',
22521
+ type: 'number',
22522
+ },
22523
+ user_identity_email_address: {
22524
+ description: 'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
22525
+ type: 'string',
22526
+ },
22527
+ user_identity_id: {
22528
+ description: 'ID of the user identity for which you want to retrieve all unmanaged access system users.',
22529
+ format: 'uuid',
22530
+ type: 'string',
22531
+ },
22532
+ user_identity_phone_number: {
22533
+ description: 'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
22534
+ type: 'string',
22535
+ },
22411
22536
  },
22412
22537
  type: 'object',
22413
22538
  },
@@ -22449,12 +22574,13 @@ export default {
22449
22574
  'x-fern-sdk-method-name': 'list',
22450
22575
  'x-fern-sdk-return-value': 'acs_users',
22451
22576
  'x-response-key': 'acs_users',
22577
+ 'x-title': 'List Unmanaged ACS Users',
22452
22578
  'x-undocumented': 'No unmanaged users are currently implemented.',
22453
22579
  },
22454
22580
  },
22455
22581
  '/acs/users/unsuspend': {
22456
22582
  post: {
22457
- 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.',
22583
+ 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.',
22458
22584
  operationId: 'acsUsersUnsuspendPost',
22459
22585
  requestBody: {
22460
22586
  content: {
@@ -22462,7 +22588,7 @@ export default {
22462
22588
  schema: {
22463
22589
  properties: {
22464
22590
  acs_user_id: {
22465
- description: 'ID of the desired `acs_user`.',
22591
+ description: 'ID of the access system user that you want to unsuspend.',
22466
22592
  format: 'uuid',
22467
22593
  type: 'string',
22468
22594
  },
@@ -22504,7 +22630,7 @@ export default {
22504
22630
  },
22505
22631
  '/acs/users/update': {
22506
22632
  patch: {
22507
- description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22633
+ description: 'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22508
22634
  operationId: 'acsUsersUpdatePatch',
22509
22635
  requestBody: {
22510
22636
  content: {
@@ -22512,11 +22638,19 @@ export default {
22512
22638
  schema: {
22513
22639
  properties: {
22514
22640
  access_schedule: {
22515
- 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`.",
22641
+ 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`.",
22516
22642
  nullable: true,
22517
22643
  properties: {
22518
- ends_at: { format: 'date-time', type: 'string' },
22519
- starts_at: { format: 'date-time', type: 'string' },
22644
+ ends_at: {
22645
+ description: "Ending timestamp for the access system user's access.",
22646
+ format: 'date-time',
22647
+ type: 'string',
22648
+ },
22649
+ starts_at: {
22650
+ description: "Starting timestamp for the access system user's access.",
22651
+ format: 'date-time',
22652
+ type: 'string',
22653
+ },
22520
22654
  },
22521
22655
  required: ['starts_at', 'ends_at'],
22522
22656
  type: 'object',
@@ -22582,7 +22716,7 @@ export default {
22582
22716
  'x-title': 'Update an ACS User',
22583
22717
  },
22584
22718
  post: {
22585
- description: 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22719
+ description: 'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
22586
22720
  operationId: 'acsUsersUpdatePost',
22587
22721
  requestBody: {
22588
22722
  content: {
@@ -22590,11 +22724,19 @@ export default {
22590
22724
  schema: {
22591
22725
  properties: {
22592
22726
  access_schedule: {
22593
- 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`.",
22727
+ 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`.",
22594
22728
  nullable: true,
22595
22729
  properties: {
22596
- ends_at: { format: 'date-time', type: 'string' },
22597
- starts_at: { format: 'date-time', type: 'string' },
22730
+ ends_at: {
22731
+ description: "Ending timestamp for the access system user's access.",
22732
+ format: 'date-time',
22733
+ type: 'string',
22734
+ },
22735
+ starts_at: {
22736
+ description: "Starting timestamp for the access system user's access.",
22737
+ format: 'date-time',
22738
+ type: 'string',
22739
+ },
22598
22740
  },
22599
22741
  required: ['starts_at', 'ends_at'],
22600
22742
  type: 'object',
@@ -22663,13 +22805,18 @@ export default {
22663
22805
  },
22664
22806
  '/action_attempts/get': {
22665
22807
  post: {
22808
+ description: 'Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
22666
22809
  operationId: 'actionAttemptsGetPost',
22667
22810
  requestBody: {
22668
22811
  content: {
22669
22812
  'application/json': {
22670
22813
  schema: {
22671
22814
  properties: {
22672
- action_attempt_id: { format: 'uuid', type: 'string' },
22815
+ action_attempt_id: {
22816
+ description: 'ID of the action attempt that you want to get.',
22817
+ format: 'uuid',
22818
+ type: 'string',
22819
+ },
22673
22820
  },
22674
22821
  required: ['action_attempt_id'],
22675
22822
  type: 'object',
@@ -22710,10 +22857,12 @@ export default {
22710
22857
  'x-fern-sdk-method-name': 'get',
22711
22858
  'x-fern-sdk-return-value': 'action_attempt',
22712
22859
  'x-response-key': 'action_attempt',
22860
+ 'x-title': 'Get an Action Attempt',
22713
22861
  },
22714
22862
  },
22715
22863
  '/action_attempts/list': {
22716
22864
  post: {
22865
+ 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.',
22717
22866
  operationId: 'actionAttemptsListPost',
22718
22867
  requestBody: {
22719
22868
  content: {
@@ -22721,6 +22870,7 @@ export default {
22721
22870
  schema: {
22722
22871
  properties: {
22723
22872
  action_attempt_ids: {
22873
+ description: 'IDs of the action attempts that you want to retrieve.',
22724
22874
  items: { format: 'uuid', type: 'string' },
22725
22875
  type: 'array',
22726
22876
  },
@@ -22764,16 +22914,24 @@ export default {
22764
22914
  'x-fern-sdk-method-name': 'list',
22765
22915
  'x-fern-sdk-return-value': 'action_attempts',
22766
22916
  'x-response-key': 'action_attempts',
22917
+ 'x-title': 'List Action Attempts',
22767
22918
  },
22768
22919
  },
22769
22920
  '/bridges/get': {
22770
22921
  post: {
22922
+ description: 'Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
22771
22923
  operationId: 'bridgesGetPost',
22772
22924
  requestBody: {
22773
22925
  content: {
22774
22926
  'application/json': {
22775
22927
  schema: {
22776
- properties: { bridge_id: { format: 'uuid', type: 'string' } },
22928
+ properties: {
22929
+ bridge_id: {
22930
+ description: 'ID of the Seam Bridge that you want to get.',
22931
+ format: 'uuid',
22932
+ type: 'string',
22933
+ },
22934
+ },
22777
22935
  required: ['bridge_id'],
22778
22936
  type: 'object',
22779
22937
  },
@@ -22820,10 +22978,13 @@ export default {
22820
22978
  'x-fern-sdk-method-name': 'get',
22821
22979
  'x-fern-sdk-return-value': 'bridge',
22822
22980
  'x-response-key': 'bridge',
22981
+ 'x-title': 'Get a Seam Bridge',
22982
+ 'x-undocumented': 'Not yet for customer use.',
22823
22983
  },
22824
22984
  },
22825
22985
  '/bridges/list': {
22826
22986
  post: {
22987
+ description: 'Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).',
22827
22988
  operationId: 'bridgesListPost',
22828
22989
  requestBody: {
22829
22990
  content: {
@@ -22873,10 +23034,13 @@ export default {
22873
23034
  'x-fern-sdk-method-name': 'list',
22874
23035
  'x-fern-sdk-return-value': 'bridges',
22875
23036
  'x-response-key': 'bridges',
23037
+ 'x-title': 'List Seam Bridges',
23038
+ 'x-undocumented': 'Not yet for customer use.',
22876
23039
  },
22877
23040
  },
22878
23041
  '/client_sessions/create': {
22879
23042
  post: {
23043
+ description: 'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
22880
23044
  operationId: 'clientSessionsCreatePost',
22881
23045
  requestBody: {
22882
23046
  content: {
@@ -22884,16 +23048,27 @@ export default {
22884
23048
  schema: {
22885
23049
  properties: {
22886
23050
  connect_webview_ids: {
23051
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
22887
23052
  items: { type: 'string' },
22888
23053
  type: 'array',
22889
23054
  },
22890
23055
  connected_account_ids: {
23056
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
22891
23057
  items: { type: 'string' },
22892
23058
  type: 'array',
22893
23059
  },
22894
- expires_at: { format: 'date-time', type: 'string' },
22895
- user_identifier_key: { minLength: 1, type: 'string' },
23060
+ expires_at: {
23061
+ 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.',
23062
+ format: 'date-time',
23063
+ type: 'string',
23064
+ },
23065
+ user_identifier_key: {
23066
+ description: 'Your user ID for the user for whom you want to create a client session.',
23067
+ minLength: 1,
23068
+ type: 'string',
23069
+ },
22896
23070
  user_identity_ids: {
23071
+ 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.',
22897
23072
  items: { type: 'string' },
22898
23073
  type: 'array',
22899
23074
  },
@@ -22936,8 +23111,10 @@ export default {
22936
23111
  'x-fern-sdk-method-name': 'create',
22937
23112
  'x-fern-sdk-return-value': 'client_session',
22938
23113
  'x-response-key': 'client_session',
23114
+ 'x-title': 'Create a Client Session',
22939
23115
  },
22940
23116
  put: {
23117
+ description: 'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
22941
23118
  operationId: 'clientSessionsCreatePut',
22942
23119
  requestBody: {
22943
23120
  content: {
@@ -22945,16 +23122,27 @@ export default {
22945
23122
  schema: {
22946
23123
  properties: {
22947
23124
  connect_webview_ids: {
23125
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
22948
23126
  items: { type: 'string' },
22949
23127
  type: 'array',
22950
23128
  },
22951
23129
  connected_account_ids: {
23130
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
22952
23131
  items: { type: 'string' },
22953
23132
  type: 'array',
22954
23133
  },
22955
- expires_at: { format: 'date-time', type: 'string' },
22956
- user_identifier_key: { minLength: 1, type: 'string' },
23134
+ expires_at: {
23135
+ 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.',
23136
+ format: 'date-time',
23137
+ type: 'string',
23138
+ },
23139
+ user_identifier_key: {
23140
+ description: 'Your user ID for the user for whom you want to create a client session.',
23141
+ minLength: 1,
23142
+ type: 'string',
23143
+ },
22957
23144
  user_identity_ids: {
23145
+ 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.',
22958
23146
  items: { type: 'string' },
22959
23147
  type: 'array',
22960
23148
  },
@@ -22995,17 +23183,23 @@ export default {
22995
23183
  tags: ['/client_sessions'],
22996
23184
  'x-fern-ignore': true,
22997
23185
  'x-response-key': 'client_session',
23186
+ 'x-title': 'Create a Client Session',
22998
23187
  },
22999
23188
  },
23000
23189
  '/client_sessions/delete': {
23001
23190
  post: {
23191
+ description: 'Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
23002
23192
  operationId: 'clientSessionsDeletePost',
23003
23193
  requestBody: {
23004
23194
  content: {
23005
23195
  'application/json': {
23006
23196
  schema: {
23007
23197
  properties: {
23008
- client_session_id: { format: 'uuid', type: 'string' },
23198
+ client_session_id: {
23199
+ description: 'ID of the client session that you want to delete.',
23200
+ format: 'uuid',
23201
+ type: 'string',
23202
+ },
23009
23203
  },
23010
23204
  required: ['client_session_id'],
23011
23205
  type: 'object',
@@ -23039,18 +23233,26 @@ export default {
23039
23233
  'x-fern-sdk-group-name': ['client_sessions'],
23040
23234
  'x-fern-sdk-method-name': 'delete',
23041
23235
  'x-response-key': null,
23236
+ 'x-title': 'Delete a Client Session',
23042
23237
  },
23043
23238
  },
23044
23239
  '/client_sessions/get': {
23045
23240
  post: {
23241
+ description: 'Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
23046
23242
  operationId: 'clientSessionsGetPost',
23047
23243
  requestBody: {
23048
23244
  content: {
23049
23245
  'application/json': {
23050
23246
  schema: {
23051
23247
  properties: {
23052
- client_session_id: { type: 'string' },
23053
- user_identifier_key: { type: 'string' },
23248
+ client_session_id: {
23249
+ description: 'ID of the client session that you want to get.',
23250
+ type: 'string',
23251
+ },
23252
+ user_identifier_key: {
23253
+ description: 'User identifier key associated with the client session that you want to get.',
23254
+ type: 'string',
23255
+ },
23054
23256
  },
23055
23257
  type: 'object',
23056
23258
  },
@@ -23090,10 +23292,12 @@ export default {
23090
23292
  'x-fern-sdk-method-name': 'get',
23091
23293
  'x-fern-sdk-return-value': 'client_session',
23092
23294
  'x-response-key': 'client_session',
23295
+ 'x-title': 'Get a Client Session',
23093
23296
  },
23094
23297
  },
23095
23298
  '/client_sessions/get_or_create': {
23096
23299
  post: {
23300
+ 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.',
23097
23301
  operationId: 'clientSessionsGetOrCreatePost',
23098
23302
  requestBody: {
23099
23303
  content: {
@@ -23101,16 +23305,27 @@ export default {
23101
23305
  schema: {
23102
23306
  properties: {
23103
23307
  connect_webview_ids: {
23308
+ 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).',
23104
23309
  items: { type: 'string' },
23105
23310
  type: 'array',
23106
23311
  },
23107
23312
  connected_account_ids: {
23313
+ 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).',
23108
23314
  items: { type: 'string' },
23109
23315
  type: 'array',
23110
23316
  },
23111
- expires_at: { format: 'date-time', type: 'string' },
23112
- user_identifier_key: { minLength: 1, type: 'string' },
23317
+ expires_at: {
23318
+ 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.',
23319
+ format: 'date-time',
23320
+ type: 'string',
23321
+ },
23322
+ user_identifier_key: {
23323
+ 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).',
23324
+ minLength: 1,
23325
+ type: 'string',
23326
+ },
23113
23327
  user_identity_ids: {
23328
+ 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).',
23114
23329
  items: { type: 'string' },
23115
23330
  type: 'array',
23116
23331
  },
@@ -23153,27 +23368,38 @@ export default {
23153
23368
  'x-fern-sdk-method-name': 'get_or_create',
23154
23369
  'x-fern-sdk-return-value': 'client_session',
23155
23370
  'x-response-key': 'client_session',
23371
+ 'x-title': 'Get or Create a Client Session',
23156
23372
  },
23157
23373
  },
23158
23374
  '/client_sessions/grant_access': {
23159
23375
  patch: {
23376
+ 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.',
23160
23377
  operationId: 'clientSessionsGrantAccessPatch',
23161
23378
  requestBody: {
23162
23379
  content: {
23163
23380
  'application/json': {
23164
23381
  schema: {
23165
23382
  properties: {
23166
- client_session_id: { type: 'string' },
23383
+ client_session_id: {
23384
+ description: 'ID of the client session to which you want to grant access to resources.',
23385
+ type: 'string',
23386
+ },
23167
23387
  connect_webview_ids: {
23388
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
23168
23389
  items: { type: 'string' },
23169
23390
  type: 'array',
23170
23391
  },
23171
23392
  connected_account_ids: {
23393
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
23172
23394
  items: { type: 'string' },
23173
23395
  type: 'array',
23174
23396
  },
23175
- user_identifier_key: { type: 'string' },
23397
+ user_identifier_key: {
23398
+ description: 'Your user ID for the user that you want to associate with the client session.',
23399
+ type: 'string',
23400
+ },
23176
23401
  user_identity_ids: {
23402
+ 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.',
23177
23403
  items: { type: 'string' },
23178
23404
  type: 'array',
23179
23405
  },
@@ -23213,25 +23439,36 @@ export default {
23213
23439
  tags: ['/client_sessions'],
23214
23440
  'x-fern-ignore': true,
23215
23441
  'x-response-key': null,
23442
+ 'x-title': 'Grant Access to a Client Session',
23216
23443
  },
23217
23444
  post: {
23445
+ 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.',
23218
23446
  operationId: 'clientSessionsGrantAccessPost',
23219
23447
  requestBody: {
23220
23448
  content: {
23221
23449
  'application/json': {
23222
23450
  schema: {
23223
23451
  properties: {
23224
- client_session_id: { type: 'string' },
23452
+ client_session_id: {
23453
+ description: 'ID of the client session to which you want to grant access to resources.',
23454
+ type: 'string',
23455
+ },
23225
23456
  connect_webview_ids: {
23457
+ description: 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
23226
23458
  items: { type: 'string' },
23227
23459
  type: 'array',
23228
23460
  },
23229
23461
  connected_account_ids: {
23462
+ description: 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
23230
23463
  items: { type: 'string' },
23231
23464
  type: 'array',
23232
23465
  },
23233
- user_identifier_key: { type: 'string' },
23466
+ user_identifier_key: {
23467
+ description: 'Your user ID for the user that you want to associate with the client session.',
23468
+ type: 'string',
23469
+ },
23234
23470
  user_identity_ids: {
23471
+ 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.',
23235
23472
  items: { type: 'string' },
23236
23473
  type: 'array',
23237
23474
  },
@@ -23272,21 +23509,38 @@ export default {
23272
23509
  'x-fern-sdk-group-name': ['client_sessions'],
23273
23510
  'x-fern-sdk-method-name': 'grant_access',
23274
23511
  'x-response-key': null,
23512
+ 'x-title': 'Grant Access to a Client Session',
23275
23513
  },
23276
23514
  },
23277
23515
  '/client_sessions/list': {
23278
23516
  post: {
23517
+ description: 'Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
23279
23518
  operationId: 'clientSessionsListPost',
23280
23519
  requestBody: {
23281
23520
  content: {
23282
23521
  'application/json': {
23283
23522
  schema: {
23284
23523
  properties: {
23285
- client_session_id: { type: 'string' },
23286
- connect_webview_id: { type: 'string' },
23287
- user_identifier_key: { type: 'string' },
23288
- user_identity_id: { type: 'string' },
23289
- without_user_identifier_key: { type: 'boolean' },
23524
+ client_session_id: {
23525
+ description: 'ID of the client session that you want to retrieve.',
23526
+ type: 'string',
23527
+ },
23528
+ connect_webview_id: {
23529
+ description: 'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
23530
+ type: 'string',
23531
+ },
23532
+ user_identifier_key: {
23533
+ description: 'Your user ID for the user by which you want to filter client sessions.',
23534
+ type: 'string',
23535
+ },
23536
+ user_identity_id: {
23537
+ 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.',
23538
+ type: 'string',
23539
+ },
23540
+ without_user_identifier_key: {
23541
+ description: 'Indicates whether to retrieve only client sessions without associated user identifier keys.',
23542
+ type: 'boolean',
23543
+ },
23290
23544
  },
23291
23545
  type: 'object',
23292
23546
  },
@@ -23326,17 +23580,23 @@ export default {
23326
23580
  'x-fern-sdk-method-name': 'list',
23327
23581
  'x-fern-sdk-return-value': 'client_sessions',
23328
23582
  'x-response-key': 'client_sessions',
23583
+ 'x-title': 'List Client Sessions',
23329
23584
  },
23330
23585
  },
23331
23586
  '/client_sessions/revoke': {
23332
23587
  post: {
23588
+ 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.',
23333
23589
  operationId: 'clientSessionsRevokePost',
23334
23590
  requestBody: {
23335
23591
  content: {
23336
23592
  'application/json': {
23337
23593
  schema: {
23338
23594
  properties: {
23339
- client_session_id: { format: 'uuid', type: 'string' },
23595
+ client_session_id: {
23596
+ description: 'ID of the client session that you want to revoke.',
23597
+ format: 'uuid',
23598
+ type: 'string',
23599
+ },
23340
23600
  },
23341
23601
  required: ['client_session_id'],
23342
23602
  type: 'object',
@@ -23370,10 +23630,12 @@ export default {
23370
23630
  'x-fern-sdk-group-name': ['client_sessions'],
23371
23631
  'x-fern-sdk-method-name': 'revoke',
23372
23632
  'x-response-key': null,
23633
+ 'x-title': 'Revoke a Client Session',
23373
23634
  },
23374
23635
  },
23375
23636
  '/connect_webviews/create': {
23376
23637
  post: {
23638
+ 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).',
23377
23639
  operationId: 'connectWebviewsCreatePost',
23378
23640
  requestBody: {
23379
23641
  content: {
@@ -23381,6 +23643,7 @@ export default {
23381
23643
  schema: {
23382
23644
  properties: {
23383
23645
  accepted_providers: {
23646
+ 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.',
23384
23647
  items: {
23385
23648
  enum: [
23386
23649
  'dormakaba_community',
@@ -23440,6 +23703,7 @@ export default {
23440
23703
  },
23441
23704
  automatically_manage_new_devices: {
23442
23705
  default: true,
23706
+ 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).',
23443
23707
  type: 'boolean',
23444
23708
  },
23445
23709
  custom_metadata: {
@@ -23450,15 +23714,24 @@ export default {
23450
23714
  { type: 'boolean' },
23451
23715
  ],
23452
23716
  },
23717
+ 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).',
23453
23718
  type: 'object',
23454
23719
  },
23455
- custom_redirect_failure_url: { type: 'string' },
23456
- custom_redirect_url: { type: 'string' },
23720
+ custom_redirect_failure_url: {
23721
+ 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`.',
23722
+ type: 'string',
23723
+ },
23724
+ custom_redirect_url: {
23725
+ description: 'URL that you want to redirect the user to after the provider login is complete.',
23726
+ type: 'string',
23727
+ },
23457
23728
  device_selection_mode: {
23458
23729
  enum: ['none', 'single', 'multiple'],
23459
23730
  type: 'string',
23731
+ 'x-undocumented': 'Not supported.',
23460
23732
  },
23461
23733
  provider_category: {
23734
+ 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.',
23462
23735
  enum: [
23463
23736
  'stable',
23464
23737
  'consumer_smartlocks',
@@ -23469,7 +23742,11 @@ export default {
23469
23742
  ],
23470
23743
  type: 'string',
23471
23744
  },
23472
- wait_for_device_creation: { default: false, type: 'boolean' },
23745
+ wait_for_device_creation: {
23746
+ default: false,
23747
+ 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).',
23748
+ type: 'boolean',
23749
+ },
23473
23750
  },
23474
23751
  type: 'object',
23475
23752
  },
@@ -23509,17 +23786,23 @@ export default {
23509
23786
  'x-fern-sdk-method-name': 'create',
23510
23787
  'x-fern-sdk-return-value': 'connect_webview',
23511
23788
  'x-response-key': 'connect_webview',
23789
+ 'x-title': 'Create a Connect Webview',
23512
23790
  },
23513
23791
  },
23514
23792
  '/connect_webviews/delete': {
23515
23793
  post: {
23794
+ 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.',
23516
23795
  operationId: 'connectWebviewsDeletePost',
23517
23796
  requestBody: {
23518
23797
  content: {
23519
23798
  'application/json': {
23520
23799
  schema: {
23521
23800
  properties: {
23522
- connect_webview_id: { format: 'uuid', type: 'string' },
23801
+ connect_webview_id: {
23802
+ description: 'ID of the Connect Webview that you want to delete.',
23803
+ format: 'uuid',
23804
+ type: 'string',
23805
+ },
23523
23806
  },
23524
23807
  required: ['connect_webview_id'],
23525
23808
  type: 'object',
@@ -23553,17 +23836,23 @@ export default {
23553
23836
  'x-fern-sdk-group-name': ['connect_webviews'],
23554
23837
  'x-fern-sdk-method-name': 'delete',
23555
23838
  'x-response-key': null,
23839
+ 'x-title': 'Delete a Connect Webview',
23556
23840
  },
23557
23841
  },
23558
23842
  '/connect_webviews/get': {
23559
23843
  post: {
23844
+ 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.",
23560
23845
  operationId: 'connectWebviewsGetPost',
23561
23846
  requestBody: {
23562
23847
  content: {
23563
23848
  'application/json': {
23564
23849
  schema: {
23565
23850
  properties: {
23566
- connect_webview_id: { format: 'uuid', type: 'string' },
23851
+ connect_webview_id: {
23852
+ description: 'ID of the Connect Webview that you want to get.',
23853
+ format: 'uuid',
23854
+ type: 'string',
23855
+ },
23567
23856
  },
23568
23857
  required: ['connect_webview_id'],
23569
23858
  type: 'object',
@@ -23604,10 +23893,12 @@ export default {
23604
23893
  'x-fern-sdk-method-name': 'get',
23605
23894
  'x-fern-sdk-return-value': 'connect_webview',
23606
23895
  'x-response-key': 'connect_webview',
23896
+ 'x-title': 'Get a Connect Webview',
23607
23897
  },
23608
23898
  },
23609
23899
  '/connect_webviews/list': {
23610
23900
  post: {
23901
+ description: 'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
23611
23902
  operationId: 'connectWebviewsListPost',
23612
23903
  requestBody: {
23613
23904
  content: {
@@ -23618,12 +23909,17 @@ export default {
23618
23909
  additionalProperties: {
23619
23910
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
23620
23911
  },
23621
- description: 'Returns webviews whose custom_metadata contains all of the provided key/value pairs.',
23912
+ 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.',
23622
23913
  type: 'object',
23623
23914
  },
23624
- limit: { default: 500, format: 'float', type: 'number' },
23915
+ limit: {
23916
+ default: 500,
23917
+ description: 'Maximum number of records to return per page.',
23918
+ format: 'float',
23919
+ type: 'number',
23920
+ },
23625
23921
  user_identifier_key: {
23626
- description: 'Returns webviews that can be accessed by the provided user_identifier_key.',
23922
+ description: 'Your user ID for the user by which you want to filter Connect Webviews.',
23627
23923
  type: 'string',
23628
23924
  },
23629
23925
  },
@@ -23666,18 +23962,28 @@ export default {
23666
23962
  'x-fern-sdk-method-name': 'list',
23667
23963
  'x-fern-sdk-return-value': 'connect_webviews',
23668
23964
  'x-response-key': 'connect_webviews',
23965
+ 'x-title': 'List Connect Webviews',
23669
23966
  },
23670
23967
  },
23671
23968
  '/connected_accounts/delete': {
23672
23969
  post: {
23970
+ 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.',
23673
23971
  operationId: 'connectedAccountsDeletePost',
23674
23972
  requestBody: {
23675
23973
  content: {
23676
23974
  'application/json': {
23677
23975
  schema: {
23678
23976
  properties: {
23679
- connected_account_id: { format: 'uuid', type: 'string' },
23680
- sync: { default: false, type: 'boolean' },
23977
+ connected_account_id: {
23978
+ description: 'ID of the connected account that you want to delete.',
23979
+ format: 'uuid',
23980
+ type: 'string',
23981
+ },
23982
+ sync: {
23983
+ default: false,
23984
+ type: 'boolean',
23985
+ 'x-undocumented': 'Only used internally.',
23986
+ },
23681
23987
  },
23682
23988
  required: ['connected_account_id'],
23683
23989
  type: 'object',
@@ -23716,6 +24022,7 @@ export default {
23716
24022
  },
23717
24023
  '/connected_accounts/get': {
23718
24024
  post: {
24025
+ description: 'Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
23719
24026
  operationId: 'connectedAccountsGetPost',
23720
24027
  requestBody: {
23721
24028
  content: {
@@ -23724,13 +24031,23 @@ export default {
23724
24031
  oneOf: [
23725
24032
  {
23726
24033
  properties: {
23727
- connected_account_id: { format: 'uuid', type: 'string' },
24034
+ connected_account_id: {
24035
+ description: 'ID of the connected account that you want to get.',
24036
+ format: 'uuid',
24037
+ type: 'string',
24038
+ },
23728
24039
  },
23729
24040
  required: ['connected_account_id'],
23730
24041
  type: 'object',
23731
24042
  },
23732
24043
  {
23733
- properties: { email: { format: 'email', type: 'string' } },
24044
+ properties: {
24045
+ email: {
24046
+ description: 'Email address associated with the connected account that you want to get.',
24047
+ format: 'email',
24048
+ type: 'string',
24049
+ },
24050
+ },
23734
24051
  required: ['email'],
23735
24052
  type: 'object',
23736
24053
  },
@@ -23777,6 +24094,7 @@ export default {
23777
24094
  },
23778
24095
  '/connected_accounts/list': {
23779
24096
  post: {
24097
+ description: 'Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).',
23780
24098
  operationId: 'connectedAccountsListPost',
23781
24099
  requestBody: {
23782
24100
  content: {
@@ -23787,7 +24105,7 @@ export default {
23787
24105
  additionalProperties: {
23788
24106
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
23789
24107
  },
23790
- description: 'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
24108
+ 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.',
23791
24109
  type: 'object',
23792
24110
  },
23793
24111
  customer_ids: {
@@ -23807,7 +24125,7 @@ export default {
23807
24125
  type: 'string',
23808
24126
  },
23809
24127
  user_identifier_key: {
23810
- description: 'Returns accounts that can be accessed by the provided user_identifier_key.',
24128
+ description: 'Your user ID for the user by which you want to filter connected accounts.',
23811
24129
  type: 'string',
23812
24130
  },
23813
24131
  },
@@ -23855,14 +24173,22 @@ export default {
23855
24173
  },
23856
24174
  '/connected_accounts/update': {
23857
24175
  post: {
24176
+ description: 'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
23858
24177
  operationId: 'connectedAccountsUpdatePost',
23859
24178
  requestBody: {
23860
24179
  content: {
23861
24180
  'application/json': {
23862
24181
  schema: {
23863
24182
  properties: {
23864
- automatically_manage_new_devices: { type: 'boolean' },
23865
- connected_account_id: { format: 'uuid', type: 'string' },
24183
+ automatically_manage_new_devices: {
24184
+ description: 'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
24185
+ type: 'boolean',
24186
+ },
24187
+ connected_account_id: {
24188
+ description: 'ID of the connected account that you want to update.',
24189
+ format: 'uuid',
24190
+ type: 'string',
24191
+ },
23866
24192
  custom_metadata: {
23867
24193
  additionalProperties: {
23868
24194
  nullable: true,
@@ -23871,6 +24197,7 @@ export default {
23871
24197
  { type: 'boolean' },
23872
24198
  ],
23873
24199
  },
24200
+ 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).',
23874
24201
  type: 'object',
23875
24202
  },
23876
24203
  },
@@ -23916,12 +24243,19 @@ export default {
23916
24243
  },
23917
24244
  '/devices/delete': {
23918
24245
  post: {
24246
+ description: 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
23919
24247
  operationId: 'devicesDeletePost',
23920
24248
  requestBody: {
23921
24249
  content: {
23922
24250
  'application/json': {
23923
24251
  schema: {
23924
- properties: { device_id: { format: 'uuid', type: 'string' } },
24252
+ properties: {
24253
+ device_id: {
24254
+ description: 'ID of the device that you want to delete.',
24255
+ format: 'uuid',
24256
+ type: 'string',
24257
+ },
24258
+ },
23925
24259
  required: ['device_id'],
23926
24260
  type: 'object',
23927
24261
  },
@@ -23955,19 +24289,28 @@ export default {
23955
24289
  'x-fern-sdk-group-name': ['devices'],
23956
24290
  'x-fern-sdk-method-name': 'delete',
23957
24291
  'x-response-key': null,
24292
+ 'x-title': 'Delete a Device',
23958
24293
  'x-undocumented': 'Deleting a device is no longer supported and will be removed.',
23959
24294
  },
23960
24295
  },
23961
24296
  '/devices/get': {
23962
24297
  post: {
24298
+ description: 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
23963
24299
  operationId: 'devicesGetPost',
23964
24300
  requestBody: {
23965
24301
  content: {
23966
24302
  'application/json': {
23967
24303
  schema: {
23968
24304
  properties: {
23969
- device_id: { format: 'uuid', type: 'string' },
23970
- name: { type: 'string' },
24305
+ device_id: {
24306
+ description: 'ID of the device that you want to get.',
24307
+ format: 'uuid',
24308
+ type: 'string',
24309
+ },
24310
+ name: {
24311
+ description: 'Name of the device that you want to get.',
24312
+ type: 'string',
24313
+ },
23971
24314
  },
23972
24315
  type: 'object',
23973
24316
  },
@@ -24005,6 +24348,7 @@ export default {
24005
24348
  'x-fern-sdk-method-name': 'get',
24006
24349
  'x-fern-sdk-return-value': 'device',
24007
24350
  'x-response-key': 'device',
24351
+ 'x-title': 'Get a Device',
24008
24352
  },
24009
24353
  },
24010
24354
  '/devices/list': {
@@ -24017,22 +24361,22 @@ export default {
24017
24361
  schema: {
24018
24362
  properties: {
24019
24363
  connect_webview_id: {
24020
- description: 'ID of the Connect Webview by which to filter devices.',
24364
+ description: 'ID of the Connect Webview for which you want to list devices.',
24021
24365
  format: 'uuid',
24022
24366
  type: 'string',
24023
24367
  },
24024
24368
  connected_account_id: {
24025
- description: 'ID of the connected account by which to filter.',
24369
+ description: 'ID of the connected account for which you want to list devices.',
24026
24370
  format: 'uuid',
24027
24371
  type: 'string',
24028
24372
  },
24029
24373
  connected_account_ids: {
24030
- description: 'Array of IDs of the connected accounts by which to filter devices.',
24374
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
24031
24375
  items: { format: 'uuid', type: 'string' },
24032
24376
  type: 'array',
24033
24377
  },
24034
24378
  created_before: {
24035
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
24379
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
24036
24380
  format: 'date-time',
24037
24381
  type: 'string',
24038
24382
  },
@@ -24040,7 +24384,7 @@ export default {
24040
24384
  additionalProperties: {
24041
24385
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
24042
24386
  },
24043
- 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.',
24387
+ 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.',
24044
24388
  type: 'object',
24045
24389
  },
24046
24390
  customer_ids: {
@@ -24048,12 +24392,12 @@ export default {
24048
24392
  type: 'array',
24049
24393
  },
24050
24394
  device_ids: {
24051
- description: 'Array of device IDs by which to filter devices.',
24395
+ description: 'Array of device IDs for which you want to list devices.',
24052
24396
  items: { format: 'uuid', type: 'string' },
24053
24397
  type: 'array',
24054
24398
  },
24055
24399
  device_type: {
24056
- description: 'Device type by which to filter devices.',
24400
+ description: 'Device type for which you want to list devices.',
24057
24401
  oneOf: [
24058
24402
  {
24059
24403
  enum: [
@@ -24110,7 +24454,7 @@ export default {
24110
24454
  ],
24111
24455
  },
24112
24456
  device_types: {
24113
- description: 'Array of device types by which to filter devices.',
24457
+ description: 'Array of device types for which you want to list devices.',
24114
24458
  items: {
24115
24459
  oneOf: [
24116
24460
  {
@@ -24216,7 +24560,7 @@ export default {
24216
24560
  type: 'number',
24217
24561
  },
24218
24562
  manufacturer: {
24219
- description: 'Manufacturer by which to filter devices.',
24563
+ description: 'Manufacturer for which you want to list devices.',
24220
24564
  enum: [
24221
24565
  'akuvox',
24222
24566
  'august',
@@ -24265,13 +24609,14 @@ export default {
24265
24609
  type: 'string',
24266
24610
  },
24267
24611
  unstable_location_id: {
24612
+ description: 'ID of the location for which you want to list devices.',
24268
24613
  format: 'uuid',
24269
24614
  nullable: true,
24270
24615
  type: 'string',
24271
24616
  'x-undocumented': 'Experimental locations.',
24272
24617
  },
24273
24618
  user_identifier_key: {
24274
- description: 'Your own internal user ID for the user by which to filter devices.',
24619
+ description: 'Your own internal user ID for the user for which you want to list devices.',
24275
24620
  type: 'string',
24276
24621
  },
24277
24622
  },
@@ -24320,6 +24665,7 @@ export default {
24320
24665
  },
24321
24666
  '/devices/list_device_providers': {
24322
24667
  post: {
24668
+ 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).',
24323
24669
  operationId: 'devicesListDeviceProvidersPost',
24324
24670
  requestBody: {
24325
24671
  content: {
@@ -24327,6 +24673,7 @@ export default {
24327
24673
  schema: {
24328
24674
  properties: {
24329
24675
  provider_category: {
24676
+ description: 'Category for which you want to list providers.',
24330
24677
  enum: [
24331
24678
  'stable',
24332
24679
  'consumer_smartlocks',
@@ -24376,16 +24723,24 @@ export default {
24376
24723
  'x-fern-sdk-method-name': 'list_device_providers',
24377
24724
  'x-fern-sdk-return-value': 'device_providers',
24378
24725
  'x-response-key': 'device_providers',
24726
+ 'x-title': 'List Device Providers',
24379
24727
  },
24380
24728
  },
24381
24729
  '/devices/simulate/connect': {
24382
24730
  post: {
24731
+ 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).',
24383
24732
  operationId: 'devicesSimulateConnectPost',
24384
24733
  requestBody: {
24385
24734
  content: {
24386
24735
  'application/json': {
24387
24736
  schema: {
24388
- properties: { device_id: { format: 'uuid', type: 'string' } },
24737
+ properties: {
24738
+ device_id: {
24739
+ description: 'ID of the device that you want to simulate connecting to Seam.',
24740
+ format: 'uuid',
24741
+ type: 'string',
24742
+ },
24743
+ },
24389
24744
  required: ['device_id'],
24390
24745
  type: 'object',
24391
24746
  },
@@ -24418,16 +24773,24 @@ export default {
24418
24773
  'x-fern-sdk-group-name': ['devices', 'simulate'],
24419
24774
  'x-fern-sdk-method-name': 'connect',
24420
24775
  'x-response-key': null,
24776
+ 'x-title': 'Simulate Device Connection',
24421
24777
  },
24422
24778
  },
24423
24779
  '/devices/simulate/disconnect': {
24424
24780
  post: {
24781
+ 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).',
24425
24782
  operationId: 'devicesSimulateDisconnectPost',
24426
24783
  requestBody: {
24427
24784
  content: {
24428
24785
  'application/json': {
24429
24786
  schema: {
24430
- properties: { device_id: { format: 'uuid', type: 'string' } },
24787
+ properties: {
24788
+ device_id: {
24789
+ description: 'ID of the device that you want to simulate disconnecting from Seam.',
24790
+ format: 'uuid',
24791
+ type: 'string',
24792
+ },
24793
+ },
24431
24794
  required: ['device_id'],
24432
24795
  type: 'object',
24433
24796
  },
@@ -24460,16 +24823,24 @@ export default {
24460
24823
  'x-fern-sdk-group-name': ['devices', 'simulate'],
24461
24824
  'x-fern-sdk-method-name': 'disconnect',
24462
24825
  'x-response-key': null,
24826
+ 'x-title': 'Simulate Device Disconnection',
24463
24827
  },
24464
24828
  },
24465
24829
  '/devices/simulate/remove': {
24466
24830
  post: {
24831
+ 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).',
24467
24832
  operationId: 'devicesSimulateRemovePost',
24468
24833
  requestBody: {
24469
24834
  content: {
24470
24835
  'application/json': {
24471
24836
  schema: {
24472
- properties: { device_id: { format: 'uuid', type: 'string' } },
24837
+ properties: {
24838
+ device_id: {
24839
+ description: 'ID of the device that you want to simulate removing from Seam.',
24840
+ format: 'uuid',
24841
+ type: 'string',
24842
+ },
24843
+ },
24473
24844
  required: ['device_id'],
24474
24845
  type: 'object',
24475
24846
  },
@@ -24502,18 +24873,27 @@ export default {
24502
24873
  'x-fern-sdk-group-name': ['devices', 'simulate'],
24503
24874
  'x-fern-sdk-method-name': 'remove',
24504
24875
  'x-response-key': null,
24876
+ 'x-title': 'Simulate Device Removal',
24505
24877
  },
24506
24878
  },
24507
24879
  '/devices/unmanaged/get': {
24508
24880
  post: {
24881
+ 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`.',
24509
24882
  operationId: 'devicesUnmanagedGetPost',
24510
24883
  requestBody: {
24511
24884
  content: {
24512
24885
  'application/json': {
24513
24886
  schema: {
24514
24887
  properties: {
24515
- device_id: { format: 'uuid', type: 'string' },
24516
- name: { type: 'string' },
24888
+ device_id: {
24889
+ description: 'ID of the unmanaged device that you want to get.',
24890
+ format: 'uuid',
24891
+ type: 'string',
24892
+ },
24893
+ name: {
24894
+ description: 'Name of the unmanaged device that you want to get.',
24895
+ type: 'string',
24896
+ },
24517
24897
  },
24518
24898
  type: 'object',
24519
24899
  },
@@ -24551,10 +24931,12 @@ export default {
24551
24931
  'x-fern-sdk-method-name': 'get',
24552
24932
  'x-fern-sdk-return-value': 'device',
24553
24933
  'x-response-key': 'device',
24934
+ 'x-title': 'Get an Unmanaged Device',
24554
24935
  },
24555
24936
  },
24556
24937
  '/devices/unmanaged/list': {
24557
24938
  post: {
24939
+ 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).',
24558
24940
  operationId: 'devicesUnmanagedListPost',
24559
24941
  requestBody: {
24560
24942
  content: {
@@ -24562,22 +24944,22 @@ export default {
24562
24944
  schema: {
24563
24945
  properties: {
24564
24946
  connect_webview_id: {
24565
- description: 'ID of the Connect Webview by which to filter devices.',
24947
+ description: 'ID of the Connect Webview for which you want to list devices.',
24566
24948
  format: 'uuid',
24567
24949
  type: 'string',
24568
24950
  },
24569
24951
  connected_account_id: {
24570
- description: 'ID of the connected account by which to filter.',
24952
+ description: 'ID of the connected account for which you want to list devices.',
24571
24953
  format: 'uuid',
24572
24954
  type: 'string',
24573
24955
  },
24574
24956
  connected_account_ids: {
24575
- description: 'Array of IDs of the connected accounts by which to filter devices.',
24957
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
24576
24958
  items: { format: 'uuid', type: 'string' },
24577
24959
  type: 'array',
24578
24960
  },
24579
24961
  created_before: {
24580
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
24962
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
24581
24963
  format: 'date-time',
24582
24964
  type: 'string',
24583
24965
  },
@@ -24585,7 +24967,7 @@ export default {
24585
24967
  additionalProperties: {
24586
24968
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
24587
24969
  },
24588
- 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.',
24970
+ 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.',
24589
24971
  type: 'object',
24590
24972
  },
24591
24973
  customer_ids: {
@@ -24593,12 +24975,12 @@ export default {
24593
24975
  type: 'array',
24594
24976
  },
24595
24977
  device_ids: {
24596
- description: 'Array of device IDs by which to filter devices.',
24978
+ description: 'Array of device IDs for which you want to list devices.',
24597
24979
  items: { format: 'uuid', type: 'string' },
24598
24980
  type: 'array',
24599
24981
  },
24600
24982
  device_type: {
24601
- description: 'Device type by which to filter devices.',
24983
+ description: 'Device type for which you want to list devices.',
24602
24984
  oneOf: [
24603
24985
  {
24604
24986
  enum: [
@@ -24655,7 +25037,7 @@ export default {
24655
25037
  ],
24656
25038
  },
24657
25039
  device_types: {
24658
- description: 'Array of device types by which to filter devices.',
25040
+ description: 'Array of device types for which you want to list devices.',
24659
25041
  items: {
24660
25042
  oneOf: [
24661
25043
  {
@@ -24761,7 +25143,7 @@ export default {
24761
25143
  type: 'number',
24762
25144
  },
24763
25145
  manufacturer: {
24764
- description: 'Manufacturer by which to filter devices.',
25146
+ description: 'Manufacturer for which you want to list devices.',
24765
25147
  enum: [
24766
25148
  'akuvox',
24767
25149
  'august',
@@ -24810,13 +25192,14 @@ export default {
24810
25192
  type: 'string',
24811
25193
  },
24812
25194
  unstable_location_id: {
25195
+ description: 'ID of the location for which you want to list devices.',
24813
25196
  format: 'uuid',
24814
25197
  nullable: true,
24815
25198
  type: 'string',
24816
25199
  'x-undocumented': 'Experimental locations.',
24817
25200
  },
24818
25201
  user_identifier_key: {
24819
- description: 'Your own internal user ID for the user by which to filter devices.',
25202
+ description: 'Your own internal user ID for the user for which you want to list devices.',
24820
25203
  type: 'string',
24821
25204
  },
24822
25205
  },
@@ -24858,18 +25241,28 @@ export default {
24858
25241
  'x-fern-sdk-method-name': 'list',
24859
25242
  'x-fern-sdk-return-value': 'devices',
24860
25243
  'x-response-key': 'devices',
25244
+ 'x-title': 'List Unmanaged Devices',
24861
25245
  },
24862
25246
  },
24863
25247
  '/devices/unmanaged/update': {
24864
25248
  patch: {
25249
+ 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).',
24865
25250
  operationId: 'devicesUnmanagedUpdatePatch',
24866
25251
  requestBody: {
24867
25252
  content: {
24868
25253
  'application/json': {
24869
25254
  schema: {
24870
25255
  properties: {
24871
- device_id: { format: 'uuid', type: 'string' },
24872
- is_managed: { enum: [true], type: 'boolean' },
25256
+ device_id: {
25257
+ description: 'ID of the unmanaged device that you want to update.',
25258
+ format: 'uuid',
25259
+ type: 'string',
25260
+ },
25261
+ is_managed: {
25262
+ description: 'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
25263
+ enum: [true],
25264
+ type: 'boolean',
25265
+ },
24873
25266
  },
24874
25267
  required: ['device_id', 'is_managed'],
24875
25268
  type: 'object',
@@ -24902,16 +25295,26 @@ export default {
24902
25295
  tags: ['/devices'],
24903
25296
  'x-fern-ignore': true,
24904
25297
  'x-response-key': null,
25298
+ 'x-title': 'Update an Unmanaged Device',
24905
25299
  },
24906
25300
  post: {
25301
+ 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).',
24907
25302
  operationId: 'devicesUnmanagedUpdatePost',
24908
25303
  requestBody: {
24909
25304
  content: {
24910
25305
  'application/json': {
24911
25306
  schema: {
24912
25307
  properties: {
24913
- device_id: { format: 'uuid', type: 'string' },
24914
- is_managed: { enum: [true], type: 'boolean' },
25308
+ device_id: {
25309
+ description: 'ID of the unmanaged device that you want to update.',
25310
+ format: 'uuid',
25311
+ type: 'string',
25312
+ },
25313
+ is_managed: {
25314
+ description: 'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
25315
+ enum: [true],
25316
+ type: 'boolean',
25317
+ },
24915
25318
  },
24916
25319
  required: ['device_id', 'is_managed'],
24917
25320
  type: 'object',
@@ -24945,10 +25348,12 @@ export default {
24945
25348
  'x-fern-sdk-group-name': ['devices', 'unmanaged'],
24946
25349
  'x-fern-sdk-method-name': 'update',
24947
25350
  'x-response-key': null,
25351
+ 'x-title': 'Update an Unmanaged Device',
24948
25352
  },
24949
25353
  },
24950
25354
  '/devices/update': {
24951
25355
  patch: {
25356
+ 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).",
24952
25357
  operationId: 'devicesUpdatePatch',
24953
25358
  requestBody: {
24954
25359
  content: {
@@ -24963,13 +25368,32 @@ export default {
24963
25368
  { type: 'boolean' },
24964
25369
  ],
24965
25370
  },
25371
+ 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).',
24966
25372
  type: 'object',
24967
25373
  },
24968
- device_id: { format: 'uuid', type: 'string' },
24969
- is_managed: { default: true, type: 'boolean' },
24970
- name: { nullable: true, type: 'string' },
25374
+ device_id: {
25375
+ description: 'ID of the device that you want to update.',
25376
+ format: 'uuid',
25377
+ type: 'string',
25378
+ },
25379
+ is_managed: {
25380
+ default: true,
25381
+ description: 'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
25382
+ type: 'boolean',
25383
+ },
25384
+ name: {
25385
+ description: 'Name for the device.',
25386
+ nullable: true,
25387
+ type: 'string',
25388
+ },
24971
25389
  properties: {
24972
- properties: { name: { nullable: true, type: 'string' } },
25390
+ properties: {
25391
+ name: {
25392
+ description: 'Name for the device.',
25393
+ nullable: true,
25394
+ type: 'string',
25395
+ },
25396
+ },
24973
25397
  type: 'object',
24974
25398
  },
24975
25399
  },
@@ -25005,8 +25429,10 @@ export default {
25005
25429
  tags: ['/devices'],
25006
25430
  'x-fern-ignore': true,
25007
25431
  'x-response-key': null,
25432
+ 'x-title': 'Update a Device',
25008
25433
  },
25009
25434
  post: {
25435
+ 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).",
25010
25436
  operationId: 'devicesUpdatePost',
25011
25437
  requestBody: {
25012
25438
  content: {
@@ -25021,13 +25447,32 @@ export default {
25021
25447
  { type: 'boolean' },
25022
25448
  ],
25023
25449
  },
25450
+ 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).',
25024
25451
  type: 'object',
25025
25452
  },
25026
- device_id: { format: 'uuid', type: 'string' },
25027
- is_managed: { default: true, type: 'boolean' },
25028
- name: { nullable: true, type: 'string' },
25453
+ device_id: {
25454
+ description: 'ID of the device that you want to update.',
25455
+ format: 'uuid',
25456
+ type: 'string',
25457
+ },
25458
+ is_managed: {
25459
+ default: true,
25460
+ description: 'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
25461
+ type: 'boolean',
25462
+ },
25463
+ name: {
25464
+ description: 'Name for the device.',
25465
+ nullable: true,
25466
+ type: 'string',
25467
+ },
25029
25468
  properties: {
25030
- properties: { name: { nullable: true, type: 'string' } },
25469
+ properties: {
25470
+ name: {
25471
+ description: 'Name for the device.',
25472
+ nullable: true,
25473
+ type: 'string',
25474
+ },
25475
+ },
25031
25476
  type: 'object',
25032
25477
  },
25033
25478
  },
@@ -25064,10 +25509,12 @@ export default {
25064
25509
  'x-fern-sdk-group-name': ['devices'],
25065
25510
  'x-fern-sdk-method-name': 'update',
25066
25511
  'x-response-key': null,
25512
+ 'x-title': 'Update a Device',
25067
25513
  },
25068
25514
  },
25069
25515
  '/events/get': {
25070
25516
  post: {
25517
+ 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.',
25071
25518
  operationId: 'eventsGetPost',
25072
25519
  requestBody: {
25073
25520
  content: {
@@ -25115,10 +25562,12 @@ export default {
25115
25562
  'x-fern-sdk-method-name': 'get',
25116
25563
  'x-fern-sdk-return-value': 'event',
25117
25564
  'x-response-key': 'event',
25565
+ 'x-title': 'Get an Event',
25118
25566
  },
25119
25567
  },
25120
25568
  '/events/list': {
25121
25569
  post: {
25570
+ 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.',
25122
25571
  operationId: 'eventsListPost',
25123
25572
  requestBody: {
25124
25573
  content: {
@@ -25393,6 +25842,7 @@ export default {
25393
25842
  'x-fern-sdk-method-name': 'list',
25394
25843
  'x-fern-sdk-return-value': 'events',
25395
25844
  'x-response-key': 'events',
25845
+ 'x-title': 'List Events',
25396
25846
  },
25397
25847
  },
25398
25848
  '/locks/get': {
@@ -25455,22 +25905,22 @@ export default {
25455
25905
  schema: {
25456
25906
  properties: {
25457
25907
  connect_webview_id: {
25458
- description: 'ID of the Connect Webview by which to filter devices.',
25908
+ description: 'ID of the Connect Webview for which you want to list devices.',
25459
25909
  format: 'uuid',
25460
25910
  type: 'string',
25461
25911
  },
25462
25912
  connected_account_id: {
25463
- description: 'ID of the connected account by which to filter.',
25913
+ description: 'ID of the connected account for which you want to list devices.',
25464
25914
  format: 'uuid',
25465
25915
  type: 'string',
25466
25916
  },
25467
25917
  connected_account_ids: {
25468
- description: 'Array of IDs of the connected accounts by which to filter devices.',
25918
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
25469
25919
  items: { format: 'uuid', type: 'string' },
25470
25920
  type: 'array',
25471
25921
  },
25472
25922
  created_before: {
25473
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
25923
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
25474
25924
  format: 'date-time',
25475
25925
  type: 'string',
25476
25926
  },
@@ -25478,7 +25928,7 @@ export default {
25478
25928
  additionalProperties: {
25479
25929
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
25480
25930
  },
25481
- 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.',
25931
+ 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.',
25482
25932
  type: 'object',
25483
25933
  },
25484
25934
  customer_ids: {
@@ -25486,7 +25936,7 @@ export default {
25486
25936
  type: 'array',
25487
25937
  },
25488
25938
  device_ids: {
25489
- description: 'Array of device IDs by which to filter devices.',
25939
+ description: 'Array of device IDs for which you want to list devices.',
25490
25940
  items: { format: 'uuid', type: 'string' },
25491
25941
  type: 'array',
25492
25942
  },
@@ -25644,13 +26094,14 @@ export default {
25644
26094
  type: 'string',
25645
26095
  },
25646
26096
  unstable_location_id: {
26097
+ description: 'ID of the location for which you want to list devices.',
25647
26098
  format: 'uuid',
25648
26099
  nullable: true,
25649
26100
  type: 'string',
25650
26101
  'x-undocumented': 'Experimental locations.',
25651
26102
  },
25652
26103
  user_identifier_key: {
25653
- description: 'Your own internal user ID for the user by which to filter devices.',
26104
+ description: 'Your own internal user ID for the user for which you want to list devices.',
25654
26105
  type: 'string',
25655
26106
  },
25656
26107
  },
@@ -26006,22 +26457,22 @@ export default {
26006
26457
  schema: {
26007
26458
  properties: {
26008
26459
  connect_webview_id: {
26009
- description: 'ID of the Connect Webview by which to filter devices.',
26460
+ description: 'ID of the Connect Webview for which you want to list devices.',
26010
26461
  format: 'uuid',
26011
26462
  type: 'string',
26012
26463
  },
26013
26464
  connected_account_id: {
26014
- description: 'ID of the connected account by which to filter.',
26465
+ description: 'ID of the connected account for which you want to list devices.',
26015
26466
  format: 'uuid',
26016
26467
  type: 'string',
26017
26468
  },
26018
26469
  connected_account_ids: {
26019
- description: 'Array of IDs of the connected accounts by which to filter devices.',
26470
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
26020
26471
  items: { format: 'uuid', type: 'string' },
26021
26472
  type: 'array',
26022
26473
  },
26023
26474
  created_before: {
26024
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
26475
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
26025
26476
  format: 'date-time',
26026
26477
  type: 'string',
26027
26478
  },
@@ -26029,7 +26480,7 @@ export default {
26029
26480
  additionalProperties: {
26030
26481
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
26031
26482
  },
26032
- 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.',
26483
+ 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.',
26033
26484
  type: 'object',
26034
26485
  },
26035
26486
  customer_ids: {
@@ -26037,7 +26488,7 @@ export default {
26037
26488
  type: 'array',
26038
26489
  },
26039
26490
  device_ids: {
26040
- description: 'Array of device IDs by which to filter devices.',
26491
+ description: 'Array of device IDs for which you want to list devices.',
26041
26492
  items: { format: 'uuid', type: 'string' },
26042
26493
  type: 'array',
26043
26494
  },
@@ -26111,13 +26562,14 @@ export default {
26111
26562
  type: 'string',
26112
26563
  },
26113
26564
  unstable_location_id: {
26565
+ description: 'ID of the location for which you want to list devices.',
26114
26566
  format: 'uuid',
26115
26567
  nullable: true,
26116
26568
  type: 'string',
26117
26569
  'x-undocumented': 'Experimental locations.',
26118
26570
  },
26119
26571
  user_identifier_key: {
26120
- description: 'Your own internal user ID for the user by which to filter devices.',
26572
+ description: 'Your own internal user ID for the user for which you want to list devices.',
26121
26573
  type: 'string',
26122
26574
  },
26123
26575
  },
@@ -28899,22 +29351,22 @@ export default {
28899
29351
  schema: {
28900
29352
  properties: {
28901
29353
  connect_webview_id: {
28902
- description: 'ID of the Connect Webview by which to filter devices.',
29354
+ description: 'ID of the Connect Webview for which you want to list devices.',
28903
29355
  format: 'uuid',
28904
29356
  type: 'string',
28905
29357
  },
28906
29358
  connected_account_id: {
28907
- description: 'ID of the connected account by which to filter.',
29359
+ description: 'ID of the connected account for which you want to list devices.',
28908
29360
  format: 'uuid',
28909
29361
  type: 'string',
28910
29362
  },
28911
29363
  connected_account_ids: {
28912
- description: 'Array of IDs of the connected accounts by which to filter devices.',
29364
+ description: 'Array of IDs of the connected accounts for which you want to list devices.',
28913
29365
  items: { format: 'uuid', type: 'string' },
28914
29366
  type: 'array',
28915
29367
  },
28916
29368
  created_before: {
28917
- description: 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
29369
+ description: 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
28918
29370
  format: 'date-time',
28919
29371
  type: 'string',
28920
29372
  },
@@ -28922,7 +29374,7 @@ export default {
28922
29374
  additionalProperties: {
28923
29375
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
28924
29376
  },
28925
- 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.',
29377
+ 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.',
28926
29378
  type: 'object',
28927
29379
  },
28928
29380
  customer_ids: {
@@ -28930,7 +29382,7 @@ export default {
28930
29382
  type: 'array',
28931
29383
  },
28932
29384
  device_ids: {
28933
- description: 'Array of device IDs by which to filter devices.',
29385
+ description: 'Array of device IDs for which you want to list devices.',
28934
29386
  items: { format: 'uuid', type: 'string' },
28935
29387
  type: 'array',
28936
29388
  },
@@ -29024,13 +29476,14 @@ export default {
29024
29476
  type: 'string',
29025
29477
  },
29026
29478
  unstable_location_id: {
29479
+ description: 'ID of the location for which you want to list devices.',
29027
29480
  format: 'uuid',
29028
29481
  nullable: true,
29029
29482
  type: 'string',
29030
29483
  'x-undocumented': 'Experimental locations.',
29031
29484
  },
29032
29485
  user_identifier_key: {
29033
- description: 'Your own internal user ID for the user by which to filter devices.',
29486
+ description: 'Your own internal user ID for the user for which you want to list devices.',
29034
29487
  type: 'string',
29035
29488
  },
29036
29489
  },
@@ -32169,6 +32622,101 @@ export default {
32169
32622
  'x-undocumented': 'Experimental locations.',
32170
32623
  },
32171
32624
  },
32625
+ '/unstable_partner/resources/push': {
32626
+ post: {
32627
+ description: 'Send Seam some of your resources.',
32628
+ operationId: 'unstablePartnerResourcesPushPost',
32629
+ requestBody: {
32630
+ content: {
32631
+ 'application/json': {
32632
+ schema: {
32633
+ oneOf: [
32634
+ {
32635
+ items: {
32636
+ properties: {
32637
+ custom_metadata: {
32638
+ additionalProperties: { type: 'string' },
32639
+ type: 'object',
32640
+ },
32641
+ customer_key: { type: 'string' },
32642
+ description: { type: 'string' },
32643
+ email_address: { type: 'string' },
32644
+ ends_at: { type: 'string' },
32645
+ icon_url: { type: 'string' },
32646
+ location_keys: {
32647
+ items: { type: 'string' },
32648
+ type: 'array',
32649
+ },
32650
+ name: { type: 'string' },
32651
+ partner_resource_key: { type: 'string' },
32652
+ partner_resource_type: { type: 'string' },
32653
+ phone_number: { type: 'string' },
32654
+ starts_at: { type: 'string' },
32655
+ user_identity_key: { type: 'string' },
32656
+ },
32657
+ type: 'object',
32658
+ },
32659
+ type: 'array',
32660
+ },
32661
+ {
32662
+ properties: {
32663
+ custom_metadata: {
32664
+ additionalProperties: { type: 'string' },
32665
+ type: 'object',
32666
+ },
32667
+ customer_key: { type: 'string' },
32668
+ description: { type: 'string' },
32669
+ email_address: { type: 'string' },
32670
+ ends_at: { type: 'string' },
32671
+ icon_url: { type: 'string' },
32672
+ location_keys: {
32673
+ items: { type: 'string' },
32674
+ type: 'array',
32675
+ },
32676
+ name: { type: 'string' },
32677
+ partner_resource_key: { type: 'string' },
32678
+ partner_resource_type: { type: 'string' },
32679
+ phone_number: { type: 'string' },
32680
+ starts_at: { type: 'string' },
32681
+ user_identity_key: { type: 'string' },
32682
+ },
32683
+ type: 'object',
32684
+ },
32685
+ ],
32686
+ },
32687
+ },
32688
+ },
32689
+ },
32690
+ responses: {
32691
+ 200: {
32692
+ content: {
32693
+ 'application/json': {
32694
+ schema: {
32695
+ properties: { ok: { type: 'boolean' } },
32696
+ required: ['ok'],
32697
+ type: 'object',
32698
+ },
32699
+ },
32700
+ },
32701
+ description: 'OK',
32702
+ },
32703
+ 400: { description: 'Bad Request' },
32704
+ 401: { description: 'Unauthorized' },
32705
+ },
32706
+ security: [
32707
+ { pat_with_workspace: [] },
32708
+ { console_session_with_workspace: [] },
32709
+ { api_key: [] },
32710
+ ],
32711
+ summary: '/unstable_partner/resources/push',
32712
+ tags: [],
32713
+ 'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
32714
+ 'x-fern-sdk-method-name': 'push',
32715
+ 'x-response-key': null,
32716
+ 'x-title': 'Push partner resources at Seam',
32717
+ 'x-undocumented': 'Experimental partner resources.',
32718
+ },
32719
+ },
32172
32720
  '/user_identities/add_acs_user': {
32173
32721
  post: {
32174
32722
  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).',
@@ -32356,7 +32904,7 @@ export default {
32356
32904
  },
32357
32905
  '/user_identities/delete': {
32358
32906
  post: {
32359
- 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.',
32907
+ 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.',
32360
32908
  operationId: 'userIdentitiesDeletePost',
32361
32909
  requestBody: {
32362
32910
  content: {
@@ -33922,6 +34470,7 @@ export default {
33922
34470
  },
33923
34471
  '/workspaces/reset_sandbox': {
33924
34472
  post: {
34473
+ 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.',
33925
34474
  operationId: 'workspacesResetSandboxPost',
33926
34475
  responses: {
33927
34476
  200: {