@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
@@ -4,9 +4,15 @@ export interface Routes {
4
4
  method: 'POST'
5
5
  queryParams: {}
6
6
  jsonBody: {
7
- /** ID of the device for which to create the new access code. */
7
+ /** ID of the device for which you want to create the new access code. */
8
8
  device_id: string
9
- /** Name of the new access code. */
9
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10
+
11
+ 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`.
12
+
13
+ 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.
14
+
15
+ 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). */
10
16
  name?: string | undefined
11
17
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12
18
  starts_at?: string | undefined
@@ -1336,7 +1342,7 @@ export interface Routes {
1336
1342
 
1337
1343
  An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
1338
1344
 
1339
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
1345
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
1340
1346
 
1341
1347
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—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. */
1342
1348
  access_code: {
@@ -1352,7 +1358,13 @@ export interface Routes {
1352
1358
  access_code_id: string
1353
1359
  /** Unique identifier for the device associated with the access code. */
1354
1360
  device_id: string
1355
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
1361
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1362
+
1363
+ 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`.
1364
+
1365
+ 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.
1366
+
1367
+ 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). */
1356
1368
  name: string | null
1357
1369
  /** Code used for access. Typically, a numeric or alphanumeric string. */
1358
1370
  code: string | null
@@ -1849,13 +1861,19 @@ export interface Routes {
1849
1861
  method: 'POST' | 'PUT'
1850
1862
  queryParams: {}
1851
1863
  jsonBody: {
1852
- /** IDs of the devices for which to create the new access codes. */
1864
+ /** IDs of the devices for which you want to create the new access codes. */
1853
1865
  device_ids: string[]
1854
1866
  /** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
1855
1867
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code'
1856
1868
  /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
1857
1869
  preferred_code_length?: number | undefined
1858
- /** Name of the new access code. */
1870
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1871
+
1872
+ 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`.
1873
+
1874
+ 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.
1875
+
1876
+ 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). */
1859
1877
  name?: string | undefined
1860
1878
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
1861
1879
  starts_at?: string | undefined
@@ -1896,7 +1914,13 @@ export interface Routes {
1896
1914
  access_code_id: string
1897
1915
  /** Unique identifier for the device associated with the access code. */
1898
1916
  device_id: string
1899
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
1917
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
1918
+
1919
+ 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`.
1920
+
1921
+ 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.
1922
+
1923
+ 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). */
1900
1924
  name: string | null
1901
1925
  /** Code used for access. Typically, a numeric or alphanumeric string. */
1902
1926
  code: string | null
@@ -2394,9 +2418,9 @@ export interface Routes {
2394
2418
  queryParams: {}
2395
2419
  jsonBody: {}
2396
2420
  commonParams: {
2397
- /** ID of the device for which to delete the access code. */
2421
+ /** ID of the device for which you want to delete the access code. */
2398
2422
  device_id?: string | undefined
2399
- /** ID of the access code to delete. */
2423
+ /** ID of the access code that you want to delete. */
2400
2424
  access_code_id: string
2401
2425
  /** */
2402
2426
  sync?: boolean
@@ -3703,6 +3727,7 @@ export interface Routes {
3703
3727
  queryParams: {}
3704
3728
  jsonBody: {}
3705
3729
  commonParams: {
3730
+ /** ID of the device for which you want to generate a code. */
3706
3731
  device_id: string
3707
3732
  }
3708
3733
  formData: {}
@@ -3732,7 +3757,7 @@ export interface Routes {
3732
3757
 
3733
3758
  An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
3734
3759
 
3735
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
3760
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
3736
3761
 
3737
3762
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—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. */
3738
3763
  access_code: {
@@ -3748,7 +3773,13 @@ export interface Routes {
3748
3773
  access_code_id: string
3749
3774
  /** Unique identifier for the device associated with the access code. */
3750
3775
  device_id: string
3751
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
3776
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
3777
+
3778
+ 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`.
3779
+
3780
+ 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.
3781
+
3782
+ 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). */
3752
3783
  name: string | null
3753
3784
  /** Code used for access. Typically, a numeric or alphanumeric string. */
3754
3785
  code: string | null
@@ -4272,7 +4303,13 @@ export interface Routes {
4272
4303
  access_code_id: string
4273
4304
  /** Unique identifier for the device associated with the access code. */
4274
4305
  device_id: string
4275
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
4306
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
4307
+
4308
+ 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`.
4309
+
4310
+ 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.
4311
+
4312
+ 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). */
4276
4313
  name: string | null
4277
4314
  /** Code used for access. Typically, a numeric or alphanumeric string. */
4278
4315
  code: string | null
@@ -4788,7 +4825,7 @@ export interface Routes {
4788
4825
 
4789
4826
  An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
4790
4827
 
4791
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
4828
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
4792
4829
 
4793
4830
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—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. */
4794
4831
  backup_access_code: {
@@ -4804,7 +4841,13 @@ export interface Routes {
4804
4841
  access_code_id: string
4805
4842
  /** Unique identifier for the device associated with the access code. */
4806
4843
  device_id: string
4807
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
4844
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
4845
+
4846
+ 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`.
4847
+
4848
+ 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.
4849
+
4850
+ 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). */
4808
4851
  name: string | null
4809
4852
  /** Code used for access. Typically, a numeric or alphanumeric string. */
4810
4853
  code: string | null
@@ -5298,7 +5341,7 @@ export interface Routes {
5298
5341
 
5299
5342
  An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
5300
5343
 
5301
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
5344
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
5302
5345
 
5303
5346
  In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—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. */
5304
5347
  access_code: {
@@ -5314,7 +5357,13 @@ export interface Routes {
5314
5357
  access_code_id: string
5315
5358
  /** Unique identifier for the device associated with the access code. */
5316
5359
  device_id: string
5317
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
5360
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
5361
+
5362
+ 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`.
5363
+
5364
+ 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.
5365
+
5366
+ 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). */
5318
5367
  name: string | null
5319
5368
  /** Code used for access. Typically, a numeric or alphanumeric string. */
5320
5369
  code: string | null
@@ -5811,7 +5860,7 @@ export interface Routes {
5811
5860
  method: 'POST'
5812
5861
  queryParams: {}
5813
5862
  jsonBody: {
5814
- /** ID of the device for which to report constraints. */
5863
+ /** ID of the device for which you want to report constraints. */
5815
5864
  device_id: string
5816
5865
  /** Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`. */
5817
5866
  supported_code_lengths?: number[] | undefined
@@ -5845,7 +5894,11 @@ export interface Routes {
5845
5894
 
5846
5895
  When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
5847
5896
 
5848
- Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
5897
+ Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
5898
+
5899
+ Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
5900
+
5901
+ - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
5849
5902
  access_code: {
5850
5903
  /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
5851
5904
  type: 'time_bound' | 'ongoing'
@@ -5853,7 +5906,13 @@ export interface Routes {
5853
5906
  access_code_id: string
5854
5907
  /** Unique identifier for the device associated with the access code. */
5855
5908
  device_id: string
5856
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
5909
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
5910
+
5911
+ 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`.
5912
+
5913
+ 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.
5914
+
5915
+ 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). */
5857
5916
  name: string | null
5858
5917
  /** Code used for access. Typically, a numeric or alphanumeric string. */
5859
5918
  code: string | null
@@ -6341,9 +6400,9 @@ export interface Routes {
6341
6400
  commonParams: {
6342
6401
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
6343
6402
  access_code_id: string
6344
- /** Indicates whether external modification of the access code is allowed. */
6403
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
6345
6404
  is_external_modification_allowed?: boolean | undefined
6346
- /** Indicates whether external modification of the access code is allowed. */
6405
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
6347
6406
  allow_external_modification?: boolean | undefined
6348
6407
  /** Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. */
6349
6408
  force?: boolean | undefined
@@ -6359,7 +6418,7 @@ export interface Routes {
6359
6418
  queryParams: {}
6360
6419
  jsonBody: {}
6361
6420
  commonParams: {
6362
- /** ID of the unmanaged access code to delete. */
6421
+ /** ID of the unmanaged access code that you want to delete. */
6363
6422
  access_code_id: string
6364
6423
  /** */
6365
6424
  sync?: boolean
@@ -7681,7 +7740,11 @@ export interface Routes {
7681
7740
 
7682
7741
  When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
7683
7742
 
7684
- Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
7743
+ Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
7744
+
7745
+ Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
7746
+
7747
+ - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
7685
7748
  access_code: {
7686
7749
  /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
7687
7750
  type: 'time_bound' | 'ongoing'
@@ -7689,7 +7752,13 @@ export interface Routes {
7689
7752
  access_code_id: string
7690
7753
  /** Unique identifier for the device associated with the access code. */
7691
7754
  device_id: string
7692
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
7755
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
7756
+
7757
+ 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`.
7758
+
7759
+ 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.
7760
+
7761
+ 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). */
7693
7762
  name: string | null
7694
7763
  /** Code used for access. Typically, a numeric or alphanumeric string. */
7695
7764
  code: string | null
@@ -8189,7 +8258,13 @@ export interface Routes {
8189
8258
  access_code_id: string
8190
8259
  /** Unique identifier for the device associated with the access code. */
8191
8260
  device_id: string
8192
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
8261
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
8262
+
8263
+ 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`.
8264
+
8265
+ 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.
8266
+
8267
+ 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). */
8193
8268
  name: string | null
8194
8269
  /** Code used for access. Typically, a numeric or alphanumeric string. */
8195
8270
  code: string | null
@@ -8693,7 +8768,13 @@ export interface Routes {
8693
8768
  method: 'POST' | 'PATCH' | 'PUT'
8694
8769
  queryParams: {}
8695
8770
  jsonBody: {
8696
- /** Name of the new access code. */
8771
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
8772
+
8773
+ 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`.
8774
+
8775
+ 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.
8776
+
8777
+ 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). */
8697
8778
  name?: string | undefined
8698
8779
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
8699
8780
  starts_at?: string | undefined
@@ -10036,7 +10117,13 @@ export interface Routes {
10036
10117
  ends_at?: string | undefined
10037
10118
  /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10038
10119
  starts_at?: string | undefined
10039
- /** Name of the new access code. */
10120
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
10121
+
10122
+ 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`.
10123
+
10124
+ 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.
10125
+
10126
+ 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). */
10040
10127
  name?: string | undefined
10041
10128
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
10042
10129
  common_code_key: string
@@ -10051,9 +10138,9 @@ export interface Routes {
10051
10138
  queryParams: {}
10052
10139
  jsonBody: {}
10053
10140
  commonParams: {
10054
- /** ID of the desired access group. */
10141
+ /** ID of the access group to which you want to add an access system user. */
10055
10142
  acs_access_group_id: string
10056
- /** ID of the desired user. */
10143
+ /** ID of the access system user that you want to add to an access group. */
10057
10144
  acs_user_id: string
10058
10145
  }
10059
10146
  formData: {}
@@ -10065,7 +10152,7 @@ export interface Routes {
10065
10152
  queryParams: {}
10066
10153
  jsonBody: {}
10067
10154
  commonParams: {
10068
- /** ID of the desired access group. */
10155
+ /** ID of the access group that you want to get. */
10069
10156
  acs_access_group_id: string
10070
10157
  }
10071
10158
  formData: {}
@@ -10128,9 +10215,9 @@ export interface Routes {
10128
10215
  queryParams: {}
10129
10216
  jsonBody: {}
10130
10217
  commonParams: {
10131
- /** ID of the access control system for which you want to retrieve all access groups. */
10218
+ /** ID of the access system for which you want to retrieve all access groups. */
10132
10219
  acs_system_id?: string | undefined
10133
- /** ID of the user for which you want to retrieve all access groups. */
10220
+ /** ID of the access system user for which you want to retrieve all access groups. */
10134
10221
  acs_user_id?: string | undefined
10135
10222
  /** ID of the user identity for which you want to retrieve all access groups. */
10136
10223
  user_identity_id?: string | undefined
@@ -10288,7 +10375,7 @@ export interface Routes {
10288
10375
  queryParams: {}
10289
10376
  jsonBody: {}
10290
10377
  commonParams: {
10291
- /** ID of the access group for which you want to retrieve all users. */
10378
+ /** ID of the access group for which you want to retrieve all access system users. */
10292
10379
  acs_access_group_id: string
10293
10380
  }
10294
10381
  formData: {}
@@ -10516,11 +10603,11 @@ export interface Routes {
10516
10603
  queryParams: {}
10517
10604
  jsonBody: {}
10518
10605
  commonParams: {
10519
- /** ID of the desired access group. */
10606
+ /** ID of the access group from which you want to remove an access system user. */
10520
10607
  acs_access_group_id: string
10521
- /** ID of the desired user. */
10608
+ /** ID of the access system user that you want to remove from an access group. */
10522
10609
  acs_user_id?: string | undefined
10523
- /** ID of the desired user identity. */
10610
+ /** ID of the user identity associated with the user that you want to remove from an access group. */
10524
10611
  user_identity_id?: string | undefined
10525
10612
  }
10526
10613
  formData: {}
@@ -10532,7 +10619,7 @@ export interface Routes {
10532
10619
  queryParams: {}
10533
10620
  jsonBody: {}
10534
10621
  commonParams: {
10535
- /** ID of the desired unmanaged access group. */
10622
+ /** ID of the unmanaged access group that you want to get. */
10536
10623
  acs_access_group_id: string
10537
10624
  }
10538
10625
  formData: {}
@@ -10591,9 +10678,9 @@ export interface Routes {
10591
10678
  queryParams: {}
10592
10679
  jsonBody: {}
10593
10680
  commonParams: {
10594
- /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
10681
+ /** ID of the access system for which you want to retrieve all unmanaged access groups. */
10595
10682
  acs_system_id?: string | undefined
10596
- /** ID of the user for which you want to retrieve all unmanaged access groups. */
10683
+ /** ID of the access system user for which you want to retrieve all unmanaged access groups. */
10597
10684
  acs_user_id?: string | undefined
10598
10685
  }
10599
10686
  formData: {}
@@ -10651,6 +10738,7 @@ export interface Routes {
10651
10738
  queryParams: {}
10652
10739
  jsonBody: {}
10653
10740
  commonParams: {
10741
+ /** ID of the access system for which you want to list credential pools. */
10654
10742
  acs_system_id: string
10655
10743
  }
10656
10744
  formData: {}
@@ -10672,10 +10760,15 @@ export interface Routes {
10672
10760
  queryParams: {}
10673
10761
  jsonBody: {}
10674
10762
  commonParams: {
10763
+ /** ID of the user identity for which you want to launch a credential provisioning automation. */
10675
10764
  user_identity_id: string
10765
+ /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
10676
10766
  credential_manager_acs_system_id: string
10767
+ /** ID of the credential pool for which you want to launch a credential provisioning automation. */
10677
10768
  acs_credential_pool_id?: string | undefined
10769
+ /** 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`. */
10678
10770
  create_credential_manager_user?: boolean | undefined
10771
+ /** 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`. */
10679
10772
  credential_manager_acs_user_id?: string | undefined
10680
10773
  }
10681
10774
  formData: {}
@@ -10695,9 +10788,9 @@ export interface Routes {
10695
10788
  method: 'PATCH' | 'POST'
10696
10789
  queryParams: {}
10697
10790
  jsonBody: {
10698
- /** ID of the desired user. */
10791
+ /** ID of the access system user to whom you want to assign a credential. */
10699
10792
  acs_user_id: string
10700
- /** ID of the desired credential. */
10793
+ /** ID of the credential that you want to assign to an access system user. */
10701
10794
  acs_credential_id: string
10702
10795
  }
10703
10796
  commonParams: {}
@@ -10857,8 +10950,12 @@ export interface Routes {
10857
10950
  commonParams: {
10858
10951
  /** ACS system ID of the credential manager for the new credential. */
10859
10952
  credential_manager_acs_system_id?: string | undefined
10860
- /** ID of the ACS user to whom the new credential belongs. */
10861
- acs_user_id: string
10953
+ /** 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`. */
10954
+ acs_user_id?: string | undefined
10955
+ /** 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. */
10956
+ user_identity_id?: string | undefined
10957
+ /** 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`. */
10958
+ acs_system_id?: string | undefined
10862
10959
  /** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
10863
10960
  access_method: 'code' | 'card' | 'mobile_key'
10864
10961
  /** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview). */
@@ -10897,7 +10994,9 @@ export interface Routes {
10897
10994
  /** Salto Space-specific metadata for the new credential. */
10898
10995
  salto_space_metadata?:
10899
10996
  | {
10997
+ /** 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). */
10900
10998
  assign_new_key?: boolean | undefined
10999
+ /** 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). */
10901
11000
  update_current_key?: boolean | undefined
10902
11001
  }
10903
11002
  | undefined
@@ -11060,7 +11159,7 @@ export interface Routes {
11060
11159
  queryParams: {}
11061
11160
  jsonBody: {}
11062
11161
  commonParams: {
11063
- /** ID of the ACS user to whom the new credential belongs. */
11162
+ /** ID of the access system user to whom the new credential belongs. */
11064
11163
  acs_user_id: string
11065
11164
  /** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
11066
11165
  allowed_acs_entrance_id: string
@@ -11225,7 +11324,7 @@ export interface Routes {
11225
11324
  queryParams: {}
11226
11325
  jsonBody: {}
11227
11326
  commonParams: {
11228
- /** ID of the desired credential. */
11327
+ /** ID of the credential that you want to delete. */
11229
11328
  acs_credential_id: string
11230
11329
  }
11231
11330
  formData: {}
@@ -11237,7 +11336,7 @@ export interface Routes {
11237
11336
  queryParams: {}
11238
11337
  jsonBody: {}
11239
11338
  commonParams: {
11240
- /** ID of the desired credential. */
11339
+ /** ID of the credential that you want to get. */
11241
11340
  acs_credential_id: string
11242
11341
  }
11243
11342
  formData: {}
@@ -11395,17 +11494,17 @@ export interface Routes {
11395
11494
  jsonBody: {}
11396
11495
  commonParams: (
11397
11496
  | {
11398
- /** ID of the ACS user for which you want to retrieve all credentials. */
11497
+ /** ID of the access system user for which you want to retrieve all credentials. */
11399
11498
  acs_user_id: string
11400
11499
  }
11401
11500
  | {
11402
- /** ID of the access control system for which you want to retrieve all credentials. */
11501
+ /** ID of the access system for which you want to retrieve all credentials. */
11403
11502
  acs_system_id: string
11404
11503
  }
11405
11504
  | {
11406
- /** ID of the ACS user for which you want to retrieve all credentials. */
11505
+ /** ID of the access system user for which you want to retrieve all credentials. */
11407
11506
  acs_user_id: string
11408
- /** ID of the access control system for which you want to retrieve all credentials. */
11507
+ /** ID of the access system for which you want to retrieve all credentials. */
11409
11508
  acs_system_id: string
11410
11509
  }
11411
11510
  | {
@@ -11570,7 +11669,7 @@ export interface Routes {
11570
11669
  queryParams: {}
11571
11670
  jsonBody: {}
11572
11671
  commonParams: {
11573
- /** ID of the credential for which you want to retrieve all entrances to which this credential grants access. */
11672
+ /** ID of the credential for which you want to retrieve all entrances to which the credential grants access. */
11574
11673
  acs_credential_id: string
11575
11674
  }
11576
11675
  formData: {}
@@ -11667,9 +11766,9 @@ export interface Routes {
11667
11766
  method: 'PATCH' | 'POST'
11668
11767
  queryParams: {}
11669
11768
  jsonBody: {
11670
- /** ID of the desired user. */
11769
+ /** ID of the access system user from which you want to unassign a credential. */
11671
11770
  acs_user_id: string
11672
- /** ID of the desired credential. */
11771
+ /** ID of the credential that you want to unassign from an access system user. */
11673
11772
  acs_credential_id: string
11674
11773
  }
11675
11774
  commonParams: {}
@@ -11827,7 +11926,7 @@ export interface Routes {
11827
11926
  queryParams: {}
11828
11927
  jsonBody: {}
11829
11928
  commonParams: {
11830
- /** ID of the desired unmanaged credential. */
11929
+ /** ID of the unmanaged credential that you want to get. */
11831
11930
  acs_credential_id: string
11832
11931
  }
11833
11932
  formData: {}
@@ -11981,17 +12080,17 @@ export interface Routes {
11981
12080
  jsonBody: {}
11982
12081
  commonParams:
11983
12082
  | {
11984
- /** ID of the ACS user for which you want to retrieve all credentials. */
12083
+ /** ID of the access system user for which you want to retrieve all credentials. */
11985
12084
  acs_user_id: string
11986
12085
  }
11987
12086
  | {
11988
- /** ID of the access control system for which you want to retrieve all credentials. */
12087
+ /** ID of the access system for which you want to retrieve all credentials. */
11989
12088
  acs_system_id: string
11990
12089
  }
11991
12090
  | {
11992
- /** ID of the ACS user for which you want to retrieve all credentials. */
12091
+ /** ID of the access system user for which you want to retrieve all credentials. */
11993
12092
  acs_user_id: string
11994
- /** ID of the access control system for which you want to retrieve all credentials. */
12093
+ /** ID of the access system for which you want to retrieve all credentials. */
11995
12094
  acs_system_id: string
11996
12095
  }
11997
12096
  | {
@@ -12146,9 +12245,9 @@ export interface Routes {
12146
12245
  method: 'PATCH' | 'POST'
12147
12246
  queryParams: {}
12148
12247
  jsonBody: {
12149
- /** ID of the desired credential. */
12248
+ /** ID of the credential that you want to update. */
12150
12249
  acs_credential_id: string
12151
- /** Replacement access (PIN) code for the credential. */
12250
+ /** Replacement access (PIN) code for the credential that you want to update. */
12152
12251
  code?: string | undefined
12153
12252
  /** Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. */
12154
12253
  ends_at?: string | undefined
@@ -14922,7 +15021,7 @@ export interface Routes {
14922
15021
  queryParams: {}
14923
15022
  jsonBody: {}
14924
15023
  commonParams: {
14925
- /** ID of the desired encoder. */
15024
+ /** ID of the encoder that you want to get. */
14926
15025
  acs_encoder_id: string
14927
15026
  }
14928
15027
  formData: {}
@@ -14971,21 +15070,21 @@ export interface Routes {
14971
15070
  jsonBody: {}
14972
15071
  commonParams:
14973
15072
  | {
14974
- /** ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. */
15073
+ /** ID of the access system for which you want to retrieve all encoders. */
14975
15074
  acs_system_id: string
14976
- /** Number of `acs_encoders` to return. */
15075
+ /** Number of encoders to return. */
14977
15076
  limit?: number
14978
15077
  }
14979
15078
  | {
14980
- /** IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. */
15079
+ /** IDs of the access systems for which you want to retrieve all encoders. */
14981
15080
  acs_system_ids: string[]
14982
- /** Number of `acs_encoders` to return. */
15081
+ /** Number of encoders to return. */
14983
15082
  limit?: number
14984
15083
  }
14985
15084
  | {
14986
- /** IDs of the `acs_encoder`s that you want to retrieve. */
15085
+ /** IDs of the encoders that you want to retrieve. */
14987
15086
  acs_encoder_ids: string[]
14988
- /** Number of `acs_encoders` to return. */
15087
+ /** Number of encoders to return. */
14989
15088
  limit?: number
14990
15089
  }
14991
15090
  formData: {}
@@ -15019,7 +15118,7 @@ export interface Routes {
15019
15118
  queryParams: {}
15020
15119
  jsonBody: {}
15021
15120
  commonParams: {
15022
- /** ID of the `acs_encoder` to use for the scan. */
15121
+ /** ID of the encoder to use for the scan. */
15023
15122
  acs_encoder_id: string
15024
15123
  }
15025
15124
  formData: {}
@@ -16412,6 +16511,7 @@ export interface Routes {
16412
16511
  queryParams: {}
16413
16512
  jsonBody: {}
16414
16513
  commonParams: {
16514
+ /** ID of the entrance that you want to get. */
16415
16515
  acs_entrance_id: string
16416
16516
  }
16417
16517
  formData: {}
@@ -16511,7 +16611,9 @@ export interface Routes {
16511
16611
  method: 'POST'
16512
16612
  queryParams: {}
16513
16613
  jsonBody: {
16614
+ /** ID of the entrance to which you want to grant an access system user access. */
16514
16615
  acs_entrance_id: string
16616
+ /** ID of the access system user to whom you want to grant access to an entrance. */
16515
16617
  acs_user_id: string
16516
16618
  }
16517
16619
  commonParams: {}
@@ -16524,9 +16626,11 @@ export interface Routes {
16524
16626
  queryParams: {}
16525
16627
  jsonBody: {}
16526
16628
  commonParams: {
16629
+ /** ID of the access system for which you want to retrieve all entrances. */
16527
16630
  acs_system_id?: string | undefined
16631
+ /** ID of the credential for which you want to retrieve all entrances. */
16528
16632
  acs_credential_id?: string | undefined
16529
- /** */
16633
+ /** ID of the location for which you want to retrieve all entrances. */
16530
16634
  location_id?: (string | null) | undefined
16531
16635
  }
16532
16636
  formData: {}
@@ -16624,7 +16728,9 @@ export interface Routes {
16624
16728
  queryParams: {}
16625
16729
  jsonBody: {}
16626
16730
  commonParams: {
16731
+ /** ID of the entrance for which you want to list all credentials that grant access. */
16627
16732
  acs_entrance_id: string
16733
+ /** Conditions that credentials must meet to be included in the returned list. */
16628
16734
  include_if?: Array<'visionline_metadata.is_valid'> | undefined
16629
16735
  }
16630
16736
  formData: {}
@@ -16776,7 +16882,7 @@ export interface Routes {
16776
16882
  queryParams: {}
16777
16883
  jsonBody: {}
16778
16884
  commonParams: {
16779
- /** ID of the desired access control system. */
16885
+ /** ID of the access system that you want to get. */
16780
16886
  acs_system_id: string
16781
16887
  }
16782
16888
  formData: {}
@@ -16971,7 +17077,7 @@ export interface Routes {
16971
17077
  queryParams: {}
16972
17078
  jsonBody: {}
16973
17079
  commonParams: {
16974
- /** ID of the connected account by which to filter the list of returned access control systems. */
17080
+ /** ID of the connected account by which you want to filter the list of access systems. */
16975
17081
  connected_account_id?: string | undefined
16976
17082
  }
16977
17083
  formData: {}
@@ -17161,7 +17267,7 @@ export interface Routes {
17161
17267
  queryParams: {}
17162
17268
  jsonBody: {}
17163
17269
  commonParams: {
17164
- /** ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. */
17270
+ /** ID of the access system for which you want to retrieve all compatible credential manager systems. */
17165
17271
  acs_system_id: string
17166
17272
  }
17167
17273
  formData: {}
@@ -17351,9 +17457,9 @@ export interface Routes {
17351
17457
  queryParams: {}
17352
17458
  jsonBody: {}
17353
17459
  commonParams: {
17354
- /** ID of the desired `acs_user`. */
17460
+ /** ID of the access system user that you want to add to an access group. */
17355
17461
  acs_user_id: string
17356
- /** ID of the desired access group. */
17462
+ /** ID of the access group to which you want to add an access system user. */
17357
17463
  acs_access_group_id: string
17358
17464
  }
17359
17465
  formData: {}
@@ -17364,18 +17470,20 @@ export interface Routes {
17364
17470
  method: 'POST'
17365
17471
  queryParams: {}
17366
17472
  jsonBody: {
17367
- /** Full name of the new `acs_user`. */
17473
+ /** Full name of the new access system user. */
17368
17474
  full_name: string
17369
- /** ID of the `acs_system` to which to add the new `acs_user`. */
17475
+ /** ID of the access system to which you want to add the new access system user. */
17370
17476
  acs_system_id: string
17371
- /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
17477
+ /** Array of access group IDs to indicate the access groups to which you want to add the new access system user. */
17372
17478
  acs_access_group_ids?: string[]
17373
- /** ID of the user identity with which to associate the new `acs_user`. */
17479
+ /** ID of the user identity with which you want to associate the new access system user. */
17374
17480
  user_identity_id?: string | undefined
17375
- /** `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`. */
17481
+ /** `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`. */
17376
17482
  access_schedule?:
17377
17483
  | {
17484
+ /** Starting timestamp for the new access system user's access. */
17378
17485
  starts_at?: string | undefined
17486
+ /** Ending timestamp for the new access system user's access. */
17379
17487
  ends_at?: (string | undefined) | null
17380
17488
  }
17381
17489
  | undefined
@@ -17618,7 +17726,7 @@ export interface Routes {
17618
17726
  queryParams: {}
17619
17727
  jsonBody: {}
17620
17728
  commonParams: {
17621
- /** ID of the desired `acs_user`. */
17729
+ /** ID of the access system user that you want to delete. */
17622
17730
  acs_user_id: string
17623
17731
  }
17624
17732
  formData: {}
@@ -17630,7 +17738,7 @@ export interface Routes {
17630
17738
  queryParams: {}
17631
17739
  jsonBody: {}
17632
17740
  commonParams: {
17633
- /** ID of the desired `acs_user`. */
17741
+ /** ID of the access system user that you want to get. */
17634
17742
  acs_user_id: string
17635
17743
  }
17636
17744
  formData: {}
@@ -17863,18 +17971,19 @@ export interface Routes {
17863
17971
  queryParams: {}
17864
17972
  jsonBody: {}
17865
17973
  commonParams: {
17866
- /** ID of the user identity for which you want to retrieve all `acs_user`s. */
17974
+ /** ID of the user identity for which you want to retrieve all access system users. */
17867
17975
  user_identity_id?: string | undefined
17868
- /** 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`). */
17976
+ /** 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`). */
17869
17977
  user_identity_phone_number?: string | undefined
17870
- /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
17978
+ /** Email address of the user identity for which you want to retrieve all access system users. */
17871
17979
  user_identity_email_address?: string | undefined
17872
- /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
17980
+ /** ID of the `acs_system` for which you want to retrieve all access system users. */
17873
17981
  acs_system_id?: string | undefined
17874
- /** 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`. */
17982
+ /** 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`. */
17875
17983
  search?: string | undefined
17876
17984
  /** Maximum number of records to return per page. */
17877
17985
  limit?: number
17986
+ /** Timestamp by which to limit returned access system users. Returns users created before this timestamp. */
17878
17987
  created_before?: Date | undefined
17879
17988
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
17880
17989
  page_cursor?: (string | undefined) | null
@@ -18113,7 +18222,7 @@ export interface Routes {
18113
18222
  queryParams: {}
18114
18223
  jsonBody: {}
18115
18224
  commonParams: {
18116
- /** ID of the desired `acs_user`. */
18225
+ /** ID of the access system user for whom you want to list accessible entrances. */
18117
18226
  acs_user_id: string
18118
18227
  }
18119
18228
  formData: {}
@@ -18211,9 +18320,9 @@ export interface Routes {
18211
18320
  queryParams: {}
18212
18321
  jsonBody: {}
18213
18322
  commonParams: {
18214
- /** ID of the desired `acs_user`. */
18323
+ /** ID of the access system user that you want to remove from an access group. */
18215
18324
  acs_user_id: string
18216
- /** ID of the desired access group. */
18325
+ /** ID of the access group from which you want to remove an access system user. */
18217
18326
  acs_access_group_id: string
18218
18327
  }
18219
18328
  formData: {}
@@ -18224,7 +18333,7 @@ export interface Routes {
18224
18333
  method: 'POST'
18225
18334
  queryParams: {}
18226
18335
  jsonBody: {
18227
- /** ID of the desired `acs_user`. */
18336
+ /** ID of the access system user for whom you want to revoke access. */
18228
18337
  acs_user_id: string
18229
18338
  }
18230
18339
  commonParams: {}
@@ -18237,7 +18346,7 @@ export interface Routes {
18237
18346
  queryParams: {}
18238
18347
  jsonBody: {}
18239
18348
  commonParams: {
18240
- /** ID of the desired `acs_user`. */
18349
+ /** ID of the access system user that you want to suspend. */
18241
18350
  acs_user_id: string
18242
18351
  }
18243
18352
  formData: {}
@@ -18249,6 +18358,7 @@ export interface Routes {
18249
18358
  queryParams: {}
18250
18359
  jsonBody: {}
18251
18360
  commonParams: {
18361
+ /** ID of the unmanaged access system user that you want to get. */
18252
18362
  acs_user_id: string
18253
18363
  }
18254
18364
  formData: {}
@@ -18477,10 +18587,15 @@ export interface Routes {
18477
18587
  queryParams: {}
18478
18588
  jsonBody: {}
18479
18589
  commonParams: {
18590
+ /** ID of the user identity for which you want to retrieve all unmanaged access system users. */
18480
18591
  user_identity_id?: string | undefined
18592
+ /** Phone number of the user identity for which you want to retrieve all unmanaged access system users. */
18481
18593
  user_identity_phone_number?: string | undefined
18594
+ /** Email address of the user identity for which you want to retrieve all unmanaged access system users. */
18482
18595
  user_identity_email_address?: string | undefined
18596
+ /** ID of the access system for which you want to retrieve all unmanaged access system users. */
18483
18597
  acs_system_id?: string | undefined
18598
+ /** Number of unmanaged access system users to return. */
18484
18599
  limit?: number
18485
18600
  }
18486
18601
  formData: {}
@@ -18708,7 +18823,7 @@ export interface Routes {
18708
18823
  queryParams: {}
18709
18824
  jsonBody: {}
18710
18825
  commonParams: {
18711
- /** ID of the desired `acs_user`. */
18826
+ /** ID of the access system user that you want to unsuspend. */
18712
18827
  acs_user_id: string
18713
18828
  }
18714
18829
  formData: {}
@@ -18719,10 +18834,12 @@ export interface Routes {
18719
18834
  method: 'PATCH' | 'POST'
18720
18835
  queryParams: {}
18721
18836
  jsonBody: {
18722
- /** `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`. */
18837
+ /** `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`. */
18723
18838
  access_schedule?:
18724
18839
  | ({
18840
+ /** Starting timestamp for the access system user's access. */
18725
18841
  starts_at: string
18842
+ /** Ending timestamp for the access system user's access. */
18726
18843
  ends_at: string
18727
18844
  } | null)
18728
18845
  | undefined
@@ -18749,6 +18866,7 @@ export interface Routes {
18749
18866
  queryParams: {}
18750
18867
  jsonBody: {}
18751
18868
  commonParams: {
18869
+ /** ID of the action attempt that you want to get. */
18752
18870
  action_attempt_id: string
18753
18871
  }
18754
18872
  formData: {}
@@ -20053,6 +20171,7 @@ export interface Routes {
20053
20171
  queryParams: {}
20054
20172
  jsonBody: {}
20055
20173
  commonParams: {
20174
+ /** IDs of the action attempts that you want to retrieve. */
20056
20175
  action_attempt_ids: string[]
20057
20176
  }
20058
20177
  formData: {}
@@ -21357,6 +21476,7 @@ export interface Routes {
21357
21476
  queryParams: {}
21358
21477
  jsonBody: {}
21359
21478
  commonParams: {
21479
+ /** ID of the Seam Bridge that you want to get. */
21360
21480
  bridge_id: string
21361
21481
  }
21362
21482
  formData: {}
@@ -21389,16 +21509,29 @@ export interface Routes {
21389
21509
  method: 'POST' | 'PUT'
21390
21510
  queryParams: {}
21391
21511
  jsonBody: {
21512
+ /** Your user ID for the user for whom you want to create a client session. */
21392
21513
  user_identifier_key?: string | undefined
21514
+ /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session. */
21393
21515
  connect_webview_ids?: string[] | undefined
21516
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
21394
21517
  connected_account_ids?: string[] | undefined
21518
+ /** 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. */
21395
21519
  user_identity_ids?: string[] | undefined
21520
+ /** 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. */
21396
21521
  expires_at?: Date | undefined
21397
21522
  }
21398
21523
  commonParams: {}
21399
21524
  formData: {}
21400
21525
  jsonResponse: {
21401
- /** */
21526
+ /** 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.
21527
+
21528
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
21529
+
21530
+ When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
21531
+
21532
+ A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
21533
+
21534
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
21402
21535
  client_session: {
21403
21536
  client_session_id: string
21404
21537
  workspace_id: string
@@ -21419,6 +21552,7 @@ export interface Routes {
21419
21552
  queryParams: {}
21420
21553
  jsonBody: {}
21421
21554
  commonParams: {
21555
+ /** ID of the client session that you want to delete. */
21422
21556
  client_session_id: string
21423
21557
  }
21424
21558
  formData: {}
@@ -21430,12 +21564,22 @@ export interface Routes {
21430
21564
  queryParams: {}
21431
21565
  jsonBody: {}
21432
21566
  commonParams: {
21567
+ /** ID of the client session that you want to get. */
21433
21568
  client_session_id?: string | undefined
21569
+ /** User identifier key associated with the client session that you want to get. */
21434
21570
  user_identifier_key?: string | undefined
21435
21571
  }
21436
21572
  formData: {}
21437
21573
  jsonResponse: {
21438
- /** */
21574
+ /** 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.
21575
+
21576
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
21577
+
21578
+ When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
21579
+
21580
+ A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
21581
+
21582
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
21439
21583
  client_session: {
21440
21584
  client_session_id: string
21441
21585
  workspace_id: string
@@ -21455,16 +21599,29 @@ export interface Routes {
21455
21599
  method: 'POST'
21456
21600
  queryParams: {}
21457
21601
  jsonBody: {
21602
+ /** 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). */
21458
21603
  user_identifier_key?: string | undefined
21604
+ /** 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). */
21459
21605
  connect_webview_ids?: string[] | undefined
21606
+ /** 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). */
21460
21607
  connected_account_ids?: string[] | undefined
21608
+ /** 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). */
21461
21609
  user_identity_ids?: string[] | undefined
21610
+ /** 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. */
21462
21611
  expires_at?: Date | undefined
21463
21612
  }
21464
21613
  commonParams: {}
21465
21614
  formData: {}
21466
21615
  jsonResponse: {
21467
- /** */
21616
+ /** 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.
21617
+
21618
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
21619
+
21620
+ When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
21621
+
21622
+ A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
21623
+
21624
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
21468
21625
  client_session: {
21469
21626
  client_session_id: string
21470
21627
  workspace_id: string
@@ -21485,15 +21642,28 @@ export interface Routes {
21485
21642
  queryParams: {}
21486
21643
  jsonBody: {}
21487
21644
  commonParams: {
21645
+ /** ID of the client session to which you want to grant access to resources. */
21488
21646
  client_session_id?: string | undefined
21647
+ /** Your user ID for the user that you want to associate with the client session. */
21489
21648
  user_identifier_key?: string | undefined
21649
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session. */
21490
21650
  connected_account_ids?: string[] | undefined
21651
+ /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
21491
21652
  connect_webview_ids?: string[] | undefined
21653
+ /** 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. */
21492
21654
  user_identity_ids?: string[] | undefined
21493
21655
  }
21494
21656
  formData: {}
21495
21657
  jsonResponse: {
21496
- /** */
21658
+ /** 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.
21659
+
21660
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
21661
+
21662
+ When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
21663
+
21664
+ A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
21665
+
21666
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
21497
21667
  client_session: {
21498
21668
  client_session_id: string
21499
21669
  workspace_id: string
@@ -21514,10 +21684,15 @@ export interface Routes {
21514
21684
  queryParams: {}
21515
21685
  jsonBody: {}
21516
21686
  commonParams: {
21687
+ /** ID of the client session that you want to retrieve. */
21517
21688
  client_session_id?: string | undefined
21689
+ /** Your user ID for the user by which you want to filter client sessions. */
21518
21690
  user_identifier_key?: string | undefined
21691
+ /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions. */
21519
21692
  connect_webview_id?: string | undefined
21693
+ /** Indicates whether to retrieve only client sessions without associated user identifier keys. */
21520
21694
  without_user_identifier_key?: boolean | undefined
21695
+ /** 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. */
21521
21696
  user_identity_id?: string | undefined
21522
21697
  }
21523
21698
  formData: {}
@@ -21542,6 +21717,7 @@ export interface Routes {
21542
21717
  queryParams: {}
21543
21718
  jsonBody: {}
21544
21719
  commonParams: {
21720
+ /** ID of the client session that you want to revoke. */
21545
21721
  client_session_id: string
21546
21722
  }
21547
21723
  formData: {}
@@ -21552,9 +21728,13 @@ export interface Routes {
21552
21728
  method: 'POST'
21553
21729
  queryParams: {}
21554
21730
  jsonBody: {
21731
+ /** */
21555
21732
  device_selection_mode?: ('none' | 'single' | 'multiple') | undefined
21733
+ /** URL that you want to redirect the user to after the provider login is complete. */
21556
21734
  custom_redirect_url?: string | undefined
21735
+ /** 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`. */
21557
21736
  custom_redirect_failure_url?: string | undefined
21737
+ /** 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. */
21558
21738
  accepted_providers?:
21559
21739
  | Array<
21560
21740
  | 'dormakaba_community'
@@ -21609,6 +21789,7 @@ export interface Routes {
21609
21789
  | 'google_nest'
21610
21790
  >
21611
21791
  | undefined
21792
+ /** 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. */
21612
21793
  provider_category?:
21613
21794
  | (
21614
21795
  | 'stable'
@@ -21619,14 +21800,27 @@ export interface Routes {
21619
21800
  | 'internal_beta'
21620
21801
  )
21621
21802
  | undefined
21803
+ /** 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). */
21622
21804
  custom_metadata?: Record<string, string | boolean | null> | undefined
21805
+ /** 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). */
21623
21806
  automatically_manage_new_devices?: boolean
21807
+ /** 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). */
21624
21808
  wait_for_device_creation?: boolean
21625
21809
  }
21626
21810
  commonParams: {}
21627
21811
  formData: {}
21628
21812
  jsonResponse: {
21629
- /** */
21813
+ /** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
21814
+
21815
+ Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
21816
+
21817
+ Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
21818
+
21819
+ To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
21820
+
21821
+ When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
21822
+
21823
+ To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
21630
21824
  connect_webview: {
21631
21825
  connect_webview_id: string
21632
21826
  workspace_id: string
@@ -21659,6 +21853,7 @@ export interface Routes {
21659
21853
  method: 'DELETE' | 'POST'
21660
21854
  queryParams: {}
21661
21855
  jsonBody: {
21856
+ /** ID of the Connect Webview that you want to delete. */
21662
21857
  connect_webview_id: string
21663
21858
  }
21664
21859
  commonParams: {}
@@ -21671,11 +21866,22 @@ export interface Routes {
21671
21866
  queryParams: {}
21672
21867
  jsonBody: {}
21673
21868
  commonParams: {
21869
+ /** ID of the Connect Webview that you want to get. */
21674
21870
  connect_webview_id: string
21675
21871
  }
21676
21872
  formData: {}
21677
21873
  jsonResponse: {
21678
- /** */
21874
+ /** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
21875
+
21876
+ Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
21877
+
21878
+ Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
21879
+
21880
+ To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
21881
+
21882
+ When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
21883
+
21884
+ To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
21679
21885
  connect_webview: {
21680
21886
  connect_webview_id: string
21681
21887
  workspace_id: string
@@ -21709,10 +21915,11 @@ export interface Routes {
21709
21915
  queryParams: {}
21710
21916
  jsonBody: {}
21711
21917
  commonParams: {
21712
- /** Returns webviews that can be accessed by the provided user_identifier_key. */
21918
+ /** Your user ID for the user by which you want to filter Connect Webviews. */
21713
21919
  user_identifier_key?: string | undefined
21714
- /** Returns webviews whose custom_metadata contains all of the provided key/value pairs. */
21920
+ /** 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. */
21715
21921
  custom_metadata_has?: Record<string, string | boolean> | undefined
21922
+ /** Maximum number of records to return per page. */
21716
21923
  limit?: number
21717
21924
  }
21718
21925
  formData: {}
@@ -21749,7 +21956,9 @@ export interface Routes {
21749
21956
  method: 'DELETE' | 'POST'
21750
21957
  queryParams: {}
21751
21958
  jsonBody: {
21959
+ /** ID of the connected account that you want to delete. */
21752
21960
  connected_account_id: string
21961
+ /** */
21753
21962
  sync?: boolean
21754
21963
  }
21755
21964
  commonParams: {}
@@ -21763,14 +21972,16 @@ export interface Routes {
21763
21972
  jsonBody: {}
21764
21973
  commonParams:
21765
21974
  | {
21975
+ /** ID of the connected account that you want to get. */
21766
21976
  connected_account_id: string
21767
21977
  }
21768
21978
  | {
21979
+ /** Email address associated with the connected account that you want to get. */
21769
21980
  email: string
21770
21981
  }
21771
21982
  formData: {}
21772
21983
  jsonResponse: {
21773
- /** */
21984
+ /** 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. */
21774
21985
  connected_account: {
21775
21986
  connected_account_id?: string | undefined
21776
21987
  created_at?: string | undefined
@@ -21873,9 +22084,9 @@ export interface Routes {
21873
22084
  queryParams: {}
21874
22085
  jsonBody: {}
21875
22086
  commonParams: {
21876
- /** Returns accounts that can be accessed by the provided user_identifier_key. */
22087
+ /** Your user ID for the user by which you want to filter connected accounts. */
21877
22088
  user_identifier_key?: string | undefined
21878
- /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
22089
+ /** 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. */
21879
22090
  custom_metadata_has?: Record<string, string | boolean> | undefined
21880
22091
  customer_ids?: string[] | undefined
21881
22092
  /** Maximum number of records to return per page. */
@@ -21995,14 +22206,17 @@ export interface Routes {
21995
22206
  method: 'POST'
21996
22207
  queryParams: {}
21997
22208
  jsonBody: {
22209
+ /** ID of the connected account that you want to update. */
21998
22210
  connected_account_id: string
22211
+ /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
21999
22212
  automatically_manage_new_devices?: boolean | undefined
22213
+ /** 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). */
22000
22214
  custom_metadata?: Record<string, string | boolean | null> | undefined
22001
22215
  }
22002
22216
  commonParams: {}
22003
22217
  formData: {}
22004
22218
  jsonResponse: {
22005
- /** */
22219
+ /** 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. */
22006
22220
  connected_account: {
22007
22221
  connected_account_id?: string | undefined
22008
22222
  created_at?: string | undefined
@@ -22105,6 +22319,7 @@ export interface Routes {
22105
22319
  queryParams: {}
22106
22320
  jsonBody: {}
22107
22321
  commonParams: {
22322
+ /** ID of the device that you want to delete. */
22108
22323
  device_id: string
22109
22324
  }
22110
22325
  formData: {}
@@ -22116,12 +22331,14 @@ export interface Routes {
22116
22331
  queryParams: {}
22117
22332
  jsonBody: {}
22118
22333
  commonParams: {
22334
+ /** ID of the device that you want to get. */
22119
22335
  device_id?: string | undefined
22336
+ /** Name of the device that you want to get. */
22120
22337
  name?: string | undefined
22121
22338
  }
22122
22339
  formData: {}
22123
22340
  jsonResponse: {
22124
- /** */
22341
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
22125
22342
  device: {
22126
22343
  /** Unique identifier for the device. */
22127
22344
  device_id: string
@@ -22231,7 +22448,7 @@ export interface Routes {
22231
22448
  status: 'critical' | 'low' | 'good' | 'full'
22232
22449
  }
22233
22450
  | undefined
22234
- /** Manufacturer of the device. */
22451
+ /** 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. */
22235
22452
  manufacturer?: string | undefined
22236
22453
  /** Image URL for the device. */
22237
22454
  image_url?: string | undefined
@@ -22591,6 +22808,7 @@ export interface Routes {
22591
22808
  _experimental_supported_code_from_access_codes_lengths?:
22592
22809
  | (number[] | undefined)
22593
22810
  | undefined
22811
+ /** 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. */
22594
22812
  code_constraints?:
22595
22813
  | (
22596
22814
  | Array<
@@ -23118,13 +23336,13 @@ export interface Routes {
23118
23336
  jsonBody: {}
23119
23337
  commonParams: {
23120
23338
  customer_ids?: string[] | undefined
23121
- /** ID of the connected account by which to filter. */
23339
+ /** ID of the connected account for which you want to list devices. */
23122
23340
  connected_account_id?: string | undefined
23123
- /** Array of IDs of the connected accounts by which to filter devices. */
23341
+ /** Array of IDs of the connected accounts for which you want to list devices. */
23124
23342
  connected_account_ids?: string[] | undefined
23125
- /** ID of the Connect Webview by which to filter devices. */
23343
+ /** ID of the Connect Webview for which you want to list devices. */
23126
23344
  connect_webview_id?: string | undefined
23127
- /** Device type by which to filter devices. */
23345
+ /** Device type for which you want to list devices. */
23128
23346
  device_type?:
23129
23347
  | (
23130
23348
  | (
@@ -23168,7 +23386,7 @@ export interface Routes {
23168
23386
  | ('ios_phone' | 'android_phone')
23169
23387
  )
23170
23388
  | undefined
23171
- /** Array of device types by which to filter devices. */
23389
+ /** Array of device types for which you want to list devices. */
23172
23390
  device_types?:
23173
23391
  | Array<
23174
23392
  | (
@@ -23212,7 +23430,7 @@ export interface Routes {
23212
23430
  | ('ios_phone' | 'android_phone')
23213
23431
  >
23214
23432
  | undefined
23215
- /** Manufacturer by which to filter devices. */
23433
+ /** Manufacturer for which you want to list devices. */
23216
23434
  manufacturer?:
23217
23435
  | (
23218
23436
  | 'akuvox'
@@ -23255,15 +23473,15 @@ export interface Routes {
23255
23473
  | 'sensi'
23256
23474
  )
23257
23475
  | undefined
23258
- /** Array of device IDs by which to filter devices. */
23476
+ /** Array of device IDs for which you want to list devices. */
23259
23477
  device_ids?: string[] | undefined
23260
23478
  /** Numerical limit on the number of devices to return. */
23261
23479
  limit?: number
23262
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
23480
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
23263
23481
  created_before?: Date | undefined
23264
- /** Your own internal user ID for the user by which to filter devices. */
23482
+ /** Your own internal user ID for the user for which you want to list devices. */
23265
23483
  user_identifier_key?: string | undefined
23266
- /** 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. */
23484
+ /** 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. */
23267
23485
  custom_metadata_has?: Record<string, string | boolean> | undefined
23268
23486
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
23269
23487
  page_cursor?: (string | undefined) | null
@@ -23299,7 +23517,7 @@ export interface Routes {
23299
23517
  | 'can_simulate_disconnection'
23300
23518
  >
23301
23519
  | undefined
23302
- /** */
23520
+ /** ID of the location for which you want to list devices. */
23303
23521
  unstable_location_id?: (string | null) | undefined
23304
23522
  }
23305
23523
  formData: {}
@@ -23413,7 +23631,7 @@ export interface Routes {
23413
23631
  status: 'critical' | 'low' | 'good' | 'full'
23414
23632
  }
23415
23633
  | undefined
23416
- /** Manufacturer of the device. */
23634
+ /** 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. */
23417
23635
  manufacturer?: string | undefined
23418
23636
  /** Image URL for the device. */
23419
23637
  image_url?: string | undefined
@@ -23773,6 +23991,7 @@ export interface Routes {
23773
23991
  _experimental_supported_code_from_access_codes_lengths?:
23774
23992
  | (number[] | undefined)
23775
23993
  | undefined
23994
+ /** 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. */
23776
23995
  code_constraints?:
23777
23996
  | (
23778
23997
  | Array<
@@ -24308,6 +24527,7 @@ export interface Routes {
24308
24527
  queryParams: {}
24309
24528
  jsonBody: {}
24310
24529
  commonParams: {
24530
+ /** Category for which you want to list providers. */
24311
24531
  provider_category?:
24312
24532
  | (
24313
24533
  | 'stable'
@@ -24397,6 +24617,7 @@ export interface Routes {
24397
24617
  method: 'POST'
24398
24618
  queryParams: {}
24399
24619
  jsonBody: {
24620
+ /** ID of the device that you want to simulate connecting to Seam. */
24400
24621
  device_id: string
24401
24622
  }
24402
24623
  commonParams: {}
@@ -24408,6 +24629,7 @@ export interface Routes {
24408
24629
  method: 'POST'
24409
24630
  queryParams: {}
24410
24631
  jsonBody: {
24632
+ /** ID of the device that you want to simulate disconnecting from Seam. */
24411
24633
  device_id: string
24412
24634
  }
24413
24635
  commonParams: {}
@@ -24419,6 +24641,7 @@ export interface Routes {
24419
24641
  method: 'DELETE' | 'POST'
24420
24642
  queryParams: {}
24421
24643
  jsonBody: {
24644
+ /** ID of the device that you want to simulate removing from Seam. */
24422
24645
  device_id: string
24423
24646
  }
24424
24647
  commonParams: {}
@@ -24431,12 +24654,14 @@ export interface Routes {
24431
24654
  queryParams: {}
24432
24655
  jsonBody: {}
24433
24656
  commonParams: {
24657
+ /** ID of the unmanaged device that you want to get. */
24434
24658
  device_id?: string | undefined
24659
+ /** Name of the unmanaged device that you want to get. */
24435
24660
  name?: string | undefined
24436
24661
  }
24437
24662
  formData: {}
24438
24663
  jsonResponse: {
24439
- /** */
24664
+ /** 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). */
24440
24665
  device: {
24441
24666
  /** Unique identifier for the device. */
24442
24667
  device_id: string
@@ -24742,7 +24967,7 @@ export interface Routes {
24742
24967
  name: string
24743
24968
  /** Indicates whether the device is online. */
24744
24969
  online: boolean
24745
- /** Manufacturer of the device. */
24970
+ /** 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. */
24746
24971
  manufacturer?: string | undefined
24747
24972
  /** Image URL for the device. */
24748
24973
  image_url?: string | undefined
@@ -24800,13 +25025,13 @@ export interface Routes {
24800
25025
  jsonBody: {}
24801
25026
  commonParams: {
24802
25027
  customer_ids?: string[] | undefined
24803
- /** ID of the connected account by which to filter. */
25028
+ /** ID of the connected account for which you want to list devices. */
24804
25029
  connected_account_id?: string | undefined
24805
- /** Array of IDs of the connected accounts by which to filter devices. */
25030
+ /** Array of IDs of the connected accounts for which you want to list devices. */
24806
25031
  connected_account_ids?: string[] | undefined
24807
- /** ID of the Connect Webview by which to filter devices. */
25032
+ /** ID of the Connect Webview for which you want to list devices. */
24808
25033
  connect_webview_id?: string | undefined
24809
- /** Device type by which to filter devices. */
25034
+ /** Device type for which you want to list devices. */
24810
25035
  device_type?:
24811
25036
  | (
24812
25037
  | (
@@ -24850,7 +25075,7 @@ export interface Routes {
24850
25075
  | ('ios_phone' | 'android_phone')
24851
25076
  )
24852
25077
  | undefined
24853
- /** Array of device types by which to filter devices. */
25078
+ /** Array of device types for which you want to list devices. */
24854
25079
  device_types?:
24855
25080
  | Array<
24856
25081
  | (
@@ -24894,7 +25119,7 @@ export interface Routes {
24894
25119
  | ('ios_phone' | 'android_phone')
24895
25120
  >
24896
25121
  | undefined
24897
- /** Manufacturer by which to filter devices. */
25122
+ /** Manufacturer for which you want to list devices. */
24898
25123
  manufacturer?:
24899
25124
  | (
24900
25125
  | 'akuvox'
@@ -24937,15 +25162,15 @@ export interface Routes {
24937
25162
  | 'sensi'
24938
25163
  )
24939
25164
  | undefined
24940
- /** Array of device IDs by which to filter devices. */
25165
+ /** Array of device IDs for which you want to list devices. */
24941
25166
  device_ids?: string[] | undefined
24942
25167
  /** Numerical limit on the number of devices to return. */
24943
25168
  limit?: number
24944
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
25169
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
24945
25170
  created_before?: Date | undefined
24946
- /** Your own internal user ID for the user by which to filter devices. */
25171
+ /** Your own internal user ID for the user for which you want to list devices. */
24947
25172
  user_identifier_key?: string | undefined
24948
- /** 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. */
25173
+ /** 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. */
24949
25174
  custom_metadata_has?: Record<string, string | boolean> | undefined
24950
25175
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
24951
25176
  page_cursor?: (string | undefined) | null
@@ -24981,7 +25206,7 @@ export interface Routes {
24981
25206
  | 'can_simulate_disconnection'
24982
25207
  >
24983
25208
  | undefined
24984
- /** */
25209
+ /** ID of the location for which you want to list devices. */
24985
25210
  unstable_location_id?: (string | null) | undefined
24986
25211
  }
24987
25212
  formData: {}
@@ -25291,7 +25516,7 @@ export interface Routes {
25291
25516
  name: string
25292
25517
  /** Indicates whether the device is online. */
25293
25518
  online: boolean
25294
- /** Manufacturer of the device. */
25519
+ /** 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. */
25295
25520
  manufacturer?: string | undefined
25296
25521
  /** Image URL for the device. */
25297
25522
  image_url?: string | undefined
@@ -25348,7 +25573,9 @@ export interface Routes {
25348
25573
  queryParams: {}
25349
25574
  jsonBody: {}
25350
25575
  commonParams: {
25576
+ /** ID of the unmanaged device that you want to update. */
25351
25577
  device_id: string
25578
+ /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
25352
25579
  is_managed: true
25353
25580
  }
25354
25581
  formData: {}
@@ -25360,14 +25587,19 @@ export interface Routes {
25360
25587
  queryParams: {}
25361
25588
  jsonBody: {}
25362
25589
  commonParams: {
25590
+ /** ID of the device that you want to update. */
25363
25591
  device_id: string
25364
25592
  properties?:
25365
25593
  | {
25594
+ /** Name for the device. */
25366
25595
  name?: (string | null) | undefined
25367
25596
  }
25368
25597
  | undefined
25598
+ /** Name for the device. */
25369
25599
  name?: (string | null) | undefined
25600
+ /** Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`. */
25370
25601
  is_managed?: boolean
25602
+ /** 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). */
25371
25603
  custom_metadata?: Record<string, string | boolean | null> | undefined
25372
25604
  }
25373
25605
  formData: {}
@@ -25385,7 +25617,9 @@ export interface Routes {
25385
25617
  }
25386
25618
  formData: {}
25387
25619
  jsonResponse: {
25388
- /** */
25620
+ /** 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.
25621
+
25622
+ As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. */
25389
25623
  event?:
25390
25624
  | (
25391
25625
  | {
@@ -28541,7 +28775,7 @@ export interface Routes {
28541
28775
  }
28542
28776
  formData: {}
28543
28777
  jsonResponse: {
28544
- /** */
28778
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
28545
28779
  lock: {
28546
28780
  /** Unique identifier for the device. */
28547
28781
  device_id: string
@@ -28651,7 +28885,7 @@ export interface Routes {
28651
28885
  status: 'critical' | 'low' | 'good' | 'full'
28652
28886
  }
28653
28887
  | undefined
28654
- /** Manufacturer of the device. */
28888
+ /** 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. */
28655
28889
  manufacturer?: string | undefined
28656
28890
  /** Image URL for the device. */
28657
28891
  image_url?: string | undefined
@@ -29011,6 +29245,7 @@ export interface Routes {
29011
29245
  _experimental_supported_code_from_access_codes_lengths?:
29012
29246
  | (number[] | undefined)
29013
29247
  | undefined
29248
+ /** 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. */
29014
29249
  code_constraints?:
29015
29250
  | (
29016
29251
  | Array<
@@ -29529,7 +29764,7 @@ export interface Routes {
29529
29764
  can_simulate_connection?: boolean | undefined
29530
29765
  can_simulate_disconnection?: boolean | undefined
29531
29766
  }
29532
- /** */
29767
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
29533
29768
  device: {
29534
29769
  /** Unique identifier for the device. */
29535
29770
  device_id: string
@@ -29639,7 +29874,7 @@ export interface Routes {
29639
29874
  status: 'critical' | 'low' | 'good' | 'full'
29640
29875
  }
29641
29876
  | undefined
29642
- /** Manufacturer of the device. */
29877
+ /** 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. */
29643
29878
  manufacturer?: string | undefined
29644
29879
  /** Image URL for the device. */
29645
29880
  image_url?: string | undefined
@@ -29999,6 +30234,7 @@ export interface Routes {
29999
30234
  _experimental_supported_code_from_access_codes_lengths?:
30000
30235
  | (number[] | undefined)
30001
30236
  | undefined
30237
+ /** 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. */
30002
30238
  code_constraints?:
30003
30239
  | (
30004
30240
  | Array<
@@ -30526,11 +30762,11 @@ export interface Routes {
30526
30762
  jsonBody: {}
30527
30763
  commonParams: {
30528
30764
  customer_ids?: string[] | undefined
30529
- /** ID of the connected account by which to filter. */
30765
+ /** ID of the connected account for which you want to list devices. */
30530
30766
  connected_account_id?: string | undefined
30531
- /** Array of IDs of the connected accounts by which to filter devices. */
30767
+ /** Array of IDs of the connected accounts for which you want to list devices. */
30532
30768
  connected_account_ids?: string[] | undefined
30533
- /** ID of the Connect Webview by which to filter devices. */
30769
+ /** ID of the Connect Webview for which you want to list devices. */
30534
30770
  connect_webview_id?: string | undefined
30535
30771
  /** Device type by which to filter devices. */
30536
30772
  device_type?:
@@ -30628,15 +30864,15 @@ export interface Routes {
30628
30864
  | 'akiles'
30629
30865
  )
30630
30866
  | undefined
30631
- /** Array of device IDs by which to filter devices. */
30867
+ /** Array of device IDs for which you want to list devices. */
30632
30868
  device_ids?: string[] | undefined
30633
30869
  /** Numerical limit on the number of devices to return. */
30634
30870
  limit?: number
30635
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
30871
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
30636
30872
  created_before?: Date | undefined
30637
- /** Your own internal user ID for the user by which to filter devices. */
30873
+ /** Your own internal user ID for the user for which you want to list devices. */
30638
30874
  user_identifier_key?: string | undefined
30639
- /** 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. */
30875
+ /** 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. */
30640
30876
  custom_metadata_has?: Record<string, string | boolean> | undefined
30641
30877
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
30642
30878
  page_cursor?: (string | undefined) | null
@@ -30672,7 +30908,7 @@ export interface Routes {
30672
30908
  | 'can_simulate_disconnection'
30673
30909
  >
30674
30910
  | undefined
30675
- /** */
30911
+ /** ID of the location for which you want to list devices. */
30676
30912
  unstable_location_id?: (string | null) | undefined
30677
30913
  }
30678
30914
  formData: {}
@@ -30786,7 +31022,7 @@ export interface Routes {
30786
31022
  status: 'critical' | 'low' | 'good' | 'full'
30787
31023
  }
30788
31024
  | undefined
30789
- /** Manufacturer of the device. */
31025
+ /** 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. */
30790
31026
  manufacturer?: string | undefined
30791
31027
  /** Image URL for the device. */
30792
31028
  image_url?: string | undefined
@@ -31146,6 +31382,7 @@ export interface Routes {
31146
31382
  _experimental_supported_code_from_access_codes_lengths?:
31147
31383
  | (number[] | undefined)
31148
31384
  | undefined
31385
+ /** 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. */
31149
31386
  code_constraints?:
31150
31387
  | (
31151
31388
  | Array<
@@ -31773,7 +32010,7 @@ export interface Routes {
31773
32010
  status: 'critical' | 'low' | 'good' | 'full'
31774
32011
  }
31775
32012
  | undefined
31776
- /** Manufacturer of the device. */
32013
+ /** 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. */
31777
32014
  manufacturer?: string | undefined
31778
32015
  /** Image URL for the device. */
31779
32016
  image_url?: string | undefined
@@ -32133,6 +32370,7 @@ export interface Routes {
32133
32370
  _experimental_supported_code_from_access_codes_lengths?:
32134
32371
  | (number[] | undefined)
32135
32372
  | undefined
32373
+ /** 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. */
32136
32374
  code_constraints?:
32137
32375
  | (
32138
32376
  | Array<
@@ -37914,11 +38152,11 @@ export interface Routes {
37914
38152
  jsonBody: {}
37915
38153
  commonParams: {
37916
38154
  customer_ids?: string[] | undefined
37917
- /** ID of the connected account by which to filter. */
38155
+ /** ID of the connected account for which you want to list devices. */
37918
38156
  connected_account_id?: string | undefined
37919
- /** Array of IDs of the connected accounts by which to filter devices. */
38157
+ /** Array of IDs of the connected accounts for which you want to list devices. */
37920
38158
  connected_account_ids?: string[] | undefined
37921
- /** ID of the Connect Webview by which to filter devices. */
38159
+ /** ID of the Connect Webview for which you want to list devices. */
37922
38160
  connect_webview_id?: string | undefined
37923
38161
  /** Device type by which to filter devices. */
37924
38162
  device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined
@@ -37928,15 +38166,15 @@ export interface Routes {
37928
38166
  | undefined
37929
38167
  /** Manufacturer by which to filter devices. */
37930
38168
  manufacturer?: ('minut' | 'noiseaware') | undefined
37931
- /** Array of device IDs by which to filter devices. */
38169
+ /** Array of device IDs for which you want to list devices. */
37932
38170
  device_ids?: string[] | undefined
37933
38171
  /** Numerical limit on the number of devices to return. */
37934
38172
  limit?: number
37935
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
38173
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
37936
38174
  created_before?: Date | undefined
37937
- /** Your own internal user ID for the user by which to filter devices. */
38175
+ /** Your own internal user ID for the user for which you want to list devices. */
37938
38176
  user_identifier_key?: string | undefined
37939
- /** 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. */
38177
+ /** 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. */
37940
38178
  custom_metadata_has?: Record<string, string | boolean> | undefined
37941
38179
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
37942
38180
  page_cursor?: (string | undefined) | null
@@ -37972,7 +38210,7 @@ export interface Routes {
37972
38210
  | 'can_simulate_disconnection'
37973
38211
  >
37974
38212
  | undefined
37975
- /** */
38213
+ /** ID of the location for which you want to list devices. */
37976
38214
  unstable_location_id?: (string | null) | undefined
37977
38215
  }
37978
38216
  formData: {}
@@ -38086,7 +38324,7 @@ export interface Routes {
38086
38324
  status: 'critical' | 'low' | 'good' | 'full'
38087
38325
  }
38088
38326
  | undefined
38089
- /** Manufacturer of the device. */
38327
+ /** 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. */
38090
38328
  manufacturer?: string | undefined
38091
38329
  /** Image URL for the device. */
38092
38330
  image_url?: string | undefined
@@ -38446,6 +38684,7 @@ export interface Routes {
38446
38684
  _experimental_supported_code_from_access_codes_lengths?:
38447
38685
  | (number[] | undefined)
38448
38686
  | undefined
38687
+ /** 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. */
38449
38688
  code_constraints?:
38450
38689
  | (
38451
38690
  | Array<
@@ -39073,7 +39312,7 @@ export interface Routes {
39073
39312
  status: 'critical' | 'low' | 'good' | 'full'
39074
39313
  }
39075
39314
  | undefined
39076
- /** Manufacturer of the device. */
39315
+ /** 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. */
39077
39316
  manufacturer?: string | undefined
39078
39317
  /** Image URL for the device. */
39079
39318
  image_url?: string | undefined
@@ -39433,6 +39672,7 @@ export interface Routes {
39433
39672
  _experimental_supported_code_from_access_codes_lengths?:
39434
39673
  | (number[] | undefined)
39435
39674
  | undefined
39675
+ /** 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. */
39436
39676
  code_constraints?:
39437
39677
  | (
39438
39678
  | Array<
@@ -44425,7 +44665,15 @@ export interface Routes {
44425
44665
  commonParams: {}
44426
44666
  formData: {}
44427
44667
  jsonResponse: {
44428
- /** */
44668
+ /** 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.
44669
+
44670
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
44671
+
44672
+ When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
44673
+
44674
+ A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
44675
+
44676
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
44429
44677
  client_session: {
44430
44678
  client_session_id: string
44431
44679
  workspace_id: string
@@ -48633,7 +48881,7 @@ export interface Routes {
48633
48881
  }
48634
48882
  formData: {}
48635
48883
  jsonResponse: {
48636
- /** */
48884
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
48637
48885
  thermostat: {
48638
48886
  /** Unique identifier for the device. */
48639
48887
  device_id: string
@@ -48743,7 +48991,7 @@ export interface Routes {
48743
48991
  status: 'critical' | 'low' | 'good' | 'full'
48744
48992
  }
48745
48993
  | undefined
48746
- /** Manufacturer of the device. */
48994
+ /** 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. */
48747
48995
  manufacturer?: string | undefined
48748
48996
  /** Image URL for the device. */
48749
48997
  image_url?: string | undefined
@@ -49103,6 +49351,7 @@ export interface Routes {
49103
49351
  _experimental_supported_code_from_access_codes_lengths?:
49104
49352
  | (number[] | undefined)
49105
49353
  | undefined
49354
+ /** 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. */
49106
49355
  code_constraints?:
49107
49356
  | (
49108
49357
  | Array<
@@ -52256,11 +52505,11 @@ export interface Routes {
52256
52505
  jsonBody: {}
52257
52506
  commonParams: {
52258
52507
  customer_ids?: string[] | undefined
52259
- /** ID of the connected account by which to filter. */
52508
+ /** ID of the connected account for which you want to list devices. */
52260
52509
  connected_account_id?: string | undefined
52261
- /** Array of IDs of the connected accounts by which to filter devices. */
52510
+ /** Array of IDs of the connected accounts for which you want to list devices. */
52262
52511
  connected_account_ids?: string[] | undefined
52263
- /** ID of the Connect Webview by which to filter devices. */
52512
+ /** ID of the Connect Webview for which you want to list devices. */
52264
52513
  connect_webview_id?: string | undefined
52265
52514
  /** Device type by which to filter thermostat devices. */
52266
52515
  device_type?:
@@ -52288,15 +52537,15 @@ export interface Routes {
52288
52537
  manufacturer?:
52289
52538
  | ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi')
52290
52539
  | undefined
52291
- /** Array of device IDs by which to filter devices. */
52540
+ /** Array of device IDs for which you want to list devices. */
52292
52541
  device_ids?: string[] | undefined
52293
52542
  /** Numerical limit on the number of devices to return. */
52294
52543
  limit?: number
52295
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
52544
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
52296
52545
  created_before?: Date | undefined
52297
- /** Your own internal user ID for the user by which to filter devices. */
52546
+ /** Your own internal user ID for the user for which you want to list devices. */
52298
52547
  user_identifier_key?: string | undefined
52299
- /** 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. */
52548
+ /** 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. */
52300
52549
  custom_metadata_has?: Record<string, string | boolean> | undefined
52301
52550
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
52302
52551
  page_cursor?: (string | undefined) | null
@@ -52332,7 +52581,7 @@ export interface Routes {
52332
52581
  | 'can_simulate_disconnection'
52333
52582
  >
52334
52583
  | undefined
52335
- /** */
52584
+ /** ID of the location for which you want to list devices. */
52336
52585
  unstable_location_id?: (string | null) | undefined
52337
52586
  }
52338
52587
  formData: {}
@@ -52446,7 +52695,7 @@ export interface Routes {
52446
52695
  status: 'critical' | 'low' | 'good' | 'full'
52447
52696
  }
52448
52697
  | undefined
52449
- /** Manufacturer of the device. */
52698
+ /** 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. */
52450
52699
  manufacturer?: string | undefined
52451
52700
  /** Image URL for the device. */
52452
52701
  image_url?: string | undefined
@@ -52806,6 +53055,7 @@ export interface Routes {
52806
53055
  _experimental_supported_code_from_access_codes_lengths?:
52807
53056
  | (number[] | undefined)
52808
53057
  | undefined
53058
+ /** 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. */
52809
53059
  code_constraints?:
52810
53060
  | (
52811
53061
  | Array<
@@ -53433,7 +53683,7 @@ export interface Routes {
53433
53683
  status: 'critical' | 'low' | 'good' | 'full'
53434
53684
  }
53435
53685
  | undefined
53436
- /** Manufacturer of the device. */
53686
+ /** 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. */
53437
53687
  manufacturer?: string | undefined
53438
53688
  /** Image URL for the device. */
53439
53689
  image_url?: string | undefined
@@ -53793,6 +54043,7 @@ export interface Routes {
53793
54043
  _experimental_supported_code_from_access_codes_lengths?:
53794
54044
  | (number[] | undefined)
53795
54045
  | undefined
54046
+ /** 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. */
53796
54047
  code_constraints?:
53797
54048
  | (
53798
54049
  | Array<
@@ -60328,6 +60579,45 @@ export interface Routes {
60328
60579
  }
60329
60580
  }
60330
60581
  }
60582
+ '/unstable_partner/resources/push': {
60583
+ route: '/unstable_partner/resources/push'
60584
+ method: 'POST'
60585
+ queryParams: {}
60586
+ jsonBody:
60587
+ | Array<{
60588
+ partner_resource_type?: string | undefined
60589
+ partner_resource_key?: string | undefined
60590
+ customer_key?: string | undefined
60591
+ email_address?: string | undefined
60592
+ phone_number?: string | undefined
60593
+ starts_at?: string | undefined
60594
+ ends_at?: string | undefined
60595
+ user_identity_key?: string | undefined
60596
+ location_keys?: string[] | undefined
60597
+ name?: string | undefined
60598
+ description?: string | undefined
60599
+ icon_url?: string | undefined
60600
+ custom_metadata?: Record<string, string> | undefined
60601
+ }>
60602
+ | {
60603
+ partner_resource_type?: string | undefined
60604
+ partner_resource_key?: string | undefined
60605
+ customer_key?: string | undefined
60606
+ email_address?: string | undefined
60607
+ phone_number?: string | undefined
60608
+ starts_at?: string | undefined
60609
+ ends_at?: string | undefined
60610
+ user_identity_key?: string | undefined
60611
+ location_keys?: string[] | undefined
60612
+ name?: string | undefined
60613
+ description?: string | undefined
60614
+ icon_url?: string | undefined
60615
+ custom_metadata?: Record<string, string> | undefined
60616
+ }
60617
+ commonParams: {}
60618
+ formData: {}
60619
+ jsonResponse: {}
60620
+ }
60331
60621
  '/user_identities/add_acs_user': {
60332
60622
  route: '/user_identities/add_acs_user'
60333
60623
  method: 'POST' | 'PUT'
@@ -60361,7 +60651,7 @@ export interface Routes {
60361
60651
  }
60362
60652
  formData: {}
60363
60653
  jsonResponse: {
60364
- /** 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. */
60654
+ /** 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. */
60365
60655
  user_identity: {
60366
60656
  /** ID of the user identity. */
60367
60657
  user_identity_id: string
@@ -60524,7 +60814,7 @@ export interface Routes {
60524
60814
  }
60525
60815
  formData: {}
60526
60816
  jsonResponse: {
60527
- /** 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. */
60817
+ /** 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. */
60528
60818
  user_identity: {
60529
60819
  /** ID of the user identity. */
60530
60820
  user_identity_id: string
@@ -60705,7 +60995,7 @@ export interface Routes {
60705
60995
  status: 'critical' | 'low' | 'good' | 'full'
60706
60996
  }
60707
60997
  | undefined
60708
- /** Manufacturer of the device. */
60998
+ /** 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. */
60709
60999
  manufacturer?: string | undefined
60710
61000
  /** Image URL for the device. */
60711
61001
  image_url?: string | undefined
@@ -61065,6 +61355,7 @@ export interface Routes {
61065
61355
  _experimental_supported_code_from_access_codes_lengths?:
61066
61356
  | (number[] | undefined)
61067
61357
  | undefined
61358
+ /** 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. */
61068
61359
  code_constraints?:
61069
61360
  | (
61070
61361
  | Array<
@@ -61694,7 +61985,7 @@ export interface Routes {
61694
61985
  status: 'critical' | 'low' | 'good' | 'full'
61695
61986
  }
61696
61987
  | undefined
61697
- /** Manufacturer of the device. */
61988
+ /** 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. */
61698
61989
  manufacturer?: string | undefined
61699
61990
  /** Image URL for the device. */
61700
61991
  image_url?: string | undefined
@@ -62054,6 +62345,7 @@ export interface Routes {
62054
62345
  _experimental_supported_code_from_access_codes_lengths?:
62055
62346
  | (number[] | undefined)
62056
62347
  | undefined
62348
+ /** 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. */
62057
62349
  code_constraints?:
62058
62350
  | (
62059
62351
  | Array<
@@ -63152,7 +63444,7 @@ export interface Routes {
63152
63444
  commonParams: {}
63153
63445
  formData: {}
63154
63446
  jsonResponse: {
63155
- /** */
63447
+ /** 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). */
63156
63448
  workspace: {
63157
63449
  workspace_id: string
63158
63450
  name: string
@@ -63181,7 +63473,7 @@ export interface Routes {
63181
63473
  commonParams: {}
63182
63474
  formData: {}
63183
63475
  jsonResponse: {
63184
- /** */
63476
+ /** 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). */
63185
63477
  workspace: {
63186
63478
  workspace_id: string
63187
63479
  name: string