@seamapi/types 1.398.0 → 1.399.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/connect.cjs +886 -294
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +848 -177
  4. package/lib/seam/connect/models/access-codes/managed-access-code.js +8 -2
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +4 -0
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  8. package/lib/seam/connect/models/client-sessions/client-session.js +9 -0
  9. package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
  10. package/lib/seam/connect/models/connect-webviews/connect-webview.js +13 -0
  11. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  12. package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -0
  13. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  14. package/lib/seam/connect/models/devices/capability-properties/access-code.js +4 -1
  15. package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.js +5 -1
  17. package/lib/seam/connect/models/devices/device.js.map +1 -1
  18. package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
  19. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  20. package/lib/seam/connect/models/events/seam-event.js +3 -0
  21. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  22. package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
  23. package/lib/seam/connect/models/workspaces/workspace.js +1 -0
  24. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  25. package/lib/seam/connect/openapi.d.ts +381 -0
  26. package/lib/seam/connect/openapi.js +804 -255
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +467 -177
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +8 -2
  31. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +4 -0
  32. package/src/lib/seam/connect/models/client-sessions/client-session.ts +9 -0
  33. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +13 -0
  34. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -0
  35. package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +6 -1
  36. package/src/lib/seam/connect/models/devices/device.ts +7 -1
  37. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
  38. package/src/lib/seam/connect/models/events/seam-event.ts +3 -0
  39. package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
  40. package/src/lib/seam/connect/models/workspaces/workspace.ts +1 -0
  41. package/src/lib/seam/connect/openapi.ts +1007 -255
  42. package/src/lib/seam/connect/route-types.ts +469 -177
@@ -3,7 +3,7 @@ export default {
3
3
  schemas: {
4
4
  access_code: {
5
5
  description:
6
- '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.',
6
+ '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.',
7
7
  properties: {
8
8
  access_code_id: {
9
9
  description: 'Unique identifier for the access code.',
@@ -1180,7 +1180,7 @@ export default {
1180
1180
  },
1181
1181
  name: {
1182
1182
  description:
1183
- 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
1183
+ "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).",
1184
1184
  nullable: true,
1185
1185
  type: 'string',
1186
1186
  },
@@ -7124,6 +7124,8 @@ export default {
7124
7124
  'x-route-path': '/action_attempts',
7125
7125
  },
7126
7126
  client_session: {
7127
+ description:
7128
+ "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).",
7127
7129
  properties: {
7128
7130
  client_session_id: { format: 'uuid', type: 'string' },
7129
7131
  connect_webview_ids: {
@@ -7161,18 +7163,22 @@ export default {
7161
7163
  'x-route-path': '/client_sessions',
7162
7164
  },
7163
7165
  connect_webview: {
7166
+ description:
7167
+ '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.',
7164
7168
  properties: {
7165
7169
  accepted_devices: {
7166
7170
  deprecated: true,
7167
7171
  items: { type: 'string' },
7168
7172
  type: 'array',
7169
7173
  'x-deprecated': 'Unused. Will be removed.',
7174
+ 'x-undocumented': 'Unused. Will be removed.',
7170
7175
  },
7171
7176
  accepted_providers: { items: { type: 'string' }, type: 'array' },
7172
7177
  any_device_allowed: {
7173
7178
  deprecated: true,
7174
7179
  type: 'boolean',
7175
7180
  'x-deprecated': 'Unused. Will be removed.',
7181
+ 'x-undocumented': 'Unused. Will be removed.',
7176
7182
  },
7177
7183
  any_provider_allowed: { type: 'boolean' },
7178
7184
  authorized_at: {
@@ -7240,6 +7246,8 @@ export default {
7240
7246
  'x-route-path': '/connect_webviews',
7241
7247
  },
7242
7248
  connected_account: {
7249
+ description:
7250
+ '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.',
7243
7251
  properties: {
7244
7252
  account_type: { type: 'string' },
7245
7253
  account_type_display_name: { type: 'string' },
@@ -7513,6 +7521,8 @@ export default {
7513
7521
  'x-route-path': '/connected_accounts',
7514
7522
  },
7515
7523
  device: {
7524
+ description:
7525
+ 'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.',
7516
7526
  properties: {
7517
7527
  can_hvac_cool: { type: 'boolean' },
7518
7528
  can_hvac_heat: { type: 'boolean' },
@@ -8082,7 +8092,8 @@ export default {
8082
8092
  type: 'string',
8083
8093
  },
8084
8094
  manufacturer: {
8085
- description: 'Manufacturer of the device.',
8095
+ description:
8096
+ '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.',
8086
8097
  type: 'string',
8087
8098
  },
8088
8099
  model: {
@@ -8778,6 +8789,8 @@ export default {
8778
8789
  type: 'array',
8779
8790
  },
8780
8791
  code_constraints: {
8792
+ description:
8793
+ '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.',
8781
8794
  items: {
8782
8795
  oneOf: [
8783
8796
  {
@@ -9901,6 +9914,8 @@ export default {
9901
9914
  'x-route-path': '/user_identities/enrollment_automations',
9902
9915
  },
9903
9916
  event: {
9917
+ description:
9918
+ "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.",
9904
9919
  discriminator: { propertyName: 'event_type' },
9905
9920
  oneOf: [
9906
9921
  {
@@ -15203,7 +15218,7 @@ export default {
15203
15218
  },
15204
15219
  unmanaged_access_code: {
15205
15220
  description:
15206
- '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.',
15221
+ '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)',
15207
15222
  properties: {
15208
15223
  access_code_id: {
15209
15224
  description: 'Unique identifier for the access code.',
@@ -16340,7 +16355,7 @@ export default {
16340
16355
  },
16341
16356
  name: {
16342
16357
  description:
16343
- 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
16358
+ "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).",
16344
16359
  nullable: true,
16345
16360
  type: 'string',
16346
16361
  },
@@ -17807,6 +17822,8 @@ export default {
17807
17822
  'x-route-path': '/acs/users/unmanaged',
17808
17823
  },
17809
17824
  unmanaged_device: {
17825
+ description:
17826
+ '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).',
17810
17827
  properties: {
17811
17828
  can_hvac_cool: { type: 'boolean' },
17812
17829
  can_hvac_heat: { type: 'boolean' },
@@ -18326,7 +18343,8 @@ export default {
18326
18343
  type: 'string',
18327
18344
  },
18328
18345
  manufacturer: {
18329
- description: 'Manufacturer of the device.',
18346
+ description:
18347
+ '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.',
18330
18348
  type: 'string',
18331
18349
  },
18332
18350
  model: {
@@ -18690,7 +18708,7 @@ export default {
18690
18708
  },
18691
18709
  user_identity: {
18692
18710
  description:
18693
- '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.',
18711
+ '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.',
18694
18712
  properties: {
18695
18713
  created_at: {
18696
18714
  description:
@@ -18755,6 +18773,8 @@ export default {
18755
18773
  'x-route-path': '/webhooks',
18756
18774
  },
18757
18775
  workspace: {
18776
+ description:
18777
+ '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).',
18758
18778
  properties: {
18759
18779
  company_name: { type: 'string' },
18760
18780
  connect_partner_name: {
@@ -18891,7 +18911,7 @@ export default {
18891
18911
  },
18892
18912
  device_id: {
18893
18913
  description:
18894
- 'ID of the device for which to create the new access code.',
18914
+ 'ID of the device for which you want to create the new access code.',
18895
18915
  format: 'uuid',
18896
18916
  type: 'string',
18897
18917
  },
@@ -18923,7 +18943,8 @@ export default {
18923
18943
  type: 'string',
18924
18944
  },
18925
18945
  name: {
18926
- description: 'Name of the new access code.',
18946
+ description:
18947
+ "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).",
18927
18948
  type: 'string',
18928
18949
  },
18929
18950
  prefer_native_scheduling: {
@@ -19033,7 +19054,7 @@ export default {
19033
19054
  },
19034
19055
  device_ids: {
19035
19056
  description:
19036
- 'IDs of the devices for which to create the new access codes.',
19057
+ 'IDs of the devices for which you want to create the new access codes.',
19037
19058
  items: { format: 'uuid', type: 'string' },
19038
19059
  type: 'array',
19039
19060
  },
@@ -19065,7 +19086,8 @@ export default {
19065
19086
  type: 'string',
19066
19087
  },
19067
19088
  name: {
19068
- description: 'Name of the new access code.',
19089
+ description:
19090
+ "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).",
19069
19091
  type: 'string',
19070
19092
  },
19071
19093
  prefer_native_scheduling: {
@@ -19167,7 +19189,7 @@ export default {
19167
19189
  },
19168
19190
  device_ids: {
19169
19191
  description:
19170
- 'IDs of the devices for which to create the new access codes.',
19192
+ 'IDs of the devices for which you want to create the new access codes.',
19171
19193
  items: { format: 'uuid', type: 'string' },
19172
19194
  type: 'array',
19173
19195
  },
@@ -19199,7 +19221,8 @@ export default {
19199
19221
  type: 'string',
19200
19222
  },
19201
19223
  name: {
19202
- description: 'Name of the new access code.',
19224
+ description:
19225
+ "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).",
19203
19226
  type: 'string',
19204
19227
  },
19205
19228
  prefer_native_scheduling: {
@@ -19277,13 +19300,14 @@ export default {
19277
19300
  schema: {
19278
19301
  properties: {
19279
19302
  access_code_id: {
19280
- description: 'ID of the access code to delete.',
19303
+ description:
19304
+ 'ID of the access code that you want to delete.',
19281
19305
  format: 'uuid',
19282
19306
  type: 'string',
19283
19307
  },
19284
19308
  device_id: {
19285
19309
  description:
19286
- 'ID of the device for which to delete the access code.',
19310
+ 'ID of the device for which you want to delete the access code.',
19287
19311
  format: 'uuid',
19288
19312
  type: 'string',
19289
19313
  },
@@ -19337,12 +19361,21 @@ export default {
19337
19361
  },
19338
19362
  '/access_codes/generate_code': {
19339
19363
  post: {
19364
+ description:
19365
+ 'Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.',
19340
19366
  operationId: 'accessCodesGenerateCodePost',
19341
19367
  requestBody: {
19342
19368
  content: {
19343
19369
  'application/json': {
19344
19370
  schema: {
19345
- properties: { device_id: { format: 'uuid', type: 'string' } },
19371
+ properties: {
19372
+ device_id: {
19373
+ description:
19374
+ 'ID of the device for which you want to generate a code.',
19375
+ format: 'uuid',
19376
+ type: 'string',
19377
+ },
19378
+ },
19346
19379
  required: ['device_id'],
19347
19380
  type: 'object',
19348
19381
  },
@@ -19382,6 +19415,7 @@ export default {
19382
19415
  'x-fern-sdk-method-name': 'generate_code',
19383
19416
  'x-fern-sdk-return-value': 'generated_code',
19384
19417
  'x-response-key': 'generated_code',
19418
+ 'x-title': 'Generate a Code',
19385
19419
  },
19386
19420
  },
19387
19421
  '/access_codes/get': {
@@ -19538,7 +19572,7 @@ export default {
19538
19572
  '/access_codes/pull_backup_access_code': {
19539
19573
  post: {
19540
19574
  description:
19541
- "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.",
19575
+ "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.",
19542
19576
  operationId: 'accessCodesPullBackupAccessCodePost',
19543
19577
  requestBody: {
19544
19578
  content: {
@@ -19598,7 +19632,7 @@ export default {
19598
19632
  '/access_codes/report_device_constraints': {
19599
19633
  post: {
19600
19634
  description:
19601
- 'Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.',
19635
+ '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`.',
19602
19636
  operationId: 'accessCodesReportDeviceConstraintsPost',
19603
19637
  requestBody: {
19604
19638
  content: {
@@ -19607,7 +19641,7 @@ export default {
19607
19641
  properties: {
19608
19642
  device_id: {
19609
19643
  description:
19610
- 'ID of the device for which to report constraints.',
19644
+ 'ID of the device for which you want to report constraints.',
19611
19645
  format: 'uuid',
19612
19646
  type: 'string',
19613
19647
  },
@@ -19757,7 +19791,7 @@ export default {
19757
19791
  },
19758
19792
  allow_external_modification: {
19759
19793
  description:
19760
- 'Indicates whether external modification of the access code is allowed.',
19794
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
19761
19795
  type: 'boolean',
19762
19796
  },
19763
19797
  force: {
@@ -19767,7 +19801,7 @@ export default {
19767
19801
  },
19768
19802
  is_external_modification_allowed: {
19769
19803
  description:
19770
- 'Indicates whether external modification of the access code is allowed.',
19804
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
19771
19805
  type: 'boolean',
19772
19806
  },
19773
19807
  sync: {
@@ -19828,7 +19862,7 @@ export default {
19828
19862
  },
19829
19863
  allow_external_modification: {
19830
19864
  description:
19831
- 'Indicates whether external modification of the access code is allowed.',
19865
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
19832
19866
  type: 'boolean',
19833
19867
  },
19834
19868
  force: {
@@ -19838,7 +19872,7 @@ export default {
19838
19872
  },
19839
19873
  is_external_modification_allowed: {
19840
19874
  description:
19841
- 'Indicates whether external modification of the access code is allowed.',
19875
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
19842
19876
  type: 'boolean',
19843
19877
  },
19844
19878
  sync: {
@@ -19895,7 +19929,8 @@ export default {
19895
19929
  schema: {
19896
19930
  properties: {
19897
19931
  access_code_id: {
19898
- description: 'ID of the unmanaged access code to delete.',
19932
+ description:
19933
+ 'ID of the unmanaged access code that you want to delete.',
19899
19934
  format: 'uuid',
19900
19935
  type: 'string',
19901
19936
  },
@@ -20289,7 +20324,8 @@ export default {
20289
20324
  type: 'string',
20290
20325
  },
20291
20326
  name: {
20292
- description: 'Name of the new access code.',
20327
+ description:
20328
+ "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).",
20293
20329
  type: 'string',
20294
20330
  },
20295
20331
  prefer_native_scheduling: {
@@ -20436,7 +20472,8 @@ export default {
20436
20472
  type: 'string',
20437
20473
  },
20438
20474
  name: {
20439
- description: 'Name of the new access code.',
20475
+ description:
20476
+ "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).",
20440
20477
  type: 'string',
20441
20478
  },
20442
20479
  prefer_native_scheduling: {
@@ -20584,7 +20621,8 @@ export default {
20584
20621
  type: 'string',
20585
20622
  },
20586
20623
  name: {
20587
- description: 'Name of the new access code.',
20624
+ description:
20625
+ "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).",
20588
20626
  type: 'string',
20589
20627
  },
20590
20628
  prefer_native_scheduling: {
@@ -20683,7 +20721,8 @@ export default {
20683
20721
  type: 'string',
20684
20722
  },
20685
20723
  name: {
20686
- description: 'Name of the new access code.',
20724
+ description:
20725
+ "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).",
20687
20726
  type: 'string',
20688
20727
  },
20689
20728
  starts_at: {
@@ -20746,7 +20785,8 @@ export default {
20746
20785
  type: 'string',
20747
20786
  },
20748
20787
  name: {
20749
- description: 'Name of the new access code.',
20788
+ description:
20789
+ "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).",
20750
20790
  type: 'string',
20751
20791
  },
20752
20792
  starts_at: {
@@ -20794,7 +20834,7 @@ export default {
20794
20834
  '/acs/access_groups/add_user': {
20795
20835
  post: {
20796
20836
  description:
20797
- '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).',
20837
+ '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).',
20798
20838
  operationId: 'acsAccessGroupsAddUserPost',
20799
20839
  requestBody: {
20800
20840
  content: {
@@ -20802,12 +20842,14 @@ export default {
20802
20842
  schema: {
20803
20843
  properties: {
20804
20844
  acs_access_group_id: {
20805
- description: 'ID of the desired access group.',
20845
+ description:
20846
+ 'ID of the access group to which you want to add an access system user.',
20806
20847
  format: 'uuid',
20807
20848
  type: 'string',
20808
20849
  },
20809
20850
  acs_user_id: {
20810
- description: 'ID of the desired user.',
20851
+ description:
20852
+ 'ID of the access system user that you want to add to an access group.',
20811
20853
  format: 'uuid',
20812
20854
  type: 'string',
20813
20855
  },
@@ -20848,7 +20890,7 @@ export default {
20848
20890
  },
20849
20891
  put: {
20850
20892
  description:
20851
- '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).',
20893
+ '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).',
20852
20894
  operationId: 'acsAccessGroupsAddUserPut',
20853
20895
  requestBody: {
20854
20896
  content: {
@@ -20856,12 +20898,14 @@ export default {
20856
20898
  schema: {
20857
20899
  properties: {
20858
20900
  acs_access_group_id: {
20859
- description: 'ID of the desired access group.',
20901
+ description:
20902
+ 'ID of the access group to which you want to add an access system user.',
20860
20903
  format: 'uuid',
20861
20904
  type: 'string',
20862
20905
  },
20863
20906
  acs_user_id: {
20864
- description: 'ID of the desired user.',
20907
+ description:
20908
+ 'ID of the access system user that you want to add to an access group.',
20865
20909
  format: 'uuid',
20866
20910
  type: 'string',
20867
20911
  },
@@ -20911,7 +20955,7 @@ export default {
20911
20955
  schema: {
20912
20956
  properties: {
20913
20957
  acs_access_group_id: {
20914
- description: 'ID of the desired access group.',
20958
+ description: 'ID of the access group that you want to get.',
20915
20959
  format: 'uuid',
20916
20960
  type: 'string',
20917
20961
  },
@@ -20969,13 +21013,13 @@ export default {
20969
21013
  properties: {
20970
21014
  acs_system_id: {
20971
21015
  description:
20972
- 'ID of the access control system for which you want to retrieve all access groups.',
21016
+ 'ID of the access system for which you want to retrieve all access groups.',
20973
21017
  format: 'uuid',
20974
21018
  type: 'string',
20975
21019
  },
20976
21020
  acs_user_id: {
20977
21021
  description:
20978
- 'ID of the user for which you want to retrieve all access groups.',
21022
+ 'ID of the access system user for which you want to retrieve all access groups.',
20979
21023
  format: 'uuid',
20980
21024
  type: 'string',
20981
21025
  },
@@ -21089,7 +21133,7 @@ export default {
21089
21133
  '/acs/access_groups/list_users': {
21090
21134
  post: {
21091
21135
  description:
21092
- '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).',
21136
+ '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).',
21093
21137
  operationId: 'acsAccessGroupsListUsersPost',
21094
21138
  requestBody: {
21095
21139
  content: {
@@ -21098,7 +21142,7 @@ export default {
21098
21142
  properties: {
21099
21143
  acs_access_group_id: {
21100
21144
  description:
21101
- 'ID of the access group for which you want to retrieve all users.',
21145
+ 'ID of the access group for which you want to retrieve all access system users.',
21102
21146
  format: 'uuid',
21103
21147
  type: 'string',
21104
21148
  },
@@ -21148,7 +21192,7 @@ export default {
21148
21192
  '/acs/access_groups/remove_user': {
21149
21193
  post: {
21150
21194
  description:
21151
- '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).',
21195
+ '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).',
21152
21196
  operationId: 'acsAccessGroupsRemoveUserPost',
21153
21197
  requestBody: {
21154
21198
  content: {
@@ -21156,17 +21200,20 @@ export default {
21156
21200
  schema: {
21157
21201
  properties: {
21158
21202
  acs_access_group_id: {
21159
- description: 'ID of the desired access group.',
21203
+ description:
21204
+ 'ID of the access group from which you want to remove an access system user.',
21160
21205
  format: 'uuid',
21161
21206
  type: 'string',
21162
21207
  },
21163
21208
  acs_user_id: {
21164
- description: 'ID of the desired user.',
21209
+ description:
21210
+ 'ID of the access system user that you want to remove from an access group.',
21165
21211
  format: 'uuid',
21166
21212
  type: 'string',
21167
21213
  },
21168
21214
  user_identity_id: {
21169
- description: 'ID of the desired user identity.',
21215
+ description:
21216
+ 'ID of the user identity associated with the user that you want to remove from an access group.',
21170
21217
  format: 'uuid',
21171
21218
  type: 'string',
21172
21219
  },
@@ -21217,7 +21264,8 @@ export default {
21217
21264
  schema: {
21218
21265
  properties: {
21219
21266
  acs_access_group_id: {
21220
- description: 'ID of the desired unmanaged access group.',
21267
+ description:
21268
+ 'ID of the unmanaged access group that you want to get.',
21221
21269
  format: 'uuid',
21222
21270
  type: 'string',
21223
21271
  },
@@ -21260,6 +21308,7 @@ export default {
21260
21308
  'x-fern-sdk-method-name': 'get',
21261
21309
  'x-fern-sdk-return-value': 'acs_access_group',
21262
21310
  'x-response-key': 'acs_access_group',
21311
+ 'x-title': 'Get an Unmanaged Access Group',
21263
21312
  'x-undocumented':
21264
21313
  'No unmanaged access groups are currently implemented.',
21265
21314
  },
@@ -21276,13 +21325,13 @@ export default {
21276
21325
  properties: {
21277
21326
  acs_system_id: {
21278
21327
  description:
21279
- 'ID of the access control system for which you want to retrieve all unmanaged access groups.',
21328
+ 'ID of the access system for which you want to retrieve all unmanaged access groups.',
21280
21329
  format: 'uuid',
21281
21330
  type: 'string',
21282
21331
  },
21283
21332
  acs_user_id: {
21284
21333
  description:
21285
- 'ID of the user for which you want to retrieve all unmanaged access groups.',
21334
+ 'ID of the access system user for which you want to retrieve all unmanaged access groups.',
21286
21335
  format: 'uuid',
21287
21336
  type: 'string',
21288
21337
  },
@@ -21327,19 +21376,26 @@ export default {
21327
21376
  'x-fern-sdk-method-name': 'list',
21328
21377
  'x-fern-sdk-return-value': 'acs_access_groups',
21329
21378
  'x-response-key': 'acs_access_groups',
21379
+ 'x-title': 'List Unmanaged Access Groups',
21330
21380
  'x-undocumented':
21331
21381
  'No unmanaged access groups are currently implemented.',
21332
21382
  },
21333
21383
  },
21334
21384
  '/acs/credential_pools/list': {
21335
21385
  post: {
21386
+ description: 'Returns a list of all credential pools.',
21336
21387
  operationId: 'acsCredentialPoolsListPost',
21337
21388
  requestBody: {
21338
21389
  content: {
21339
21390
  'application/json': {
21340
21391
  schema: {
21341
21392
  properties: {
21342
- acs_system_id: { format: 'uuid', type: 'string' },
21393
+ acs_system_id: {
21394
+ description:
21395
+ 'ID of the access system for which you want to list credential pools.',
21396
+ format: 'uuid',
21397
+ type: 'string',
21398
+ },
21343
21399
  },
21344
21400
  required: ['acs_system_id'],
21345
21401
  type: 'object',
@@ -21384,28 +21440,48 @@ export default {
21384
21440
  'x-fern-sdk-method-name': 'list',
21385
21441
  'x-fern-sdk-return-value': 'acs_credential_pools',
21386
21442
  'x-response-key': 'acs_credential_pools',
21443
+ 'x-title': 'List Credential Pools',
21387
21444
  'x-undocumented': 'Replaced by enrollment automations.',
21388
21445
  },
21389
21446
  },
21390
21447
  '/acs/credential_provisioning_automations/launch': {
21391
21448
  post: {
21449
+ description: 'Launches a credential provisioning automation.',
21392
21450
  operationId: 'acsCredentialProvisioningAutomationsLaunchPost',
21393
21451
  requestBody: {
21394
21452
  content: {
21395
21453
  'application/json': {
21396
21454
  schema: {
21397
21455
  properties: {
21398
- acs_credential_pool_id: { format: 'uuid', type: 'string' },
21399
- create_credential_manager_user: { type: 'boolean' },
21456
+ acs_credential_pool_id: {
21457
+ description:
21458
+ 'ID of the credential pool for which you want to launch a credential provisioning automation.',
21459
+ format: 'uuid',
21460
+ type: 'string',
21461
+ },
21462
+ create_credential_manager_user: {
21463
+ description:
21464
+ '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`.',
21465
+ type: 'boolean',
21466
+ },
21400
21467
  credential_manager_acs_system_id: {
21468
+ description:
21469
+ 'Access system ID of the credential manager for which you want to launch a credential provisioning automation.',
21401
21470
  format: 'uuid',
21402
21471
  type: 'string',
21403
21472
  },
21404
21473
  credential_manager_acs_user_id: {
21474
+ description:
21475
+ '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`.',
21476
+ format: 'uuid',
21477
+ type: 'string',
21478
+ },
21479
+ user_identity_id: {
21480
+ description:
21481
+ 'ID of the user identity for which you want to launch a credential provisioning automation.',
21405
21482
  format: 'uuid',
21406
21483
  type: 'string',
21407
21484
  },
21408
- user_identity_id: { format: 'uuid', type: 'string' },
21409
21485
  },
21410
21486
  required: [
21411
21487
  'user_identity_id',
@@ -21450,13 +21526,14 @@ export default {
21450
21526
  'x-fern-sdk-method-name': 'launch',
21451
21527
  'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
21452
21528
  'x-response-key': 'acs_credential_provisioning_automation',
21529
+ 'x-title': 'Launch a Credential Provisioning Automation',
21453
21530
  'x-undocumented': 'Replaced by enrollment automations.',
21454
21531
  },
21455
21532
  },
21456
21533
  '/acs/credentials/assign': {
21457
21534
  patch: {
21458
21535
  description:
21459
- '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).',
21536
+ '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).',
21460
21537
  operationId: 'acsCredentialsAssignPatch',
21461
21538
  requestBody: {
21462
21539
  content: {
@@ -21464,12 +21541,14 @@ export default {
21464
21541
  schema: {
21465
21542
  properties: {
21466
21543
  acs_credential_id: {
21467
- description: 'ID of the desired credential.',
21544
+ description:
21545
+ 'ID of the credential that you want to assign to an access system user.',
21468
21546
  format: 'uuid',
21469
21547
  type: 'string',
21470
21548
  },
21471
21549
  acs_user_id: {
21472
- description: 'ID of the desired user.',
21550
+ description:
21551
+ 'ID of the access system user to whom you want to assign a credential.',
21473
21552
  format: 'uuid',
21474
21553
  type: 'string',
21475
21554
  },
@@ -21514,7 +21593,7 @@ export default {
21514
21593
  },
21515
21594
  post: {
21516
21595
  description:
21517
- '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).',
21596
+ '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).',
21518
21597
  operationId: 'acsCredentialsAssignPost',
21519
21598
  requestBody: {
21520
21599
  content: {
@@ -21522,12 +21601,14 @@ export default {
21522
21601
  schema: {
21523
21602
  properties: {
21524
21603
  acs_credential_id: {
21525
- description: 'ID of the desired credential.',
21604
+ description:
21605
+ 'ID of the credential that you want to assign to an access system user.',
21526
21606
  format: 'uuid',
21527
21607
  type: 'string',
21528
21608
  },
21529
21609
  acs_user_id: {
21530
- description: 'ID of the desired user.',
21610
+ description:
21611
+ 'ID of the access system user to whom you want to assign a credential.',
21531
21612
  format: 'uuid',
21532
21613
  type: 'string',
21533
21614
  },
@@ -21588,9 +21669,15 @@ export default {
21588
21669
  enum: ['code', 'card', 'mobile_key'],
21589
21670
  type: 'string',
21590
21671
  },
21672
+ acs_system_id: {
21673
+ description:
21674
+ '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`.',
21675
+ format: 'uuid',
21676
+ type: 'string',
21677
+ },
21591
21678
  acs_user_id: {
21592
21679
  description:
21593
- 'ID of the ACS user to whom the new credential belongs.',
21680
+ '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`.',
21594
21681
  format: 'uuid',
21595
21682
  type: 'string',
21596
21683
  },
@@ -21643,8 +21730,16 @@ export default {
21643
21730
  description:
21644
21731
  'Salto Space-specific metadata for the new credential.',
21645
21732
  properties: {
21646
- assign_new_key: { type: 'boolean' },
21647
- update_current_key: { type: 'boolean' },
21733
+ assign_new_key: {
21734
+ description:
21735
+ '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).',
21736
+ type: 'boolean',
21737
+ },
21738
+ update_current_key: {
21739
+ description:
21740
+ "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).",
21741
+ type: 'boolean',
21742
+ },
21648
21743
  },
21649
21744
  type: 'object',
21650
21745
  },
@@ -21654,6 +21749,12 @@ export default {
21654
21749
  format: 'date-time',
21655
21750
  type: 'string',
21656
21751
  },
21752
+ user_identity_id: {
21753
+ description:
21754
+ '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.',
21755
+ format: 'uuid',
21756
+ type: 'string',
21757
+ },
21657
21758
  visionline_metadata: {
21658
21759
  description:
21659
21760
  'Visionline-specific metadata for the new credential.',
@@ -21692,7 +21793,7 @@ export default {
21692
21793
  type: 'object',
21693
21794
  },
21694
21795
  },
21695
- required: ['acs_user_id', 'access_method'],
21796
+ required: ['access_method'],
21696
21797
  type: 'object',
21697
21798
  },
21698
21799
  },
@@ -21736,7 +21837,7 @@ export default {
21736
21837
  '/acs/credentials/create_offline_code': {
21737
21838
  post: {
21738
21839
  description:
21739
- '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).',
21840
+ '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).',
21740
21841
  operationId: 'acsCredentialsCreateOfflineCodePost',
21741
21842
  requestBody: {
21742
21843
  content: {
@@ -21745,7 +21846,7 @@ export default {
21745
21846
  properties: {
21746
21847
  acs_user_id: {
21747
21848
  description:
21748
- 'ID of the ACS user to whom the new credential belongs.',
21849
+ 'ID of the access system user to whom the new credential belongs.',
21749
21850
  format: 'uuid',
21750
21851
  type: 'string',
21751
21852
  },
@@ -21827,7 +21928,8 @@ export default {
21827
21928
  schema: {
21828
21929
  properties: {
21829
21930
  acs_credential_id: {
21830
- description: 'ID of the desired credential.',
21931
+ description:
21932
+ 'ID of the credential that you want to delete.',
21831
21933
  format: 'uuid',
21832
21934
  type: 'string',
21833
21935
  },
@@ -21878,7 +21980,7 @@ export default {
21878
21980
  schema: {
21879
21981
  properties: {
21880
21982
  acs_credential_id: {
21881
- description: 'ID of the desired credential.',
21983
+ description: 'ID of the credential that you want to get.',
21882
21984
  format: 'uuid',
21883
21985
  type: 'string',
21884
21986
  },
@@ -21940,7 +22042,7 @@ export default {
21940
22042
  properties: {
21941
22043
  acs_user_id: {
21942
22044
  description:
21943
- 'ID of the ACS user for which you want to retrieve all credentials.',
22045
+ 'ID of the access system user for which you want to retrieve all credentials.',
21944
22046
  format: 'uuid',
21945
22047
  type: 'string',
21946
22048
  },
@@ -21952,7 +22054,7 @@ export default {
21952
22054
  properties: {
21953
22055
  acs_system_id: {
21954
22056
  description:
21955
- 'ID of the access control system for which you want to retrieve all credentials.',
22057
+ 'ID of the access system for which you want to retrieve all credentials.',
21956
22058
  format: 'uuid',
21957
22059
  type: 'string',
21958
22060
  },
@@ -21964,13 +22066,13 @@ export default {
21964
22066
  properties: {
21965
22067
  acs_system_id: {
21966
22068
  description:
21967
- 'ID of the access control system for which you want to retrieve all credentials.',
22069
+ 'ID of the access system for which you want to retrieve all credentials.',
21968
22070
  format: 'uuid',
21969
22071
  type: 'string',
21970
22072
  },
21971
22073
  acs_user_id: {
21972
22074
  description:
21973
- 'ID of the ACS user for which you want to retrieve all credentials.',
22075
+ 'ID of the access system user for which you want to retrieve all credentials.',
21974
22076
  format: 'uuid',
21975
22077
  type: 'string',
21976
22078
  },
@@ -22069,7 +22171,7 @@ export default {
22069
22171
  properties: {
22070
22172
  acs_credential_id: {
22071
22173
  description:
22072
- 'ID of the credential for which you want to retrieve all entrances to which this credential grants access.',
22174
+ 'ID of the credential for which you want to retrieve all entrances to which the credential grants access.',
22073
22175
  format: 'uuid',
22074
22176
  type: 'string',
22075
22177
  },
@@ -22119,7 +22221,7 @@ export default {
22119
22221
  '/acs/credentials/unassign': {
22120
22222
  patch: {
22121
22223
  description:
22122
- '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).',
22224
+ '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).',
22123
22225
  operationId: 'acsCredentialsUnassignPatch',
22124
22226
  requestBody: {
22125
22227
  content: {
@@ -22127,12 +22229,14 @@ export default {
22127
22229
  schema: {
22128
22230
  properties: {
22129
22231
  acs_credential_id: {
22130
- description: 'ID of the desired credential.',
22232
+ description:
22233
+ 'ID of the credential that you want to unassign from an access system user.',
22131
22234
  format: 'uuid',
22132
22235
  type: 'string',
22133
22236
  },
22134
22237
  acs_user_id: {
22135
- description: 'ID of the desired user.',
22238
+ description:
22239
+ 'ID of the access system user from which you want to unassign a credential.',
22136
22240
  format: 'uuid',
22137
22241
  type: 'string',
22138
22242
  },
@@ -22177,7 +22281,7 @@ export default {
22177
22281
  },
22178
22282
  post: {
22179
22283
  description:
22180
- '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).',
22284
+ '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).',
22181
22285
  operationId: 'acsCredentialsUnassignPost',
22182
22286
  requestBody: {
22183
22287
  content: {
@@ -22185,12 +22289,14 @@ export default {
22185
22289
  schema: {
22186
22290
  properties: {
22187
22291
  acs_credential_id: {
22188
- description: 'ID of the desired credential.',
22292
+ description:
22293
+ 'ID of the credential that you want to unassign from an access system user.',
22189
22294
  format: 'uuid',
22190
22295
  type: 'string',
22191
22296
  },
22192
22297
  acs_user_id: {
22193
- description: 'ID of the desired user.',
22298
+ description:
22299
+ 'ID of the access system user from which you want to unassign a credential.',
22194
22300
  format: 'uuid',
22195
22301
  type: 'string',
22196
22302
  },
@@ -22246,7 +22352,8 @@ export default {
22246
22352
  schema: {
22247
22353
  properties: {
22248
22354
  acs_credential_id: {
22249
- description: 'ID of the desired unmanaged credential.',
22355
+ description:
22356
+ 'ID of the unmanaged credential that you want to get.',
22250
22357
  format: 'uuid',
22251
22358
  type: 'string',
22252
22359
  },
@@ -22304,10 +22411,12 @@ export default {
22304
22411
  schema: {
22305
22412
  oneOf: [
22306
22413
  {
22414
+ description:
22415
+ 'ID of the access system user for which you want to list unmanaged credentials.',
22307
22416
  properties: {
22308
22417
  acs_user_id: {
22309
22418
  description:
22310
- 'ID of the ACS user for which you want to retrieve all credentials.',
22419
+ 'ID of the access system user for which you want to retrieve all credentials.',
22311
22420
  format: 'uuid',
22312
22421
  type: 'string',
22313
22422
  },
@@ -22316,10 +22425,12 @@ export default {
22316
22425
  type: 'object',
22317
22426
  },
22318
22427
  {
22428
+ description:
22429
+ 'ID of the access system for which you want to list unmanaged credentials.',
22319
22430
  properties: {
22320
22431
  acs_system_id: {
22321
22432
  description:
22322
- 'ID of the access control system for which you want to retrieve all credentials.',
22433
+ 'ID of the access system for which you want to retrieve all credentials.',
22323
22434
  format: 'uuid',
22324
22435
  type: 'string',
22325
22436
  },
@@ -22328,16 +22439,18 @@ export default {
22328
22439
  type: 'object',
22329
22440
  },
22330
22441
  {
22442
+ description:
22443
+ 'ID of the access system and ID of the access system user for which you want to list unmanaged credentials.',
22331
22444
  properties: {
22332
22445
  acs_system_id: {
22333
22446
  description:
22334
- 'ID of the access control system for which you want to retrieve all credentials.',
22447
+ 'ID of the access system for which you want to retrieve all credentials.',
22335
22448
  format: 'uuid',
22336
22449
  type: 'string',
22337
22450
  },
22338
22451
  acs_user_id: {
22339
22452
  description:
22340
- 'ID of the ACS user for which you want to retrieve all credentials.',
22453
+ 'ID of the access system user for which you want to retrieve all credentials.',
22341
22454
  format: 'uuid',
22342
22455
  type: 'string',
22343
22456
  },
@@ -22346,6 +22459,8 @@ export default {
22346
22459
  type: 'object',
22347
22460
  },
22348
22461
  {
22462
+ description:
22463
+ 'ID of the user identity for which you want to list unmanaged credentials.',
22349
22464
  properties: {
22350
22465
  user_identity_id: {
22351
22466
  description:
@@ -22412,12 +22527,13 @@ export default {
22412
22527
  schema: {
22413
22528
  properties: {
22414
22529
  acs_credential_id: {
22415
- description: 'ID of the desired credential.',
22530
+ description:
22531
+ 'ID of the credential that you want to update.',
22416
22532
  type: 'string',
22417
22533
  },
22418
22534
  code: {
22419
22535
  description:
22420
- 'Replacement access (PIN) code for the credential.',
22536
+ 'Replacement access (PIN) code for the credential that you want to update.',
22421
22537
  pattern: '^\\d+$',
22422
22538
  type: 'string',
22423
22539
  },
@@ -22476,12 +22592,13 @@ export default {
22476
22592
  schema: {
22477
22593
  properties: {
22478
22594
  acs_credential_id: {
22479
- description: 'ID of the desired credential.',
22595
+ description:
22596
+ 'ID of the credential that you want to update.',
22480
22597
  type: 'string',
22481
22598
  },
22482
22599
  code: {
22483
22600
  description:
22484
- 'Replacement access (PIN) code for the credential.',
22601
+ 'Replacement access (PIN) code for the credential that you want to update.',
22485
22602
  pattern: '^\\d+$',
22486
22603
  type: 'string',
22487
22604
  },
@@ -22673,7 +22790,7 @@ export default {
22673
22790
  schema: {
22674
22791
  properties: {
22675
22792
  acs_encoder_id: {
22676
- description: 'ID of the desired encoder.',
22793
+ description: 'ID of the encoder that you want to get.',
22677
22794
  format: 'uuid',
22678
22795
  type: 'string',
22679
22796
  },
@@ -22731,13 +22848,13 @@ export default {
22731
22848
  properties: {
22732
22849
  acs_system_id: {
22733
22850
  description:
22734
- 'ID of the `acs_system` for which you want to retrieve all `acs_encoder`s.',
22851
+ 'ID of the access system for which you want to retrieve all encoders.',
22735
22852
  format: 'uuid',
22736
22853
  type: 'string',
22737
22854
  },
22738
22855
  limit: {
22739
22856
  default: 500,
22740
- description: 'Number of `acs_encoders` to return.',
22857
+ description: 'Number of encoders to return.',
22741
22858
  format: 'float',
22742
22859
  type: 'number',
22743
22860
  },
@@ -22749,13 +22866,13 @@ export default {
22749
22866
  properties: {
22750
22867
  acs_system_ids: {
22751
22868
  description:
22752
- 'IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s.',
22869
+ 'IDs of the access systems for which you want to retrieve all encoders.',
22753
22870
  items: { format: 'uuid', type: 'string' },
22754
22871
  type: 'array',
22755
22872
  },
22756
22873
  limit: {
22757
22874
  default: 500,
22758
- description: 'Number of `acs_encoders` to return.',
22875
+ description: 'Number of encoders to return.',
22759
22876
  format: 'float',
22760
22877
  type: 'number',
22761
22878
  },
@@ -22767,13 +22884,13 @@ export default {
22767
22884
  properties: {
22768
22885
  acs_encoder_ids: {
22769
22886
  description:
22770
- 'IDs of the `acs_encoder`s that you want to retrieve.',
22887
+ 'IDs of the encoders that you want to retrieve.',
22771
22888
  items: { format: 'uuid', type: 'string' },
22772
22889
  type: 'array',
22773
22890
  },
22774
22891
  limit: {
22775
22892
  default: 500,
22776
- description: 'Number of `acs_encoders` to return.',
22893
+ description: 'Number of encoders to return.',
22777
22894
  format: 'float',
22778
22895
  type: 'number',
22779
22896
  },
@@ -22833,7 +22950,7 @@ export default {
22833
22950
  schema: {
22834
22951
  properties: {
22835
22952
  acs_encoder_id: {
22836
- description: 'ID of the `acs_encoder` to use for the scan.',
22953
+ description: 'ID of the encoder to use for the scan.',
22837
22954
  format: 'uuid',
22838
22955
  type: 'string',
22839
22956
  },
@@ -23220,14 +23337,18 @@ export default {
23220
23337
  '/acs/entrances/get': {
23221
23338
  post: {
23222
23339
  description:
23223
- 'Returns a specified [ACS entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
23340
+ 'Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
23224
23341
  operationId: 'acsEntrancesGetPost',
23225
23342
  requestBody: {
23226
23343
  content: {
23227
23344
  'application/json': {
23228
23345
  schema: {
23229
23346
  properties: {
23230
- acs_entrance_id: { format: 'uuid', type: 'string' },
23347
+ acs_entrance_id: {
23348
+ description: 'ID of the entrance that you want to get.',
23349
+ format: 'uuid',
23350
+ type: 'string',
23351
+ },
23231
23352
  },
23232
23353
  required: ['acs_entrance_id'],
23233
23354
  type: 'object',
@@ -23271,14 +23392,26 @@ export default {
23271
23392
  },
23272
23393
  '/acs/entrances/grant_access': {
23273
23394
  post: {
23395
+ description:
23396
+ '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).',
23274
23397
  operationId: 'acsEntrancesGrantAccessPost',
23275
23398
  requestBody: {
23276
23399
  content: {
23277
23400
  'application/json': {
23278
23401
  schema: {
23279
23402
  properties: {
23280
- acs_entrance_id: { format: 'uuid', type: 'string' },
23281
- acs_user_id: { format: 'uuid', type: 'string' },
23403
+ acs_entrance_id: {
23404
+ description:
23405
+ 'ID of the entrance to which you want to grant an access system user access.',
23406
+ format: 'uuid',
23407
+ type: 'string',
23408
+ },
23409
+ acs_user_id: {
23410
+ description:
23411
+ 'ID of the access system user to whom you want to grant access to an entrance.',
23412
+ format: 'uuid',
23413
+ type: 'string',
23414
+ },
23282
23415
  },
23283
23416
  required: ['acs_entrance_id', 'acs_user_id'],
23284
23417
  type: 'object',
@@ -23318,16 +23451,28 @@ export default {
23318
23451
  '/acs/entrances/list': {
23319
23452
  post: {
23320
23453
  description:
23321
- 'Returns a list of all [ACS entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
23454
+ 'Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
23322
23455
  operationId: 'acsEntrancesListPost',
23323
23456
  requestBody: {
23324
23457
  content: {
23325
23458
  'application/json': {
23326
23459
  schema: {
23327
23460
  properties: {
23328
- acs_credential_id: { format: 'uuid', type: 'string' },
23329
- acs_system_id: { format: 'uuid', type: 'string' },
23461
+ acs_credential_id: {
23462
+ description:
23463
+ 'ID of the credential for which you want to retrieve all entrances.',
23464
+ format: 'uuid',
23465
+ type: 'string',
23466
+ },
23467
+ acs_system_id: {
23468
+ description:
23469
+ 'ID of the access system for which you want to retrieve all entrances.',
23470
+ format: 'uuid',
23471
+ type: 'string',
23472
+ },
23330
23473
  location_id: {
23474
+ description:
23475
+ 'ID of the location for which you want to retrieve all entrances.',
23331
23476
  format: 'uuid',
23332
23477
  nullable: true,
23333
23478
  type: 'string',
@@ -23386,8 +23531,15 @@ export default {
23386
23531
  'application/json': {
23387
23532
  schema: {
23388
23533
  properties: {
23389
- acs_entrance_id: { format: 'uuid', type: 'string' },
23534
+ acs_entrance_id: {
23535
+ description:
23536
+ 'ID of the entrance for which you want to list all credentials that grant access.',
23537
+ format: 'uuid',
23538
+ type: 'string',
23539
+ },
23390
23540
  include_if: {
23541
+ description:
23542
+ 'Conditions that credentials must meet to be included in the returned list.',
23391
23543
  items: {
23392
23544
  enum: ['visionline_metadata.is_valid'],
23393
23545
  type: 'string',
@@ -23441,7 +23593,7 @@ export default {
23441
23593
  '/acs/systems/get': {
23442
23594
  post: {
23443
23595
  description:
23444
- '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.',
23596
+ 'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',
23445
23597
  operationId: 'acsSystemsGetPost',
23446
23598
  requestBody: {
23447
23599
  content: {
@@ -23449,7 +23601,8 @@ export default {
23449
23601
  schema: {
23450
23602
  properties: {
23451
23603
  acs_system_id: {
23452
- description: 'ID of the desired access control system.',
23604
+ description:
23605
+ 'ID of the access system that you want to get.',
23453
23606
  format: 'uuid',
23454
23607
  type: 'string',
23455
23608
  },
@@ -23496,7 +23649,7 @@ export default {
23496
23649
  '/acs/systems/list': {
23497
23650
  post: {
23498
23651
  description:
23499
- '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.',
23652
+ '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.',
23500
23653
  operationId: 'acsSystemsListPost',
23501
23654
  requestBody: {
23502
23655
  content: {
@@ -23505,7 +23658,7 @@ export default {
23505
23658
  properties: {
23506
23659
  connected_account_id: {
23507
23660
  description:
23508
- 'ID of the connected account by which to filter the list of returned access control systems.',
23661
+ 'ID of the connected account by which you want to filter the list of access systems.',
23509
23662
  format: 'uuid',
23510
23663
  type: 'string',
23511
23664
  },
@@ -23555,7 +23708,7 @@ export default {
23555
23708
  '/acs/systems/list_compatible_credential_manager_acs_systems': {
23556
23709
  post: {
23557
23710
  description:
23558
- '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.',
23711
+ '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.',
23559
23712
  operationId: 'acsSystemsListCompatibleCredentialManagerAcsSystemsPost',
23560
23713
  requestBody: {
23561
23714
  content: {
@@ -23564,7 +23717,7 @@ export default {
23564
23717
  properties: {
23565
23718
  acs_system_id: {
23566
23719
  description:
23567
- 'ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems.',
23720
+ 'ID of the access system for which you want to retrieve all compatible credential manager systems.',
23568
23721
  format: 'uuid',
23569
23722
  type: 'string',
23570
23723
  },
@@ -23615,7 +23768,7 @@ export default {
23615
23768
  '/acs/users/add_to_access_group': {
23616
23769
  post: {
23617
23770
  description:
23618
- '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).',
23771
+ '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).',
23619
23772
  operationId: 'acsUsersAddToAccessGroupPost',
23620
23773
  requestBody: {
23621
23774
  content: {
@@ -23623,12 +23776,14 @@ export default {
23623
23776
  schema: {
23624
23777
  properties: {
23625
23778
  acs_access_group_id: {
23626
- description: 'ID of the desired access group.',
23779
+ description:
23780
+ 'ID of the access group to which you want to add an access system user.',
23627
23781
  format: 'uuid',
23628
23782
  type: 'string',
23629
23783
  },
23630
23784
  acs_user_id: {
23631
- description: 'ID of the desired `acs_user`.',
23785
+ description:
23786
+ 'ID of the access system user that you want to add to an access group.',
23632
23787
  format: 'uuid',
23633
23788
  type: 'string',
23634
23789
  },
@@ -23669,7 +23824,7 @@ export default {
23669
23824
  },
23670
23825
  put: {
23671
23826
  description:
23672
- '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).',
23827
+ '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).',
23673
23828
  operationId: 'acsUsersAddToAccessGroupPut',
23674
23829
  requestBody: {
23675
23830
  content: {
@@ -23677,12 +23832,14 @@ export default {
23677
23832
  schema: {
23678
23833
  properties: {
23679
23834
  acs_access_group_id: {
23680
- description: 'ID of the desired access group.',
23835
+ description:
23836
+ 'ID of the access group to which you want to add an access system user.',
23681
23837
  format: 'uuid',
23682
23838
  type: 'string',
23683
23839
  },
23684
23840
  acs_user_id: {
23685
- description: 'ID of the desired `acs_user`.',
23841
+ description:
23842
+ 'ID of the access system user that you want to add to an access group.',
23686
23843
  format: 'uuid',
23687
23844
  type: 'string',
23688
23845
  },
@@ -23724,7 +23881,7 @@ export default {
23724
23881
  '/acs/users/create': {
23725
23882
  post: {
23726
23883
  description:
23727
- 'Creates a new [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
23884
+ 'Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
23728
23885
  operationId: 'acsUsersCreatePost',
23729
23886
  requestBody: {
23730
23887
  content: {
@@ -23733,27 +23890,34 @@ export default {
23733
23890
  properties: {
23734
23891
  access_schedule: {
23735
23892
  description:
23736
- "`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`.",
23893
+ "`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`.",
23737
23894
  properties: {
23738
23895
  ends_at: {
23896
+ description:
23897
+ "Ending timestamp for the new access system user's access.",
23739
23898
  format: 'date-time',
23740
23899
  nullable: true,
23741
23900
  type: 'string',
23742
23901
  },
23743
- starts_at: { format: 'date-time', type: 'string' },
23902
+ starts_at: {
23903
+ description:
23904
+ "Starting timestamp for the new access system user's access.",
23905
+ format: 'date-time',
23906
+ type: 'string',
23907
+ },
23744
23908
  },
23745
23909
  type: 'object',
23746
23910
  },
23747
23911
  acs_access_group_ids: {
23748
23912
  default: [],
23749
23913
  description:
23750
- 'Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`.',
23914
+ 'Array of access group IDs to indicate the access groups to which you want to add the new access system user.',
23751
23915
  items: { format: 'uuid', type: 'string' },
23752
23916
  type: 'array',
23753
23917
  },
23754
23918
  acs_system_id: {
23755
23919
  description:
23756
- 'ID of the `acs_system` to which to add the new `acs_user`.',
23920
+ 'ID of the access system to which you want to add the new access system user.',
23757
23921
  format: 'uuid',
23758
23922
  type: 'string',
23759
23923
  },
@@ -23770,7 +23934,7 @@ export default {
23770
23934
  type: 'string',
23771
23935
  },
23772
23936
  full_name: {
23773
- description: 'Full name of the new `acs_user`.',
23937
+ description: 'Full name of the new access system user.',
23774
23938
  type: 'string',
23775
23939
  },
23776
23940
  phone_number: {
@@ -23780,7 +23944,7 @@ export default {
23780
23944
  },
23781
23945
  user_identity_id: {
23782
23946
  description:
23783
- 'ID of the user identity with which to associate the new `acs_user`.',
23947
+ 'ID of the user identity with which you want to associate the new access system user.',
23784
23948
  format: 'uuid',
23785
23949
  type: 'string',
23786
23950
  },
@@ -23827,7 +23991,7 @@ export default {
23827
23991
  '/acs/users/delete': {
23828
23992
  post: {
23829
23993
  description:
23830
- "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).",
23994
+ "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).",
23831
23995
  operationId: 'acsUsersDeletePost',
23832
23996
  requestBody: {
23833
23997
  content: {
@@ -23835,7 +23999,8 @@ export default {
23835
23999
  schema: {
23836
24000
  properties: {
23837
24001
  acs_user_id: {
23838
- description: 'ID of the desired `acs_user`.',
24002
+ description:
24003
+ 'ID of the access system user that you want to delete.',
23839
24004
  format: 'uuid',
23840
24005
  type: 'string',
23841
24006
  },
@@ -23878,7 +24043,7 @@ export default {
23878
24043
  '/acs/users/get': {
23879
24044
  post: {
23880
24045
  description:
23881
- 'Returns a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24046
+ 'Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
23882
24047
  operationId: 'acsUsersGetPost',
23883
24048
  requestBody: {
23884
24049
  content: {
@@ -23886,7 +24051,8 @@ export default {
23886
24051
  schema: {
23887
24052
  properties: {
23888
24053
  acs_user_id: {
23889
- description: 'ID of the desired `acs_user`.',
24054
+ description:
24055
+ 'ID of the access system user that you want to get.',
23890
24056
  format: 'uuid',
23891
24057
  type: 'string',
23892
24058
  },
@@ -23933,7 +24099,7 @@ export default {
23933
24099
  '/acs/users/list': {
23934
24100
  post: {
23935
24101
  description:
23936
- 'Returns a list of all [ACS users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24102
+ 'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
23937
24103
  operationId: 'acsUsersListPost',
23938
24104
  requestBody: {
23939
24105
  content: {
@@ -23942,11 +24108,16 @@ export default {
23942
24108
  properties: {
23943
24109
  acs_system_id: {
23944
24110
  description:
23945
- 'ID of the `acs_system` for which you want to retrieve all `acs_user`s.',
24111
+ 'ID of the `acs_system` for which you want to retrieve all access system users.',
23946
24112
  format: 'uuid',
23947
24113
  type: 'string',
23948
24114
  },
23949
- created_before: { format: 'date-time', type: 'string' },
24115
+ created_before: {
24116
+ description:
24117
+ 'Timestamp by which to limit returned access system users. Returns users created before this timestamp.',
24118
+ format: 'date-time',
24119
+ type: 'string',
24120
+ },
23950
24121
  limit: {
23951
24122
  default: 500,
23952
24123
  description:
@@ -23963,24 +24134,24 @@ export default {
23963
24134
  },
23964
24135
  search: {
23965
24136
  description:
23966
- '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`.',
24137
+ '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`.',
23967
24138
  minLength: 1,
23968
24139
  type: 'string',
23969
24140
  },
23970
24141
  user_identity_email_address: {
23971
24142
  description:
23972
- 'Email address of the user identity for which you want to retrieve all `acs_user`s.',
24143
+ 'Email address of the user identity for which you want to retrieve all access system users.',
23973
24144
  type: 'string',
23974
24145
  },
23975
24146
  user_identity_id: {
23976
24147
  description:
23977
- 'ID of the user identity for which you want to retrieve all `acs_user`s.',
24148
+ 'ID of the user identity for which you want to retrieve all access system users.',
23978
24149
  format: 'uuid',
23979
24150
  type: 'string',
23980
24151
  },
23981
24152
  user_identity_phone_number: {
23982
24153
  description:
23983
- '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`).',
24154
+ '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`).',
23984
24155
  type: 'string',
23985
24156
  },
23986
24157
  },
@@ -24030,7 +24201,7 @@ export default {
24030
24201
  '/acs/users/list_accessible_entrances': {
24031
24202
  post: {
24032
24203
  description:
24033
- '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.',
24204
+ '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.',
24034
24205
  operationId: 'acsUsersListAccessibleEntrancesPost',
24035
24206
  requestBody: {
24036
24207
  content: {
@@ -24038,7 +24209,8 @@ export default {
24038
24209
  schema: {
24039
24210
  properties: {
24040
24211
  acs_user_id: {
24041
- description: 'ID of the desired `acs_user`.',
24212
+ description:
24213
+ 'ID of the access system user for whom you want to list accessible entrances.',
24042
24214
  format: 'uuid',
24043
24215
  type: 'string',
24044
24216
  },
@@ -24089,7 +24261,7 @@ export default {
24089
24261
  '/acs/users/remove_from_access_group': {
24090
24262
  post: {
24091
24263
  description:
24092
- '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).',
24264
+ '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).',
24093
24265
  operationId: 'acsUsersRemoveFromAccessGroupPost',
24094
24266
  requestBody: {
24095
24267
  content: {
@@ -24097,12 +24269,14 @@ export default {
24097
24269
  schema: {
24098
24270
  properties: {
24099
24271
  acs_access_group_id: {
24100
- description: 'ID of the desired access group.',
24272
+ description:
24273
+ 'ID of the access group from which you want to remove an access system user.',
24101
24274
  format: 'uuid',
24102
24275
  type: 'string',
24103
24276
  },
24104
24277
  acs_user_id: {
24105
- description: 'ID of the desired `acs_user`.',
24278
+ description:
24279
+ 'ID of the access system user that you want to remove from an access group.',
24106
24280
  format: 'uuid',
24107
24281
  type: 'string',
24108
24282
  },
@@ -24145,7 +24319,7 @@ export default {
24145
24319
  '/acs/users/revoke_access_to_all_entrances': {
24146
24320
  post: {
24147
24321
  description:
24148
- '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).',
24322
+ '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).',
24149
24323
  operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
24150
24324
  requestBody: {
24151
24325
  content: {
@@ -24153,7 +24327,8 @@ export default {
24153
24327
  schema: {
24154
24328
  properties: {
24155
24329
  acs_user_id: {
24156
- description: 'ID of the desired `acs_user`.',
24330
+ description:
24331
+ 'ID of the access system user for whom you want to revoke access.',
24157
24332
  format: 'uuid',
24158
24333
  type: 'string',
24159
24334
  },
@@ -24196,7 +24371,7 @@ export default {
24196
24371
  '/acs/users/suspend': {
24197
24372
  post: {
24198
24373
  description:
24199
- "[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.",
24374
+ "[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.",
24200
24375
  operationId: 'acsUsersSuspendPost',
24201
24376
  requestBody: {
24202
24377
  content: {
@@ -24204,7 +24379,8 @@ export default {
24204
24379
  schema: {
24205
24380
  properties: {
24206
24381
  acs_user_id: {
24207
- description: 'ID of the desired `acs_user`.',
24382
+ description:
24383
+ 'ID of the access system user that you want to suspend.',
24208
24384
  format: 'uuid',
24209
24385
  type: 'string',
24210
24386
  },
@@ -24246,12 +24422,21 @@ export default {
24246
24422
  },
24247
24423
  '/acs/users/unmanaged/get': {
24248
24424
  post: {
24425
+ description:
24426
+ 'Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24249
24427
  operationId: 'acsUsersUnmanagedGetPost',
24250
24428
  requestBody: {
24251
24429
  content: {
24252
24430
  'application/json': {
24253
24431
  schema: {
24254
- properties: { acs_user_id: { format: 'uuid', type: 'string' } },
24432
+ properties: {
24433
+ acs_user_id: {
24434
+ description:
24435
+ 'ID of the unmanaged access system user that you want to get.',
24436
+ format: 'uuid',
24437
+ type: 'string',
24438
+ },
24439
+ },
24255
24440
  required: ['acs_user_id'],
24256
24441
  type: 'object',
24257
24442
  },
@@ -24290,22 +24475,49 @@ export default {
24290
24475
  'x-fern-sdk-method-name': 'get',
24291
24476
  'x-fern-sdk-return-value': 'acs_user',
24292
24477
  'x-response-key': 'acs_user',
24478
+ 'x-title': 'Get an Unmanaged ACS User',
24293
24479
  'x-undocumented': 'No unmanaged users are currently implemented.',
24294
24480
  },
24295
24481
  },
24296
24482
  '/acs/users/unmanaged/list': {
24297
24483
  post: {
24484
+ description:
24485
+ 'Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24298
24486
  operationId: 'acsUsersUnmanagedListPost',
24299
24487
  requestBody: {
24300
24488
  content: {
24301
24489
  'application/json': {
24302
24490
  schema: {
24303
24491
  properties: {
24304
- acs_system_id: { format: 'uuid', type: 'string' },
24305
- limit: { default: 500, format: 'float', type: 'number' },
24306
- user_identity_email_address: { type: 'string' },
24307
- user_identity_id: { format: 'uuid', type: 'string' },
24308
- user_identity_phone_number: { type: 'string' },
24492
+ acs_system_id: {
24493
+ description:
24494
+ 'ID of the access system for which you want to retrieve all unmanaged access system users.',
24495
+ format: 'uuid',
24496
+ type: 'string',
24497
+ },
24498
+ limit: {
24499
+ default: 500,
24500
+ description:
24501
+ 'Number of unmanaged access system users to return.',
24502
+ format: 'float',
24503
+ type: 'number',
24504
+ },
24505
+ user_identity_email_address: {
24506
+ description:
24507
+ 'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
24508
+ type: 'string',
24509
+ },
24510
+ user_identity_id: {
24511
+ description:
24512
+ 'ID of the user identity for which you want to retrieve all unmanaged access system users.',
24513
+ format: 'uuid',
24514
+ type: 'string',
24515
+ },
24516
+ user_identity_phone_number: {
24517
+ description:
24518
+ 'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
24519
+ type: 'string',
24520
+ },
24309
24521
  },
24310
24522
  type: 'object',
24311
24523
  },
@@ -24347,13 +24559,14 @@ export default {
24347
24559
  'x-fern-sdk-method-name': 'list',
24348
24560
  'x-fern-sdk-return-value': 'acs_users',
24349
24561
  'x-response-key': 'acs_users',
24562
+ 'x-title': 'List Unmanaged ACS Users',
24350
24563
  'x-undocumented': 'No unmanaged users are currently implemented.',
24351
24564
  },
24352
24565
  },
24353
24566
  '/acs/users/unsuspend': {
24354
24567
  post: {
24355
24568
  description:
24356
- '[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.',
24569
+ '[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.',
24357
24570
  operationId: 'acsUsersUnsuspendPost',
24358
24571
  requestBody: {
24359
24572
  content: {
@@ -24361,7 +24574,8 @@ export default {
24361
24574
  schema: {
24362
24575
  properties: {
24363
24576
  acs_user_id: {
24364
- description: 'ID of the desired `acs_user`.',
24577
+ description:
24578
+ 'ID of the access system user that you want to unsuspend.',
24365
24579
  format: 'uuid',
24366
24580
  type: 'string',
24367
24581
  },
@@ -24404,7 +24618,7 @@ export default {
24404
24618
  '/acs/users/update': {
24405
24619
  patch: {
24406
24620
  description:
24407
- 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24621
+ 'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24408
24622
  operationId: 'acsUsersUpdatePatch',
24409
24623
  requestBody: {
24410
24624
  content: {
@@ -24413,11 +24627,21 @@ export default {
24413
24627
  properties: {
24414
24628
  access_schedule: {
24415
24629
  description:
24416
- "`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`.",
24630
+ "`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`.",
24417
24631
  nullable: true,
24418
24632
  properties: {
24419
- ends_at: { format: 'date-time', type: 'string' },
24420
- starts_at: { format: 'date-time', type: 'string' },
24633
+ ends_at: {
24634
+ description:
24635
+ "Ending timestamp for the access system user's access.",
24636
+ format: 'date-time',
24637
+ type: 'string',
24638
+ },
24639
+ starts_at: {
24640
+ description:
24641
+ "Starting timestamp for the access system user's access.",
24642
+ format: 'date-time',
24643
+ type: 'string',
24644
+ },
24421
24645
  },
24422
24646
  required: ['starts_at', 'ends_at'],
24423
24647
  type: 'object',
@@ -24488,7 +24712,7 @@ export default {
24488
24712
  },
24489
24713
  post: {
24490
24714
  description:
24491
- 'Updates the properties of a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24715
+ 'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
24492
24716
  operationId: 'acsUsersUpdatePost',
24493
24717
  requestBody: {
24494
24718
  content: {
@@ -24497,11 +24721,21 @@ export default {
24497
24721
  properties: {
24498
24722
  access_schedule: {
24499
24723
  description:
24500
- "`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`.",
24724
+ "`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`.",
24501
24725
  nullable: true,
24502
24726
  properties: {
24503
- ends_at: { format: 'date-time', type: 'string' },
24504
- starts_at: { format: 'date-time', type: 'string' },
24727
+ ends_at: {
24728
+ description:
24729
+ "Ending timestamp for the access system user's access.",
24730
+ format: 'date-time',
24731
+ type: 'string',
24732
+ },
24733
+ starts_at: {
24734
+ description:
24735
+ "Starting timestamp for the access system user's access.",
24736
+ format: 'date-time',
24737
+ type: 'string',
24738
+ },
24505
24739
  },
24506
24740
  required: ['starts_at', 'ends_at'],
24507
24741
  type: 'object',
@@ -24574,13 +24808,20 @@ export default {
24574
24808
  },
24575
24809
  '/action_attempts/get': {
24576
24810
  post: {
24811
+ description:
24812
+ 'Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
24577
24813
  operationId: 'actionAttemptsGetPost',
24578
24814
  requestBody: {
24579
24815
  content: {
24580
24816
  'application/json': {
24581
24817
  schema: {
24582
24818
  properties: {
24583
- action_attempt_id: { format: 'uuid', type: 'string' },
24819
+ action_attempt_id: {
24820
+ description:
24821
+ 'ID of the action attempt that you want to get.',
24822
+ format: 'uuid',
24823
+ type: 'string',
24824
+ },
24584
24825
  },
24585
24826
  required: ['action_attempt_id'],
24586
24827
  type: 'object',
@@ -24621,10 +24862,13 @@ export default {
24621
24862
  'x-fern-sdk-method-name': 'get',
24622
24863
  'x-fern-sdk-return-value': 'action_attempt',
24623
24864
  'x-response-key': 'action_attempt',
24865
+ 'x-title': 'Get an Action Attempt',
24624
24866
  },
24625
24867
  },
24626
24868
  '/action_attempts/list': {
24627
24869
  post: {
24870
+ description:
24871
+ '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.',
24628
24872
  operationId: 'actionAttemptsListPost',
24629
24873
  requestBody: {
24630
24874
  content: {
@@ -24632,6 +24876,8 @@ export default {
24632
24876
  schema: {
24633
24877
  properties: {
24634
24878
  action_attempt_ids: {
24879
+ description:
24880
+ 'IDs of the action attempts that you want to retrieve.',
24635
24881
  items: { format: 'uuid', type: 'string' },
24636
24882
  type: 'array',
24637
24883
  },
@@ -24675,16 +24921,25 @@ export default {
24675
24921
  'x-fern-sdk-method-name': 'list',
24676
24922
  'x-fern-sdk-return-value': 'action_attempts',
24677
24923
  'x-response-key': 'action_attempts',
24924
+ 'x-title': 'List Action Attempts',
24678
24925
  },
24679
24926
  },
24680
24927
  '/bridges/get': {
24681
24928
  post: {
24929
+ description:
24930
+ 'Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
24682
24931
  operationId: 'bridgesGetPost',
24683
24932
  requestBody: {
24684
24933
  content: {
24685
24934
  'application/json': {
24686
24935
  schema: {
24687
- properties: { bridge_id: { format: 'uuid', type: 'string' } },
24936
+ properties: {
24937
+ bridge_id: {
24938
+ description: 'ID of the Seam Bridge that you want to get.',
24939
+ format: 'uuid',
24940
+ type: 'string',
24941
+ },
24942
+ },
24688
24943
  required: ['bridge_id'],
24689
24944
  type: 'object',
24690
24945
  },
@@ -24731,10 +24986,14 @@ export default {
24731
24986
  'x-fern-sdk-method-name': 'get',
24732
24987
  'x-fern-sdk-return-value': 'bridge',
24733
24988
  'x-response-key': 'bridge',
24989
+ 'x-title': 'Get a Seam Bridge',
24990
+ 'x-undocumented': 'Not yet for customer use.',
24734
24991
  },
24735
24992
  },
24736
24993
  '/bridges/list': {
24737
24994
  post: {
24995
+ description:
24996
+ 'Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).',
24738
24997
  operationId: 'bridgesListPost',
24739
24998
  requestBody: {
24740
24999
  content: {
@@ -24784,10 +25043,14 @@ export default {
24784
25043
  'x-fern-sdk-method-name': 'list',
24785
25044
  'x-fern-sdk-return-value': 'bridges',
24786
25045
  'x-response-key': 'bridges',
25046
+ 'x-title': 'List Seam Bridges',
25047
+ 'x-undocumented': 'Not yet for customer use.',
24787
25048
  },
24788
25049
  },
24789
25050
  '/client_sessions/create': {
24790
25051
  post: {
25052
+ description:
25053
+ 'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
24791
25054
  operationId: 'clientSessionsCreatePost',
24792
25055
  requestBody: {
24793
25056
  content: {
@@ -24795,16 +25058,32 @@ export default {
24795
25058
  schema: {
24796
25059
  properties: {
24797
25060
  connect_webview_ids: {
25061
+ description:
25062
+ 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
24798
25063
  items: { type: 'string' },
24799
25064
  type: 'array',
24800
25065
  },
24801
25066
  connected_account_ids: {
25067
+ description:
25068
+ 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
24802
25069
  items: { type: 'string' },
24803
25070
  type: 'array',
24804
25071
  },
24805
- expires_at: { format: 'date-time', type: 'string' },
24806
- user_identifier_key: { minLength: 1, type: 'string' },
25072
+ expires_at: {
25073
+ description:
25074
+ '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.',
25075
+ format: 'date-time',
25076
+ type: 'string',
25077
+ },
25078
+ user_identifier_key: {
25079
+ description:
25080
+ 'Your user ID for the user for whom you want to create a client session.',
25081
+ minLength: 1,
25082
+ type: 'string',
25083
+ },
24807
25084
  user_identity_ids: {
25085
+ description:
25086
+ '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.',
24808
25087
  items: { type: 'string' },
24809
25088
  type: 'array',
24810
25089
  },
@@ -24847,8 +25126,11 @@ export default {
24847
25126
  'x-fern-sdk-method-name': 'create',
24848
25127
  'x-fern-sdk-return-value': 'client_session',
24849
25128
  'x-response-key': 'client_session',
25129
+ 'x-title': 'Create a Client Session',
24850
25130
  },
24851
25131
  put: {
25132
+ description:
25133
+ 'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
24852
25134
  operationId: 'clientSessionsCreatePut',
24853
25135
  requestBody: {
24854
25136
  content: {
@@ -24856,16 +25138,32 @@ export default {
24856
25138
  schema: {
24857
25139
  properties: {
24858
25140
  connect_webview_ids: {
25141
+ description:
25142
+ 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
24859
25143
  items: { type: 'string' },
24860
25144
  type: 'array',
24861
25145
  },
24862
25146
  connected_account_ids: {
25147
+ description:
25148
+ 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
24863
25149
  items: { type: 'string' },
24864
25150
  type: 'array',
24865
25151
  },
24866
- expires_at: { format: 'date-time', type: 'string' },
24867
- user_identifier_key: { minLength: 1, type: 'string' },
25152
+ expires_at: {
25153
+ description:
25154
+ '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.',
25155
+ format: 'date-time',
25156
+ type: 'string',
25157
+ },
25158
+ user_identifier_key: {
25159
+ description:
25160
+ 'Your user ID for the user for whom you want to create a client session.',
25161
+ minLength: 1,
25162
+ type: 'string',
25163
+ },
24868
25164
  user_identity_ids: {
25165
+ description:
25166
+ '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.',
24869
25167
  items: { type: 'string' },
24870
25168
  type: 'array',
24871
25169
  },
@@ -24906,17 +25204,25 @@ export default {
24906
25204
  tags: ['/client_sessions'],
24907
25205
  'x-fern-ignore': true,
24908
25206
  'x-response-key': 'client_session',
25207
+ 'x-title': 'Create a Client Session',
24909
25208
  },
24910
25209
  },
24911
25210
  '/client_sessions/delete': {
24912
25211
  post: {
25212
+ description:
25213
+ 'Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
24913
25214
  operationId: 'clientSessionsDeletePost',
24914
25215
  requestBody: {
24915
25216
  content: {
24916
25217
  'application/json': {
24917
25218
  schema: {
24918
25219
  properties: {
24919
- client_session_id: { format: 'uuid', type: 'string' },
25220
+ client_session_id: {
25221
+ description:
25222
+ 'ID of the client session that you want to delete.',
25223
+ format: 'uuid',
25224
+ type: 'string',
25225
+ },
24920
25226
  },
24921
25227
  required: ['client_session_id'],
24922
25228
  type: 'object',
@@ -24950,18 +25256,29 @@ export default {
24950
25256
  'x-fern-sdk-group-name': ['client_sessions'],
24951
25257
  'x-fern-sdk-method-name': 'delete',
24952
25258
  'x-response-key': null,
25259
+ 'x-title': 'Delete a Client Session',
24953
25260
  },
24954
25261
  },
24955
25262
  '/client_sessions/get': {
24956
25263
  post: {
25264
+ description:
25265
+ 'Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
24957
25266
  operationId: 'clientSessionsGetPost',
24958
25267
  requestBody: {
24959
25268
  content: {
24960
25269
  'application/json': {
24961
25270
  schema: {
24962
25271
  properties: {
24963
- client_session_id: { type: 'string' },
24964
- user_identifier_key: { type: 'string' },
25272
+ client_session_id: {
25273
+ description:
25274
+ 'ID of the client session that you want to get.',
25275
+ type: 'string',
25276
+ },
25277
+ user_identifier_key: {
25278
+ description:
25279
+ 'User identifier key associated with the client session that you want to get.',
25280
+ type: 'string',
25281
+ },
24965
25282
  },
24966
25283
  type: 'object',
24967
25284
  },
@@ -25001,10 +25318,13 @@ export default {
25001
25318
  'x-fern-sdk-method-name': 'get',
25002
25319
  'x-fern-sdk-return-value': 'client_session',
25003
25320
  'x-response-key': 'client_session',
25321
+ 'x-title': 'Get a Client Session',
25004
25322
  },
25005
25323
  },
25006
25324
  '/client_sessions/get_or_create': {
25007
25325
  post: {
25326
+ description:
25327
+ '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.',
25008
25328
  operationId: 'clientSessionsGetOrCreatePost',
25009
25329
  requestBody: {
25010
25330
  content: {
@@ -25012,16 +25332,32 @@ export default {
25012
25332
  schema: {
25013
25333
  properties: {
25014
25334
  connect_webview_ids: {
25335
+ description:
25336
+ '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).',
25015
25337
  items: { type: 'string' },
25016
25338
  type: 'array',
25017
25339
  },
25018
25340
  connected_account_ids: {
25341
+ description:
25342
+ '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).',
25019
25343
  items: { type: 'string' },
25020
25344
  type: 'array',
25021
25345
  },
25022
- expires_at: { format: 'date-time', type: 'string' },
25023
- user_identifier_key: { minLength: 1, type: 'string' },
25346
+ expires_at: {
25347
+ description:
25348
+ '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.',
25349
+ format: 'date-time',
25350
+ type: 'string',
25351
+ },
25352
+ user_identifier_key: {
25353
+ description:
25354
+ '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).',
25355
+ minLength: 1,
25356
+ type: 'string',
25357
+ },
25024
25358
  user_identity_ids: {
25359
+ description:
25360
+ '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).',
25025
25361
  items: { type: 'string' },
25026
25362
  type: 'array',
25027
25363
  },
@@ -25064,27 +25400,44 @@ export default {
25064
25400
  'x-fern-sdk-method-name': 'get_or_create',
25065
25401
  'x-fern-sdk-return-value': 'client_session',
25066
25402
  'x-response-key': 'client_session',
25403
+ 'x-title': 'Get or Create a Client Session',
25067
25404
  },
25068
25405
  },
25069
25406
  '/client_sessions/grant_access': {
25070
25407
  patch: {
25408
+ description:
25409
+ '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.',
25071
25410
  operationId: 'clientSessionsGrantAccessPatch',
25072
25411
  requestBody: {
25073
25412
  content: {
25074
25413
  'application/json': {
25075
25414
  schema: {
25076
25415
  properties: {
25077
- client_session_id: { type: 'string' },
25416
+ client_session_id: {
25417
+ description:
25418
+ 'ID of the client session to which you want to grant access to resources.',
25419
+ type: 'string',
25420
+ },
25078
25421
  connect_webview_ids: {
25422
+ description:
25423
+ 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
25079
25424
  items: { type: 'string' },
25080
25425
  type: 'array',
25081
25426
  },
25082
25427
  connected_account_ids: {
25428
+ description:
25429
+ 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
25083
25430
  items: { type: 'string' },
25084
25431
  type: 'array',
25085
25432
  },
25086
- user_identifier_key: { type: 'string' },
25433
+ user_identifier_key: {
25434
+ description:
25435
+ 'Your user ID for the user that you want to associate with the client session.',
25436
+ type: 'string',
25437
+ },
25087
25438
  user_identity_ids: {
25439
+ description:
25440
+ '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.',
25088
25441
  items: { type: 'string' },
25089
25442
  type: 'array',
25090
25443
  },
@@ -25124,25 +25477,42 @@ export default {
25124
25477
  tags: ['/client_sessions'],
25125
25478
  'x-fern-ignore': true,
25126
25479
  'x-response-key': null,
25480
+ 'x-title': 'Grant Access to a Client Session',
25127
25481
  },
25128
25482
  post: {
25483
+ description:
25484
+ '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.',
25129
25485
  operationId: 'clientSessionsGrantAccessPost',
25130
25486
  requestBody: {
25131
25487
  content: {
25132
25488
  'application/json': {
25133
25489
  schema: {
25134
25490
  properties: {
25135
- client_session_id: { type: 'string' },
25491
+ client_session_id: {
25492
+ description:
25493
+ 'ID of the client session to which you want to grant access to resources.',
25494
+ type: 'string',
25495
+ },
25136
25496
  connect_webview_ids: {
25497
+ description:
25498
+ 'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
25137
25499
  items: { type: 'string' },
25138
25500
  type: 'array',
25139
25501
  },
25140
25502
  connected_account_ids: {
25503
+ description:
25504
+ 'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
25141
25505
  items: { type: 'string' },
25142
25506
  type: 'array',
25143
25507
  },
25144
- user_identifier_key: { type: 'string' },
25508
+ user_identifier_key: {
25509
+ description:
25510
+ 'Your user ID for the user that you want to associate with the client session.',
25511
+ type: 'string',
25512
+ },
25145
25513
  user_identity_ids: {
25514
+ description:
25515
+ '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.',
25146
25516
  items: { type: 'string' },
25147
25517
  type: 'array',
25148
25518
  },
@@ -25183,21 +25553,44 @@ export default {
25183
25553
  'x-fern-sdk-group-name': ['client_sessions'],
25184
25554
  'x-fern-sdk-method-name': 'grant_access',
25185
25555
  'x-response-key': null,
25556
+ 'x-title': 'Grant Access to a Client Session',
25186
25557
  },
25187
25558
  },
25188
25559
  '/client_sessions/list': {
25189
25560
  post: {
25561
+ description:
25562
+ 'Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
25190
25563
  operationId: 'clientSessionsListPost',
25191
25564
  requestBody: {
25192
25565
  content: {
25193
25566
  'application/json': {
25194
25567
  schema: {
25195
25568
  properties: {
25196
- client_session_id: { type: 'string' },
25197
- connect_webview_id: { type: 'string' },
25198
- user_identifier_key: { type: 'string' },
25199
- user_identity_id: { type: 'string' },
25200
- without_user_identifier_key: { type: 'boolean' },
25569
+ client_session_id: {
25570
+ description:
25571
+ 'ID of the client session that you want to retrieve.',
25572
+ type: 'string',
25573
+ },
25574
+ connect_webview_id: {
25575
+ description:
25576
+ 'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
25577
+ type: 'string',
25578
+ },
25579
+ user_identifier_key: {
25580
+ description:
25581
+ 'Your user ID for the user by which you want to filter client sessions.',
25582
+ type: 'string',
25583
+ },
25584
+ user_identity_id: {
25585
+ description:
25586
+ '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.',
25587
+ type: 'string',
25588
+ },
25589
+ without_user_identifier_key: {
25590
+ description:
25591
+ 'Indicates whether to retrieve only client sessions without associated user identifier keys.',
25592
+ type: 'boolean',
25593
+ },
25201
25594
  },
25202
25595
  type: 'object',
25203
25596
  },
@@ -25237,17 +25630,25 @@ export default {
25237
25630
  'x-fern-sdk-method-name': 'list',
25238
25631
  'x-fern-sdk-return-value': 'client_sessions',
25239
25632
  'x-response-key': 'client_sessions',
25633
+ 'x-title': 'List Client Sessions',
25240
25634
  },
25241
25635
  },
25242
25636
  '/client_sessions/revoke': {
25243
25637
  post: {
25638
+ description:
25639
+ '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.',
25244
25640
  operationId: 'clientSessionsRevokePost',
25245
25641
  requestBody: {
25246
25642
  content: {
25247
25643
  'application/json': {
25248
25644
  schema: {
25249
25645
  properties: {
25250
- client_session_id: { format: 'uuid', type: 'string' },
25646
+ client_session_id: {
25647
+ description:
25648
+ 'ID of the client session that you want to revoke.',
25649
+ format: 'uuid',
25650
+ type: 'string',
25651
+ },
25251
25652
  },
25252
25653
  required: ['client_session_id'],
25253
25654
  type: 'object',
@@ -25281,10 +25682,13 @@ export default {
25281
25682
  'x-fern-sdk-group-name': ['client_sessions'],
25282
25683
  'x-fern-sdk-method-name': 'revoke',
25283
25684
  'x-response-key': null,
25685
+ 'x-title': 'Revoke a Client Session',
25284
25686
  },
25285
25687
  },
25286
25688
  '/connect_webviews/create': {
25287
25689
  post: {
25690
+ description:
25691
+ '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).',
25288
25692
  operationId: 'connectWebviewsCreatePost',
25289
25693
  requestBody: {
25290
25694
  content: {
@@ -25292,6 +25696,8 @@ export default {
25292
25696
  schema: {
25293
25697
  properties: {
25294
25698
  accepted_providers: {
25699
+ description:
25700
+ '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.',
25295
25701
  items: {
25296
25702
  enum: [
25297
25703
  'dormakaba_community',
@@ -25351,6 +25757,8 @@ export default {
25351
25757
  },
25352
25758
  automatically_manage_new_devices: {
25353
25759
  default: true,
25760
+ description:
25761
+ '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).',
25354
25762
  type: 'boolean',
25355
25763
  },
25356
25764
  custom_metadata: {
@@ -25361,15 +25769,28 @@ export default {
25361
25769
  { type: 'boolean' },
25362
25770
  ],
25363
25771
  },
25772
+ description:
25773
+ '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).',
25364
25774
  type: 'object',
25365
25775
  },
25366
- custom_redirect_failure_url: { type: 'string' },
25367
- custom_redirect_url: { type: 'string' },
25776
+ custom_redirect_failure_url: {
25777
+ description:
25778
+ '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`.',
25779
+ type: 'string',
25780
+ },
25781
+ custom_redirect_url: {
25782
+ description:
25783
+ 'URL that you want to redirect the user to after the provider login is complete.',
25784
+ type: 'string',
25785
+ },
25368
25786
  device_selection_mode: {
25369
25787
  enum: ['none', 'single', 'multiple'],
25370
25788
  type: 'string',
25789
+ 'x-undocumented': 'Not supported.',
25371
25790
  },
25372
25791
  provider_category: {
25792
+ description:
25793
+ '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.',
25373
25794
  enum: [
25374
25795
  'stable',
25375
25796
  'consumer_smartlocks',
@@ -25380,7 +25801,12 @@ export default {
25380
25801
  ],
25381
25802
  type: 'string',
25382
25803
  },
25383
- wait_for_device_creation: { default: false, type: 'boolean' },
25804
+ wait_for_device_creation: {
25805
+ default: false,
25806
+ description:
25807
+ '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).',
25808
+ type: 'boolean',
25809
+ },
25384
25810
  },
25385
25811
  type: 'object',
25386
25812
  },
@@ -25420,17 +25846,25 @@ export default {
25420
25846
  'x-fern-sdk-method-name': 'create',
25421
25847
  'x-fern-sdk-return-value': 'connect_webview',
25422
25848
  'x-response-key': 'connect_webview',
25849
+ 'x-title': 'Create a Connect Webview',
25423
25850
  },
25424
25851
  },
25425
25852
  '/connect_webviews/delete': {
25426
25853
  post: {
25854
+ description:
25855
+ '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.',
25427
25856
  operationId: 'connectWebviewsDeletePost',
25428
25857
  requestBody: {
25429
25858
  content: {
25430
25859
  'application/json': {
25431
25860
  schema: {
25432
25861
  properties: {
25433
- connect_webview_id: { format: 'uuid', type: 'string' },
25862
+ connect_webview_id: {
25863
+ description:
25864
+ 'ID of the Connect Webview that you want to delete.',
25865
+ format: 'uuid',
25866
+ type: 'string',
25867
+ },
25434
25868
  },
25435
25869
  required: ['connect_webview_id'],
25436
25870
  type: 'object',
@@ -25464,17 +25898,25 @@ export default {
25464
25898
  'x-fern-sdk-group-name': ['connect_webviews'],
25465
25899
  'x-fern-sdk-method-name': 'delete',
25466
25900
  'x-response-key': null,
25901
+ 'x-title': 'Delete a Connect Webview',
25467
25902
  },
25468
25903
  },
25469
25904
  '/connect_webviews/get': {
25470
25905
  post: {
25906
+ description:
25907
+ "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.",
25471
25908
  operationId: 'connectWebviewsGetPost',
25472
25909
  requestBody: {
25473
25910
  content: {
25474
25911
  'application/json': {
25475
25912
  schema: {
25476
25913
  properties: {
25477
- connect_webview_id: { format: 'uuid', type: 'string' },
25914
+ connect_webview_id: {
25915
+ description:
25916
+ 'ID of the Connect Webview that you want to get.',
25917
+ format: 'uuid',
25918
+ type: 'string',
25919
+ },
25478
25920
  },
25479
25921
  required: ['connect_webview_id'],
25480
25922
  type: 'object',
@@ -25515,10 +25957,13 @@ export default {
25515
25957
  'x-fern-sdk-method-name': 'get',
25516
25958
  'x-fern-sdk-return-value': 'connect_webview',
25517
25959
  'x-response-key': 'connect_webview',
25960
+ 'x-title': 'Get a Connect Webview',
25518
25961
  },
25519
25962
  },
25520
25963
  '/connect_webviews/list': {
25521
25964
  post: {
25965
+ description:
25966
+ 'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
25522
25967
  operationId: 'connectWebviewsListPost',
25523
25968
  requestBody: {
25524
25969
  content: {
@@ -25530,13 +25975,19 @@ export default {
25530
25975
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
25531
25976
  },
25532
25977
  description:
25533
- 'Returns webviews whose custom_metadata contains all of the provided key/value pairs.',
25978
+ '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.',
25534
25979
  type: 'object',
25535
25980
  },
25536
- limit: { default: 500, format: 'float', type: 'number' },
25981
+ limit: {
25982
+ default: 500,
25983
+ description:
25984
+ 'Maximum number of records to return per page.',
25985
+ format: 'float',
25986
+ type: 'number',
25987
+ },
25537
25988
  user_identifier_key: {
25538
25989
  description:
25539
- 'Returns webviews that can be accessed by the provided user_identifier_key.',
25990
+ 'Your user ID for the user by which you want to filter Connect Webviews.',
25540
25991
  type: 'string',
25541
25992
  },
25542
25993
  },
@@ -25579,18 +26030,30 @@ export default {
25579
26030
  'x-fern-sdk-method-name': 'list',
25580
26031
  'x-fern-sdk-return-value': 'connect_webviews',
25581
26032
  'x-response-key': 'connect_webviews',
26033
+ 'x-title': 'List Connect Webviews',
25582
26034
  },
25583
26035
  },
25584
26036
  '/connected_accounts/delete': {
25585
26037
  post: {
26038
+ description:
26039
+ '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.',
25586
26040
  operationId: 'connectedAccountsDeletePost',
25587
26041
  requestBody: {
25588
26042
  content: {
25589
26043
  'application/json': {
25590
26044
  schema: {
25591
26045
  properties: {
25592
- connected_account_id: { format: 'uuid', type: 'string' },
25593
- sync: { default: false, type: 'boolean' },
26046
+ connected_account_id: {
26047
+ description:
26048
+ 'ID of the connected account that you want to delete.',
26049
+ format: 'uuid',
26050
+ type: 'string',
26051
+ },
26052
+ sync: {
26053
+ default: false,
26054
+ type: 'boolean',
26055
+ 'x-undocumented': 'Only used internally.',
26056
+ },
25594
26057
  },
25595
26058
  required: ['connected_account_id'],
25596
26059
  type: 'object',
@@ -25629,6 +26092,8 @@ export default {
25629
26092
  },
25630
26093
  '/connected_accounts/get': {
25631
26094
  post: {
26095
+ description:
26096
+ 'Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
25632
26097
  operationId: 'connectedAccountsGetPost',
25633
26098
  requestBody: {
25634
26099
  content: {
@@ -25637,13 +26102,25 @@ export default {
25637
26102
  oneOf: [
25638
26103
  {
25639
26104
  properties: {
25640
- connected_account_id: { format: 'uuid', type: 'string' },
26105
+ connected_account_id: {
26106
+ description:
26107
+ 'ID of the connected account that you want to get.',
26108
+ format: 'uuid',
26109
+ type: 'string',
26110
+ },
25641
26111
  },
25642
26112
  required: ['connected_account_id'],
25643
26113
  type: 'object',
25644
26114
  },
25645
26115
  {
25646
- properties: { email: { format: 'email', type: 'string' } },
26116
+ properties: {
26117
+ email: {
26118
+ description:
26119
+ 'Email address associated with the connected account that you want to get.',
26120
+ format: 'email',
26121
+ type: 'string',
26122
+ },
26123
+ },
25647
26124
  required: ['email'],
25648
26125
  type: 'object',
25649
26126
  },
@@ -25690,6 +26167,8 @@ export default {
25690
26167
  },
25691
26168
  '/connected_accounts/list': {
25692
26169
  post: {
26170
+ description:
26171
+ 'Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).',
25693
26172
  operationId: 'connectedAccountsListPost',
25694
26173
  requestBody: {
25695
26174
  content: {
@@ -25701,7 +26180,7 @@ export default {
25701
26180
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
25702
26181
  },
25703
26182
  description:
25704
- 'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
26183
+ '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.',
25705
26184
  type: 'object',
25706
26185
  },
25707
26186
  customer_ids: {
@@ -25724,7 +26203,7 @@ export default {
25724
26203
  },
25725
26204
  user_identifier_key: {
25726
26205
  description:
25727
- 'Returns accounts that can be accessed by the provided user_identifier_key.',
26206
+ 'Your user ID for the user by which you want to filter connected accounts.',
25728
26207
  type: 'string',
25729
26208
  },
25730
26209
  },
@@ -25772,14 +26251,25 @@ export default {
25772
26251
  },
25773
26252
  '/connected_accounts/update': {
25774
26253
  post: {
26254
+ description:
26255
+ 'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
25775
26256
  operationId: 'connectedAccountsUpdatePost',
25776
26257
  requestBody: {
25777
26258
  content: {
25778
26259
  'application/json': {
25779
26260
  schema: {
25780
26261
  properties: {
25781
- automatically_manage_new_devices: { type: 'boolean' },
25782
- connected_account_id: { format: 'uuid', type: 'string' },
26262
+ automatically_manage_new_devices: {
26263
+ description:
26264
+ 'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
26265
+ type: 'boolean',
26266
+ },
26267
+ connected_account_id: {
26268
+ description:
26269
+ 'ID of the connected account that you want to update.',
26270
+ format: 'uuid',
26271
+ type: 'string',
26272
+ },
25783
26273
  custom_metadata: {
25784
26274
  additionalProperties: {
25785
26275
  nullable: true,
@@ -25788,6 +26278,8 @@ export default {
25788
26278
  { type: 'boolean' },
25789
26279
  ],
25790
26280
  },
26281
+ description:
26282
+ '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).',
25791
26283
  type: 'object',
25792
26284
  },
25793
26285
  },
@@ -25833,12 +26325,20 @@ export default {
25833
26325
  },
25834
26326
  '/devices/delete': {
25835
26327
  post: {
26328
+ description:
26329
+ 'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
25836
26330
  operationId: 'devicesDeletePost',
25837
26331
  requestBody: {
25838
26332
  content: {
25839
26333
  'application/json': {
25840
26334
  schema: {
25841
- properties: { device_id: { format: 'uuid', type: 'string' } },
26335
+ properties: {
26336
+ device_id: {
26337
+ description: 'ID of the device that you want to delete.',
26338
+ format: 'uuid',
26339
+ type: 'string',
26340
+ },
26341
+ },
25842
26342
  required: ['device_id'],
25843
26343
  type: 'object',
25844
26344
  },
@@ -25873,20 +26373,30 @@ export default {
25873
26373
  'x-fern-sdk-group-name': ['devices'],
25874
26374
  'x-fern-sdk-method-name': 'delete',
25875
26375
  'x-response-key': null,
26376
+ 'x-title': 'Delete a Device',
25876
26377
  'x-undocumented':
25877
26378
  'Deleting a device is no longer supported and will be removed.',
25878
26379
  },
25879
26380
  },
25880
26381
  '/devices/get': {
25881
26382
  post: {
26383
+ description:
26384
+ 'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
25882
26385
  operationId: 'devicesGetPost',
25883
26386
  requestBody: {
25884
26387
  content: {
25885
26388
  'application/json': {
25886
26389
  schema: {
25887
26390
  properties: {
25888
- device_id: { format: 'uuid', type: 'string' },
25889
- name: { type: 'string' },
26391
+ device_id: {
26392
+ description: 'ID of the device that you want to get.',
26393
+ format: 'uuid',
26394
+ type: 'string',
26395
+ },
26396
+ name: {
26397
+ description: 'Name of the device that you want to get.',
26398
+ type: 'string',
26399
+ },
25890
26400
  },
25891
26401
  type: 'object',
25892
26402
  },
@@ -25924,6 +26434,7 @@ export default {
25924
26434
  'x-fern-sdk-method-name': 'get',
25925
26435
  'x-fern-sdk-return-value': 'device',
25926
26436
  'x-response-key': 'device',
26437
+ 'x-title': 'Get a Device',
25927
26438
  },
25928
26439
  },
25929
26440
  '/devices/list': {
@@ -25938,25 +26449,25 @@ export default {
25938
26449
  properties: {
25939
26450
  connect_webview_id: {
25940
26451
  description:
25941
- 'ID of the Connect Webview by which to filter devices.',
26452
+ 'ID of the Connect Webview for which you want to list devices.',
25942
26453
  format: 'uuid',
25943
26454
  type: 'string',
25944
26455
  },
25945
26456
  connected_account_id: {
25946
26457
  description:
25947
- 'ID of the connected account by which to filter.',
26458
+ 'ID of the connected account for which you want to list devices.',
25948
26459
  format: 'uuid',
25949
26460
  type: 'string',
25950
26461
  },
25951
26462
  connected_account_ids: {
25952
26463
  description:
25953
- 'Array of IDs of the connected accounts by which to filter devices.',
26464
+ 'Array of IDs of the connected accounts for which you want to list devices.',
25954
26465
  items: { format: 'uuid', type: 'string' },
25955
26466
  type: 'array',
25956
26467
  },
25957
26468
  created_before: {
25958
26469
  description:
25959
- 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
26470
+ 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
25960
26471
  format: 'date-time',
25961
26472
  type: 'string',
25962
26473
  },
@@ -25965,7 +26476,7 @@ export default {
25965
26476
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
25966
26477
  },
25967
26478
  description:
25968
- '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.',
26479
+ '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.',
25969
26480
  type: 'object',
25970
26481
  },
25971
26482
  customer_ids: {
@@ -25974,12 +26485,13 @@ export default {
25974
26485
  },
25975
26486
  device_ids: {
25976
26487
  description:
25977
- 'Array of device IDs by which to filter devices.',
26488
+ 'Array of device IDs for which you want to list devices.',
25978
26489
  items: { format: 'uuid', type: 'string' },
25979
26490
  type: 'array',
25980
26491
  },
25981
26492
  device_type: {
25982
- description: 'Device type by which to filter devices.',
26493
+ description:
26494
+ 'Device type for which you want to list devices.',
25983
26495
  oneOf: [
25984
26496
  {
25985
26497
  enum: [
@@ -26037,7 +26549,7 @@ export default {
26037
26549
  },
26038
26550
  device_types: {
26039
26551
  description:
26040
- 'Array of device types by which to filter devices.',
26552
+ 'Array of device types for which you want to list devices.',
26041
26553
  items: {
26042
26554
  oneOf: [
26043
26555
  {
@@ -26144,7 +26656,8 @@ export default {
26144
26656
  type: 'number',
26145
26657
  },
26146
26658
  manufacturer: {
26147
- description: 'Manufacturer by which to filter devices.',
26659
+ description:
26660
+ 'Manufacturer for which you want to list devices.',
26148
26661
  enum: [
26149
26662
  'akuvox',
26150
26663
  'august',
@@ -26194,6 +26707,8 @@ export default {
26194
26707
  type: 'string',
26195
26708
  },
26196
26709
  unstable_location_id: {
26710
+ description:
26711
+ 'ID of the location for which you want to list devices.',
26197
26712
  format: 'uuid',
26198
26713
  nullable: true,
26199
26714
  type: 'string',
@@ -26201,7 +26716,7 @@ export default {
26201
26716
  },
26202
26717
  user_identifier_key: {
26203
26718
  description:
26204
- 'Your own internal user ID for the user by which to filter devices.',
26719
+ 'Your own internal user ID for the user for which you want to list devices.',
26205
26720
  type: 'string',
26206
26721
  },
26207
26722
  },
@@ -26250,6 +26765,8 @@ export default {
26250
26765
  },
26251
26766
  '/devices/list_device_providers': {
26252
26767
  post: {
26768
+ description:
26769
+ '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).',
26253
26770
  operationId: 'devicesListDeviceProvidersPost',
26254
26771
  requestBody: {
26255
26772
  content: {
@@ -26257,6 +26774,8 @@ export default {
26257
26774
  schema: {
26258
26775
  properties: {
26259
26776
  provider_category: {
26777
+ description:
26778
+ 'Category for which you want to list providers.',
26260
26779
  enum: [
26261
26780
  'stable',
26262
26781
  'consumer_smartlocks',
@@ -26306,16 +26825,26 @@ export default {
26306
26825
  'x-fern-sdk-method-name': 'list_device_providers',
26307
26826
  'x-fern-sdk-return-value': 'device_providers',
26308
26827
  'x-response-key': 'device_providers',
26828
+ 'x-title': 'List Device Providers',
26309
26829
  },
26310
26830
  },
26311
26831
  '/devices/simulate/connect': {
26312
26832
  post: {
26833
+ description:
26834
+ '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).',
26313
26835
  operationId: 'devicesSimulateConnectPost',
26314
26836
  requestBody: {
26315
26837
  content: {
26316
26838
  'application/json': {
26317
26839
  schema: {
26318
- properties: { device_id: { format: 'uuid', type: 'string' } },
26840
+ properties: {
26841
+ device_id: {
26842
+ description:
26843
+ 'ID of the device that you want to simulate connecting to Seam.',
26844
+ format: 'uuid',
26845
+ type: 'string',
26846
+ },
26847
+ },
26319
26848
  required: ['device_id'],
26320
26849
  type: 'object',
26321
26850
  },
@@ -26348,16 +26877,26 @@ export default {
26348
26877
  'x-fern-sdk-group-name': ['devices', 'simulate'],
26349
26878
  'x-fern-sdk-method-name': 'connect',
26350
26879
  'x-response-key': null,
26880
+ 'x-title': 'Simulate Device Connection',
26351
26881
  },
26352
26882
  },
26353
26883
  '/devices/simulate/disconnect': {
26354
26884
  post: {
26885
+ description:
26886
+ '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).',
26355
26887
  operationId: 'devicesSimulateDisconnectPost',
26356
26888
  requestBody: {
26357
26889
  content: {
26358
26890
  'application/json': {
26359
26891
  schema: {
26360
- properties: { device_id: { format: 'uuid', type: 'string' } },
26892
+ properties: {
26893
+ device_id: {
26894
+ description:
26895
+ 'ID of the device that you want to simulate disconnecting from Seam.',
26896
+ format: 'uuid',
26897
+ type: 'string',
26898
+ },
26899
+ },
26361
26900
  required: ['device_id'],
26362
26901
  type: 'object',
26363
26902
  },
@@ -26390,16 +26929,26 @@ export default {
26390
26929
  'x-fern-sdk-group-name': ['devices', 'simulate'],
26391
26930
  'x-fern-sdk-method-name': 'disconnect',
26392
26931
  'x-response-key': null,
26932
+ 'x-title': 'Simulate Device Disconnection',
26393
26933
  },
26394
26934
  },
26395
26935
  '/devices/simulate/remove': {
26396
26936
  post: {
26937
+ description:
26938
+ '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).',
26397
26939
  operationId: 'devicesSimulateRemovePost',
26398
26940
  requestBody: {
26399
26941
  content: {
26400
26942
  'application/json': {
26401
26943
  schema: {
26402
- properties: { device_id: { format: 'uuid', type: 'string' } },
26944
+ properties: {
26945
+ device_id: {
26946
+ description:
26947
+ 'ID of the device that you want to simulate removing from Seam.',
26948
+ format: 'uuid',
26949
+ type: 'string',
26950
+ },
26951
+ },
26403
26952
  required: ['device_id'],
26404
26953
  type: 'object',
26405
26954
  },
@@ -26432,18 +26981,30 @@ export default {
26432
26981
  'x-fern-sdk-group-name': ['devices', 'simulate'],
26433
26982
  'x-fern-sdk-method-name': 'remove',
26434
26983
  'x-response-key': null,
26984
+ 'x-title': 'Simulate Device Removal',
26435
26985
  },
26436
26986
  },
26437
26987
  '/devices/unmanaged/get': {
26438
26988
  post: {
26989
+ description:
26990
+ '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`.',
26439
26991
  operationId: 'devicesUnmanagedGetPost',
26440
26992
  requestBody: {
26441
26993
  content: {
26442
26994
  'application/json': {
26443
26995
  schema: {
26444
26996
  properties: {
26445
- device_id: { format: 'uuid', type: 'string' },
26446
- name: { type: 'string' },
26997
+ device_id: {
26998
+ description:
26999
+ 'ID of the unmanaged device that you want to get.',
27000
+ format: 'uuid',
27001
+ type: 'string',
27002
+ },
27003
+ name: {
27004
+ description:
27005
+ 'Name of the unmanaged device that you want to get.',
27006
+ type: 'string',
27007
+ },
26447
27008
  },
26448
27009
  type: 'object',
26449
27010
  },
@@ -26481,10 +27042,13 @@ export default {
26481
27042
  'x-fern-sdk-method-name': 'get',
26482
27043
  'x-fern-sdk-return-value': 'device',
26483
27044
  'x-response-key': 'device',
27045
+ 'x-title': 'Get an Unmanaged Device',
26484
27046
  },
26485
27047
  },
26486
27048
  '/devices/unmanaged/list': {
26487
27049
  post: {
27050
+ description:
27051
+ '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).',
26488
27052
  operationId: 'devicesUnmanagedListPost',
26489
27053
  requestBody: {
26490
27054
  content: {
@@ -26493,25 +27057,25 @@ export default {
26493
27057
  properties: {
26494
27058
  connect_webview_id: {
26495
27059
  description:
26496
- 'ID of the Connect Webview by which to filter devices.',
27060
+ 'ID of the Connect Webview for which you want to list devices.',
26497
27061
  format: 'uuid',
26498
27062
  type: 'string',
26499
27063
  },
26500
27064
  connected_account_id: {
26501
27065
  description:
26502
- 'ID of the connected account by which to filter.',
27066
+ 'ID of the connected account for which you want to list devices.',
26503
27067
  format: 'uuid',
26504
27068
  type: 'string',
26505
27069
  },
26506
27070
  connected_account_ids: {
26507
27071
  description:
26508
- 'Array of IDs of the connected accounts by which to filter devices.',
27072
+ 'Array of IDs of the connected accounts for which you want to list devices.',
26509
27073
  items: { format: 'uuid', type: 'string' },
26510
27074
  type: 'array',
26511
27075
  },
26512
27076
  created_before: {
26513
27077
  description:
26514
- 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
27078
+ 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
26515
27079
  format: 'date-time',
26516
27080
  type: 'string',
26517
27081
  },
@@ -26520,7 +27084,7 @@ export default {
26520
27084
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
26521
27085
  },
26522
27086
  description:
26523
- '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.',
27087
+ '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.',
26524
27088
  type: 'object',
26525
27089
  },
26526
27090
  customer_ids: {
@@ -26529,12 +27093,13 @@ export default {
26529
27093
  },
26530
27094
  device_ids: {
26531
27095
  description:
26532
- 'Array of device IDs by which to filter devices.',
27096
+ 'Array of device IDs for which you want to list devices.',
26533
27097
  items: { format: 'uuid', type: 'string' },
26534
27098
  type: 'array',
26535
27099
  },
26536
27100
  device_type: {
26537
- description: 'Device type by which to filter devices.',
27101
+ description:
27102
+ 'Device type for which you want to list devices.',
26538
27103
  oneOf: [
26539
27104
  {
26540
27105
  enum: [
@@ -26592,7 +27157,7 @@ export default {
26592
27157
  },
26593
27158
  device_types: {
26594
27159
  description:
26595
- 'Array of device types by which to filter devices.',
27160
+ 'Array of device types for which you want to list devices.',
26596
27161
  items: {
26597
27162
  oneOf: [
26598
27163
  {
@@ -26699,7 +27264,8 @@ export default {
26699
27264
  type: 'number',
26700
27265
  },
26701
27266
  manufacturer: {
26702
- description: 'Manufacturer by which to filter devices.',
27267
+ description:
27268
+ 'Manufacturer for which you want to list devices.',
26703
27269
  enum: [
26704
27270
  'akuvox',
26705
27271
  'august',
@@ -26749,6 +27315,8 @@ export default {
26749
27315
  type: 'string',
26750
27316
  },
26751
27317
  unstable_location_id: {
27318
+ description:
27319
+ 'ID of the location for which you want to list devices.',
26752
27320
  format: 'uuid',
26753
27321
  nullable: true,
26754
27322
  type: 'string',
@@ -26756,7 +27324,7 @@ export default {
26756
27324
  },
26757
27325
  user_identifier_key: {
26758
27326
  description:
26759
- 'Your own internal user ID for the user by which to filter devices.',
27327
+ 'Your own internal user ID for the user for which you want to list devices.',
26760
27328
  type: 'string',
26761
27329
  },
26762
27330
  },
@@ -26798,18 +27366,31 @@ export default {
26798
27366
  'x-fern-sdk-method-name': 'list',
26799
27367
  'x-fern-sdk-return-value': 'devices',
26800
27368
  'x-response-key': 'devices',
27369
+ 'x-title': 'List Unmanaged Devices',
26801
27370
  },
26802
27371
  },
26803
27372
  '/devices/unmanaged/update': {
26804
27373
  patch: {
27374
+ description:
27375
+ '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).',
26805
27376
  operationId: 'devicesUnmanagedUpdatePatch',
26806
27377
  requestBody: {
26807
27378
  content: {
26808
27379
  'application/json': {
26809
27380
  schema: {
26810
27381
  properties: {
26811
- device_id: { format: 'uuid', type: 'string' },
26812
- is_managed: { enum: [true], type: 'boolean' },
27382
+ device_id: {
27383
+ description:
27384
+ 'ID of the unmanaged device that you want to update.',
27385
+ format: 'uuid',
27386
+ type: 'string',
27387
+ },
27388
+ is_managed: {
27389
+ description:
27390
+ 'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
27391
+ enum: [true],
27392
+ type: 'boolean',
27393
+ },
26813
27394
  },
26814
27395
  required: ['device_id', 'is_managed'],
26815
27396
  type: 'object',
@@ -26842,16 +27423,29 @@ export default {
26842
27423
  tags: ['/devices'],
26843
27424
  'x-fern-ignore': true,
26844
27425
  'x-response-key': null,
27426
+ 'x-title': 'Update an Unmanaged Device',
26845
27427
  },
26846
27428
  post: {
27429
+ description:
27430
+ '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).',
26847
27431
  operationId: 'devicesUnmanagedUpdatePost',
26848
27432
  requestBody: {
26849
27433
  content: {
26850
27434
  'application/json': {
26851
27435
  schema: {
26852
27436
  properties: {
26853
- device_id: { format: 'uuid', type: 'string' },
26854
- is_managed: { enum: [true], type: 'boolean' },
27437
+ device_id: {
27438
+ description:
27439
+ 'ID of the unmanaged device that you want to update.',
27440
+ format: 'uuid',
27441
+ type: 'string',
27442
+ },
27443
+ is_managed: {
27444
+ description:
27445
+ 'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
27446
+ enum: [true],
27447
+ type: 'boolean',
27448
+ },
26855
27449
  },
26856
27450
  required: ['device_id', 'is_managed'],
26857
27451
  type: 'object',
@@ -26885,10 +27479,13 @@ export default {
26885
27479
  'x-fern-sdk-group-name': ['devices', 'unmanaged'],
26886
27480
  'x-fern-sdk-method-name': 'update',
26887
27481
  'x-response-key': null,
27482
+ 'x-title': 'Update an Unmanaged Device',
26888
27483
  },
26889
27484
  },
26890
27485
  '/devices/update': {
26891
27486
  patch: {
27487
+ description:
27488
+ "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).",
26892
27489
  operationId: 'devicesUpdatePatch',
26893
27490
  requestBody: {
26894
27491
  content: {
@@ -26903,13 +27500,34 @@ export default {
26903
27500
  { type: 'boolean' },
26904
27501
  ],
26905
27502
  },
27503
+ description:
27504
+ '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).',
26906
27505
  type: 'object',
26907
27506
  },
26908
- device_id: { format: 'uuid', type: 'string' },
26909
- is_managed: { default: true, type: 'boolean' },
26910
- name: { nullable: true, type: 'string' },
27507
+ device_id: {
27508
+ description: 'ID of the device that you want to update.',
27509
+ format: 'uuid',
27510
+ type: 'string',
27511
+ },
27512
+ is_managed: {
27513
+ default: true,
27514
+ description:
27515
+ 'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
27516
+ type: 'boolean',
27517
+ },
27518
+ name: {
27519
+ description: 'Name for the device.',
27520
+ nullable: true,
27521
+ type: 'string',
27522
+ },
26911
27523
  properties: {
26912
- properties: { name: { nullable: true, type: 'string' } },
27524
+ properties: {
27525
+ name: {
27526
+ description: 'Name for the device.',
27527
+ nullable: true,
27528
+ type: 'string',
27529
+ },
27530
+ },
26913
27531
  type: 'object',
26914
27532
  },
26915
27533
  },
@@ -26945,8 +27563,11 @@ export default {
26945
27563
  tags: ['/devices'],
26946
27564
  'x-fern-ignore': true,
26947
27565
  'x-response-key': null,
27566
+ 'x-title': 'Update a Device',
26948
27567
  },
26949
27568
  post: {
27569
+ description:
27570
+ "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).",
26950
27571
  operationId: 'devicesUpdatePost',
26951
27572
  requestBody: {
26952
27573
  content: {
@@ -26961,13 +27582,34 @@ export default {
26961
27582
  { type: 'boolean' },
26962
27583
  ],
26963
27584
  },
27585
+ description:
27586
+ '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).',
26964
27587
  type: 'object',
26965
27588
  },
26966
- device_id: { format: 'uuid', type: 'string' },
26967
- is_managed: { default: true, type: 'boolean' },
26968
- name: { nullable: true, type: 'string' },
27589
+ device_id: {
27590
+ description: 'ID of the device that you want to update.',
27591
+ format: 'uuid',
27592
+ type: 'string',
27593
+ },
27594
+ is_managed: {
27595
+ default: true,
27596
+ description:
27597
+ 'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
27598
+ type: 'boolean',
27599
+ },
27600
+ name: {
27601
+ description: 'Name for the device.',
27602
+ nullable: true,
27603
+ type: 'string',
27604
+ },
26969
27605
  properties: {
26970
- properties: { name: { nullable: true, type: 'string' } },
27606
+ properties: {
27607
+ name: {
27608
+ description: 'Name for the device.',
27609
+ nullable: true,
27610
+ type: 'string',
27611
+ },
27612
+ },
26971
27613
  type: 'object',
26972
27614
  },
26973
27615
  },
@@ -27004,10 +27646,13 @@ export default {
27004
27646
  'x-fern-sdk-group-name': ['devices'],
27005
27647
  'x-fern-sdk-method-name': 'update',
27006
27648
  'x-response-key': null,
27649
+ 'x-title': 'Update a Device',
27007
27650
  },
27008
27651
  },
27009
27652
  '/events/get': {
27010
27653
  post: {
27654
+ description:
27655
+ '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.',
27011
27656
  operationId: 'eventsGetPost',
27012
27657
  requestBody: {
27013
27658
  content: {
@@ -27055,10 +27700,13 @@ export default {
27055
27700
  'x-fern-sdk-method-name': 'get',
27056
27701
  'x-fern-sdk-return-value': 'event',
27057
27702
  'x-response-key': 'event',
27703
+ 'x-title': 'Get an Event',
27058
27704
  },
27059
27705
  },
27060
27706
  '/events/list': {
27061
27707
  post: {
27708
+ description:
27709
+ '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.',
27062
27710
  operationId: 'eventsListPost',
27063
27711
  requestBody: {
27064
27712
  content: {
@@ -27333,6 +27981,7 @@ export default {
27333
27981
  'x-fern-sdk-method-name': 'list',
27334
27982
  'x-fern-sdk-return-value': 'events',
27335
27983
  'x-response-key': 'events',
27984
+ 'x-title': 'List Events',
27336
27985
  },
27337
27986
  },
27338
27987
  '/locks/get': {
@@ -27396,25 +28045,25 @@ export default {
27396
28045
  properties: {
27397
28046
  connect_webview_id: {
27398
28047
  description:
27399
- 'ID of the Connect Webview by which to filter devices.',
28048
+ 'ID of the Connect Webview for which you want to list devices.',
27400
28049
  format: 'uuid',
27401
28050
  type: 'string',
27402
28051
  },
27403
28052
  connected_account_id: {
27404
28053
  description:
27405
- 'ID of the connected account by which to filter.',
28054
+ 'ID of the connected account for which you want to list devices.',
27406
28055
  format: 'uuid',
27407
28056
  type: 'string',
27408
28057
  },
27409
28058
  connected_account_ids: {
27410
28059
  description:
27411
- 'Array of IDs of the connected accounts by which to filter devices.',
28060
+ 'Array of IDs of the connected accounts for which you want to list devices.',
27412
28061
  items: { format: 'uuid', type: 'string' },
27413
28062
  type: 'array',
27414
28063
  },
27415
28064
  created_before: {
27416
28065
  description:
27417
- 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
28066
+ 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
27418
28067
  format: 'date-time',
27419
28068
  type: 'string',
27420
28069
  },
@@ -27423,7 +28072,7 @@ export default {
27423
28072
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
27424
28073
  },
27425
28074
  description:
27426
- '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.',
28075
+ '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.',
27427
28076
  type: 'object',
27428
28077
  },
27429
28078
  customer_ids: {
@@ -27432,7 +28081,7 @@ export default {
27432
28081
  },
27433
28082
  device_ids: {
27434
28083
  description:
27435
- 'Array of device IDs by which to filter devices.',
28084
+ 'Array of device IDs for which you want to list devices.',
27436
28085
  items: { format: 'uuid', type: 'string' },
27437
28086
  type: 'array',
27438
28087
  },
@@ -27593,6 +28242,8 @@ export default {
27593
28242
  type: 'string',
27594
28243
  },
27595
28244
  unstable_location_id: {
28245
+ description:
28246
+ 'ID of the location for which you want to list devices.',
27596
28247
  format: 'uuid',
27597
28248
  nullable: true,
27598
28249
  type: 'string',
@@ -27600,7 +28251,7 @@ export default {
27600
28251
  },
27601
28252
  user_identifier_key: {
27602
28253
  description:
27603
- 'Your own internal user ID for the user by which to filter devices.',
28254
+ 'Your own internal user ID for the user for which you want to list devices.',
27604
28255
  type: 'string',
27605
28256
  },
27606
28257
  },
@@ -27957,25 +28608,25 @@ export default {
27957
28608
  properties: {
27958
28609
  connect_webview_id: {
27959
28610
  description:
27960
- 'ID of the Connect Webview by which to filter devices.',
28611
+ 'ID of the Connect Webview for which you want to list devices.',
27961
28612
  format: 'uuid',
27962
28613
  type: 'string',
27963
28614
  },
27964
28615
  connected_account_id: {
27965
28616
  description:
27966
- 'ID of the connected account by which to filter.',
28617
+ 'ID of the connected account for which you want to list devices.',
27967
28618
  format: 'uuid',
27968
28619
  type: 'string',
27969
28620
  },
27970
28621
  connected_account_ids: {
27971
28622
  description:
27972
- 'Array of IDs of the connected accounts by which to filter devices.',
28623
+ 'Array of IDs of the connected accounts for which you want to list devices.',
27973
28624
  items: { format: 'uuid', type: 'string' },
27974
28625
  type: 'array',
27975
28626
  },
27976
28627
  created_before: {
27977
28628
  description:
27978
- 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
28629
+ 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
27979
28630
  format: 'date-time',
27980
28631
  type: 'string',
27981
28632
  },
@@ -27984,7 +28635,7 @@ export default {
27984
28635
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
27985
28636
  },
27986
28637
  description:
27987
- '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.',
28638
+ '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.',
27988
28639
  type: 'object',
27989
28640
  },
27990
28641
  customer_ids: {
@@ -27993,7 +28644,7 @@ export default {
27993
28644
  },
27994
28645
  device_ids: {
27995
28646
  description:
27996
- 'Array of device IDs by which to filter devices.',
28647
+ 'Array of device IDs for which you want to list devices.',
27997
28648
  items: { format: 'uuid', type: 'string' },
27998
28649
  type: 'array',
27999
28650
  },
@@ -28070,6 +28721,8 @@ export default {
28070
28721
  type: 'string',
28071
28722
  },
28072
28723
  unstable_location_id: {
28724
+ description:
28725
+ 'ID of the location for which you want to list devices.',
28073
28726
  format: 'uuid',
28074
28727
  nullable: true,
28075
28728
  type: 'string',
@@ -28077,7 +28730,7 @@ export default {
28077
28730
  },
28078
28731
  user_identifier_key: {
28079
28732
  description:
28080
- 'Your own internal user ID for the user by which to filter devices.',
28733
+ 'Your own internal user ID for the user for which you want to list devices.',
28081
28734
  type: 'string',
28082
28735
  },
28083
28736
  },
@@ -31011,25 +31664,25 @@ export default {
31011
31664
  properties: {
31012
31665
  connect_webview_id: {
31013
31666
  description:
31014
- 'ID of the Connect Webview by which to filter devices.',
31667
+ 'ID of the Connect Webview for which you want to list devices.',
31015
31668
  format: 'uuid',
31016
31669
  type: 'string',
31017
31670
  },
31018
31671
  connected_account_id: {
31019
31672
  description:
31020
- 'ID of the connected account by which to filter.',
31673
+ 'ID of the connected account for which you want to list devices.',
31021
31674
  format: 'uuid',
31022
31675
  type: 'string',
31023
31676
  },
31024
31677
  connected_account_ids: {
31025
31678
  description:
31026
- 'Array of IDs of the connected accounts by which to filter devices.',
31679
+ 'Array of IDs of the connected accounts for which you want to list devices.',
31027
31680
  items: { format: 'uuid', type: 'string' },
31028
31681
  type: 'array',
31029
31682
  },
31030
31683
  created_before: {
31031
31684
  description:
31032
- 'Date threshold for devices to return. If specified, returns only devices created before the specified date.',
31685
+ 'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
31033
31686
  format: 'date-time',
31034
31687
  type: 'string',
31035
31688
  },
@@ -31038,7 +31691,7 @@ export default {
31038
31691
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
31039
31692
  },
31040
31693
  description:
31041
- '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.',
31694
+ '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.',
31042
31695
  type: 'object',
31043
31696
  },
31044
31697
  customer_ids: {
@@ -31047,7 +31700,7 @@ export default {
31047
31700
  },
31048
31701
  device_ids: {
31049
31702
  description:
31050
- 'Array of device IDs by which to filter devices.',
31703
+ 'Array of device IDs for which you want to list devices.',
31051
31704
  items: { format: 'uuid', type: 'string' },
31052
31705
  type: 'array',
31053
31706
  },
@@ -31146,6 +31799,8 @@ export default {
31146
31799
  type: 'string',
31147
31800
  },
31148
31801
  unstable_location_id: {
31802
+ description:
31803
+ 'ID of the location for which you want to list devices.',
31149
31804
  format: 'uuid',
31150
31805
  nullable: true,
31151
31806
  type: 'string',
@@ -31153,7 +31808,7 @@ export default {
31153
31808
  },
31154
31809
  user_identifier_key: {
31155
31810
  description:
31156
- 'Your own internal user ID for the user by which to filter devices.',
31811
+ 'Your own internal user ID for the user for which you want to list devices.',
31157
31812
  type: 'string',
31158
31813
  },
31159
31814
  },
@@ -34472,6 +35127,101 @@ export default {
34472
35127
  'x-undocumented': 'Experimental locations.',
34473
35128
  },
34474
35129
  },
35130
+ '/unstable_partner/resources/push': {
35131
+ post: {
35132
+ description: 'Send Seam some of your resources.',
35133
+ operationId: 'unstablePartnerResourcesPushPost',
35134
+ requestBody: {
35135
+ content: {
35136
+ 'application/json': {
35137
+ schema: {
35138
+ oneOf: [
35139
+ {
35140
+ items: {
35141
+ properties: {
35142
+ custom_metadata: {
35143
+ additionalProperties: { type: 'string' },
35144
+ type: 'object',
35145
+ },
35146
+ customer_key: { type: 'string' },
35147
+ description: { type: 'string' },
35148
+ email_address: { type: 'string' },
35149
+ ends_at: { type: 'string' },
35150
+ icon_url: { type: 'string' },
35151
+ location_keys: {
35152
+ items: { type: 'string' },
35153
+ type: 'array',
35154
+ },
35155
+ name: { type: 'string' },
35156
+ partner_resource_key: { type: 'string' },
35157
+ partner_resource_type: { type: 'string' },
35158
+ phone_number: { type: 'string' },
35159
+ starts_at: { type: 'string' },
35160
+ user_identity_key: { type: 'string' },
35161
+ },
35162
+ type: 'object',
35163
+ },
35164
+ type: 'array',
35165
+ },
35166
+ {
35167
+ properties: {
35168
+ custom_metadata: {
35169
+ additionalProperties: { type: 'string' },
35170
+ type: 'object',
35171
+ },
35172
+ customer_key: { type: 'string' },
35173
+ description: { type: 'string' },
35174
+ email_address: { type: 'string' },
35175
+ ends_at: { type: 'string' },
35176
+ icon_url: { type: 'string' },
35177
+ location_keys: {
35178
+ items: { type: 'string' },
35179
+ type: 'array',
35180
+ },
35181
+ name: { type: 'string' },
35182
+ partner_resource_key: { type: 'string' },
35183
+ partner_resource_type: { type: 'string' },
35184
+ phone_number: { type: 'string' },
35185
+ starts_at: { type: 'string' },
35186
+ user_identity_key: { type: 'string' },
35187
+ },
35188
+ type: 'object',
35189
+ },
35190
+ ],
35191
+ },
35192
+ },
35193
+ },
35194
+ },
35195
+ responses: {
35196
+ 200: {
35197
+ content: {
35198
+ 'application/json': {
35199
+ schema: {
35200
+ properties: { ok: { type: 'boolean' } },
35201
+ required: ['ok'],
35202
+ type: 'object',
35203
+ },
35204
+ },
35205
+ },
35206
+ description: 'OK',
35207
+ },
35208
+ 400: { description: 'Bad Request' },
35209
+ 401: { description: 'Unauthorized' },
35210
+ },
35211
+ security: [
35212
+ { pat_with_workspace: [] },
35213
+ { console_session_with_workspace: [] },
35214
+ { api_key: [] },
35215
+ ],
35216
+ summary: '/unstable_partner/resources/push',
35217
+ tags: [],
35218
+ 'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
35219
+ 'x-fern-sdk-method-name': 'push',
35220
+ 'x-response-key': null,
35221
+ 'x-title': 'Push partner resources at Seam',
35222
+ 'x-undocumented': 'Experimental partner resources.',
35223
+ },
35224
+ },
34475
35225
  '/user_identities/add_acs_user': {
34476
35226
  post: {
34477
35227
  description:
@@ -34666,7 +35416,7 @@ export default {
34666
35416
  '/user_identities/delete': {
34667
35417
  post: {
34668
35418
  description:
34669
- '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.',
35419
+ '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.',
34670
35420
  operationId: 'userIdentitiesDeletePost',
34671
35421
  requestBody: {
34672
35422
  content: {
@@ -36262,6 +37012,8 @@ export default {
36262
37012
  },
36263
37013
  '/workspaces/reset_sandbox': {
36264
37014
  post: {
37015
+ description:
37016
+ 'Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.',
36265
37017
  operationId: 'workspacesResetSandboxPost',
36266
37018
  responses: {
36267
37019
  200: {