@seamapi/types 1.399.0 → 1.400.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +889 -297
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +848 -179
- package/lib/seam/connect/models/access-codes/managed-access-code.js +8 -2
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +4 -0
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.js +9 -0
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +13 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -0
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +4 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/device.js +5 -1
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.js +3 -0
- package/lib/seam/connect/models/events/seam-event.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +1 -0
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +381 -0
- package/lib/seam/connect/openapi.js +807 -258
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +467 -179
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +8 -2
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +4 -0
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +9 -0
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +13 -0
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -0
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +6 -1
- package/src/lib/seam/connect/models/devices/device.ts +7 -1
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
- package/src/lib/seam/connect/models/events/seam-event.ts +3 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
- package/src/lib/seam/connect/models/workspaces/workspace.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +1010 -258
- package/src/lib/seam/connect/route-types.ts +469 -179
package/dist/connect.cjs
CHANGED
|
@@ -90,7 +90,9 @@ var access_code_constraint = zod.z.union([
|
|
|
90
90
|
]);
|
|
91
91
|
var access_code_capability_properties = zod.z.object({
|
|
92
92
|
_experimental_supported_code_from_access_codes_lengths: zod.z.array(zod.z.number()).optional(),
|
|
93
|
-
code_constraints: zod.z.array(access_code_constraint).optional()
|
|
93
|
+
code_constraints: zod.z.array(access_code_constraint).optional().describe(
|
|
94
|
+
"Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific."
|
|
95
|
+
),
|
|
94
96
|
supported_code_lengths: zod.z.array(zod.z.number()).optional(),
|
|
95
97
|
max_active_codes_supported: zod.z.number().optional(),
|
|
96
98
|
supports_backup_access_code_pool: zod.z.boolean().optional(),
|
|
@@ -629,6 +631,7 @@ var connected_account = zod.z.object({
|
|
|
629
631
|
---
|
|
630
632
|
route_path: /connected_accounts
|
|
631
633
|
---
|
|
634
|
+
Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
|
|
632
635
|
`);
|
|
633
636
|
var dormakaba_oracode_time_slot = zod.z.object({
|
|
634
637
|
name: zod.z.string(),
|
|
@@ -1199,7 +1202,9 @@ var common_device_properties = zod.z.object({
|
|
|
1199
1202
|
'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.'
|
|
1200
1203
|
),
|
|
1201
1204
|
// todo: use enum
|
|
1202
|
-
manufacturer: zod.z.string().optional().describe(
|
|
1205
|
+
manufacturer: zod.z.string().optional().describe(
|
|
1206
|
+
"Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub."
|
|
1207
|
+
),
|
|
1203
1208
|
image_url: zod.z.string().url().optional().describe("Image URL for the device."),
|
|
1204
1209
|
image_alt_text: zod.z.string().optional().describe("Alt text for the device image."),
|
|
1205
1210
|
serial_number: zod.z.string().optional().describe("Serial number of the device."),
|
|
@@ -1282,6 +1287,7 @@ var device = zod.z.object({
|
|
|
1282
1287
|
---
|
|
1283
1288
|
route_path: /devices
|
|
1284
1289
|
---
|
|
1290
|
+
Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.
|
|
1285
1291
|
`);
|
|
1286
1292
|
var DEVICE_PROVIDERS = {
|
|
1287
1293
|
DORMAKABA_COMMUNITY: "dormakaba_community",
|
|
@@ -1433,6 +1439,7 @@ var unmanaged_device = device.pick({
|
|
|
1433
1439
|
---
|
|
1434
1440
|
route_path: /devices/unmanaged
|
|
1435
1441
|
---
|
|
1442
|
+
Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
1436
1443
|
`);
|
|
1437
1444
|
|
|
1438
1445
|
// src/lib/seam/connect/models/access-codes/managed-access-code.ts
|
|
@@ -1674,7 +1681,13 @@ var access_code = zod.z.object({
|
|
|
1674
1681
|
"Unique identifier for the device associated with the access code."
|
|
1675
1682
|
),
|
|
1676
1683
|
name: zod.z.string().nullable().describe(
|
|
1677
|
-
|
|
1684
|
+
`Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
1685
|
+
|
|
1686
|
+
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as \`first_name\` and \`last_name\`.
|
|
1687
|
+
|
|
1688
|
+
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
1689
|
+
|
|
1690
|
+
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called \`appearance\`. This is an object with a \`name\` property and, optionally, \`first_name\` and \`last_name\` properties (for providers that break down a name into components).`
|
|
1678
1691
|
),
|
|
1679
1692
|
code: zod.z.string().nullable().describe(
|
|
1680
1693
|
"Code used for access. Typically, a numeric or alphanumeric string."
|
|
@@ -1725,7 +1738,7 @@ var access_code = zod.z.object({
|
|
|
1725
1738
|
|
|
1726
1739
|
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
1727
1740
|
|
|
1728
|
-
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`.
|
|
1741
|
+
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the \`type\` property of the access code. Ongoing codes display as \`ongoing\`, whereas time-bound codes are labeled \`time_bound\`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both \`starts_at\` and \`ends_at\` empty. A time-bound access code will be programmed at the \`starts_at\` time and removed at the \`ends_at\` time.
|
|
1729
1742
|
|
|
1730
1743
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
|
|
1731
1744
|
`);
|
|
@@ -1757,6 +1770,10 @@ var unmanaged_access_code = access_code.pick({
|
|
|
1757
1770
|
When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
|
|
1758
1771
|
|
|
1759
1772
|
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
|
|
1773
|
+
|
|
1774
|
+
Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
1775
|
+
|
|
1776
|
+
- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
|
|
1760
1777
|
`);
|
|
1761
1778
|
var access_method = zod.z.object({
|
|
1762
1779
|
workspace_id: zod.z.string().uuid().describe(
|
|
@@ -3308,6 +3325,15 @@ var client_session = zod.z.object({
|
|
|
3308
3325
|
---
|
|
3309
3326
|
route_path: /client_sessions
|
|
3310
3327
|
---
|
|
3328
|
+
Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
3329
|
+
|
|
3330
|
+
You create each client session with a custom \`user_identifier_key\`. Normally, the \`user_identifier_key\` is a user ID that your application provides.
|
|
3331
|
+
|
|
3332
|
+
When calling the Seam API from your backend using an API key, you can pass the \`user_identifier_key\` as a parameter to limit results to the associated client session. For example, \`/devices/list?user_identifier_key=123\` only returns devices associated with the client session created with the \`user_identifier_key\` \`123\`.
|
|
3333
|
+
|
|
3334
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
3335
|
+
|
|
3336
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).
|
|
3311
3337
|
`);
|
|
3312
3338
|
var connect_webview_device_selection_mode = zod.z.enum([
|
|
3313
3339
|
"none",
|
|
@@ -3326,6 +3352,7 @@ var connect_webview = zod.z.object({
|
|
|
3326
3352
|
accepted_devices: zod.z.array(zod.z.string()).describe(
|
|
3327
3353
|
`
|
|
3328
3354
|
---
|
|
3355
|
+
undocumented: Unused. Will be removed.
|
|
3329
3356
|
deprecated: Unused. Will be removed.
|
|
3330
3357
|
---
|
|
3331
3358
|
`
|
|
@@ -3333,6 +3360,7 @@ var connect_webview = zod.z.object({
|
|
|
3333
3360
|
any_device_allowed: zod.z.boolean().describe(
|
|
3334
3361
|
`
|
|
3335
3362
|
---
|
|
3363
|
+
undocumented: Unused. Will be removed.
|
|
3336
3364
|
deprecated: Unused. Will be removed.
|
|
3337
3365
|
---
|
|
3338
3366
|
`
|
|
@@ -3351,6 +3379,17 @@ var connect_webview = zod.z.object({
|
|
|
3351
3379
|
---
|
|
3352
3380
|
route_path: /connect_webviews
|
|
3353
3381
|
---
|
|
3382
|
+
Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
|
|
3383
|
+
|
|
3384
|
+
Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and\u2014once your user has completed the authorization through your app\u2014you can access and control their devices or systems using the Seam API.
|
|
3385
|
+
|
|
3386
|
+
Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
|
|
3387
|
+
|
|
3388
|
+
To enable a user to connect their device or system account to Seam through your app, first create a \`connect_webview\`. Once created, this \`connect_webview\` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
|
|
3389
|
+
|
|
3390
|
+
When you create a Connect Webview, specify the desired provider category key in the \`provider_category\` parameter. Alternately, to specify a list of providers explicitly, use the \`accepted_providers\` parameter with a list of device provider keys.
|
|
3391
|
+
|
|
3392
|
+
To list all providers within a category, use \`/devices/list_device_providers\` with the desired \`provider_category\` filter. To list all provider keys, use \`/devices/list_device_providers\` with no filters.
|
|
3354
3393
|
`);
|
|
3355
3394
|
var common_event = zod.z.object({
|
|
3356
3395
|
event_id: zod.z.string().uuid().describe("ID of the event."),
|
|
@@ -4451,6 +4490,9 @@ var seam_event = zod.z.discriminatedUnion("event_type", [
|
|
|
4451
4490
|
---
|
|
4452
4491
|
route_path: /events
|
|
4453
4492
|
---
|
|
4493
|
+
Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a \`lock.unlocked\` event. When a device's battery level is low, Seam creates a \`device.battery_low\` event.
|
|
4494
|
+
|
|
4495
|
+
As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.
|
|
4454
4496
|
`);
|
|
4455
4497
|
var event_types = seam_event.options.map(
|
|
4456
4498
|
(schema) => schema.shape.event_type.value
|
|
@@ -4513,7 +4555,7 @@ var user_identity = zod.z.object({
|
|
|
4513
4555
|
---
|
|
4514
4556
|
route_path: /user_identities
|
|
4515
4557
|
---
|
|
4516
|
-
Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
4558
|
+
Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
|
|
4517
4559
|
`);
|
|
4518
4560
|
var webhook = zod.z.object({
|
|
4519
4561
|
webhook_id: zod.z.string(),
|
|
@@ -4557,6 +4599,7 @@ var workspace = zod.z.object({
|
|
|
4557
4599
|
---
|
|
4558
4600
|
route_path: /workspaces
|
|
4559
4601
|
---
|
|
4602
|
+
Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).
|
|
4560
4603
|
`);
|
|
4561
4604
|
|
|
4562
4605
|
// src/lib/seam/connect/openapi.ts
|
|
@@ -4564,7 +4607,7 @@ var openapi_default = {
|
|
|
4564
4607
|
components: {
|
|
4565
4608
|
schemas: {
|
|
4566
4609
|
access_code: {
|
|
4567
|
-
description: "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound
|
|
4610
|
+
description: "Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection\u2014and you do not need to be near the locks\u2014to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.",
|
|
4568
4611
|
properties: {
|
|
4569
4612
|
access_code_id: {
|
|
4570
4613
|
description: "Unique identifier for the access code.",
|
|
@@ -5604,7 +5647,7 @@ var openapi_default = {
|
|
|
5604
5647
|
type: "boolean"
|
|
5605
5648
|
},
|
|
5606
5649
|
name: {
|
|
5607
|
-
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
|
|
5650
|
+
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
5608
5651
|
nullable: true,
|
|
5609
5652
|
type: "string"
|
|
5610
5653
|
},
|
|
@@ -10965,6 +11008,7 @@ var openapi_default = {
|
|
|
10965
11008
|
"x-route-path": "/action_attempts"
|
|
10966
11009
|
},
|
|
10967
11010
|
client_session: {
|
|
11011
|
+
description: "Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).",
|
|
10968
11012
|
properties: {
|
|
10969
11013
|
client_session_id: { format: "uuid", type: "string" },
|
|
10970
11014
|
connect_webview_ids: {
|
|
@@ -11002,18 +11046,21 @@ var openapi_default = {
|
|
|
11002
11046
|
"x-route-path": "/client_sessions"
|
|
11003
11047
|
},
|
|
11004
11048
|
connect_webview: {
|
|
11049
|
+
description: "Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and\u2014once your user has completed the authorization through your app\u2014you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.",
|
|
11005
11050
|
properties: {
|
|
11006
11051
|
accepted_devices: {
|
|
11007
11052
|
deprecated: true,
|
|
11008
11053
|
items: { type: "string" },
|
|
11009
11054
|
type: "array",
|
|
11010
|
-
"x-deprecated": "Unused. Will be removed."
|
|
11055
|
+
"x-deprecated": "Unused. Will be removed.",
|
|
11056
|
+
"x-undocumented": "Unused. Will be removed."
|
|
11011
11057
|
},
|
|
11012
11058
|
accepted_providers: { items: { type: "string" }, type: "array" },
|
|
11013
11059
|
any_device_allowed: {
|
|
11014
11060
|
deprecated: true,
|
|
11015
11061
|
type: "boolean",
|
|
11016
|
-
"x-deprecated": "Unused. Will be removed."
|
|
11062
|
+
"x-deprecated": "Unused. Will be removed.",
|
|
11063
|
+
"x-undocumented": "Unused. Will be removed."
|
|
11017
11064
|
},
|
|
11018
11065
|
any_provider_allowed: { type: "boolean" },
|
|
11019
11066
|
authorized_at: {
|
|
@@ -11081,6 +11128,7 @@ var openapi_default = {
|
|
|
11081
11128
|
"x-route-path": "/connect_webviews"
|
|
11082
11129
|
},
|
|
11083
11130
|
connected_account: {
|
|
11131
|
+
description: "Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.",
|
|
11084
11132
|
properties: {
|
|
11085
11133
|
account_type: { type: "string" },
|
|
11086
11134
|
account_type_display_name: { type: "string" },
|
|
@@ -11336,6 +11384,7 @@ var openapi_default = {
|
|
|
11336
11384
|
"x-route-path": "/connected_accounts"
|
|
11337
11385
|
},
|
|
11338
11386
|
device: {
|
|
11387
|
+
description: "Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.",
|
|
11339
11388
|
properties: {
|
|
11340
11389
|
can_hvac_cool: { type: "boolean" },
|
|
11341
11390
|
can_hvac_heat: { type: "boolean" },
|
|
@@ -11873,7 +11922,7 @@ var openapi_default = {
|
|
|
11873
11922
|
type: "string"
|
|
11874
11923
|
},
|
|
11875
11924
|
manufacturer: {
|
|
11876
|
-
description: "Manufacturer of the device.",
|
|
11925
|
+
description: "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.",
|
|
11877
11926
|
type: "string"
|
|
11878
11927
|
},
|
|
11879
11928
|
model: {
|
|
@@ -12549,6 +12598,7 @@ var openapi_default = {
|
|
|
12549
12598
|
type: "array"
|
|
12550
12599
|
},
|
|
12551
12600
|
code_constraints: {
|
|
12601
|
+
description: "Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.",
|
|
12552
12602
|
items: {
|
|
12553
12603
|
oneOf: [
|
|
12554
12604
|
{
|
|
@@ -13564,6 +13614,7 @@ var openapi_default = {
|
|
|
13564
13614
|
"x-route-path": "/user_identities/enrollment_automations"
|
|
13565
13615
|
},
|
|
13566
13616
|
event: {
|
|
13617
|
+
description: "Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.",
|
|
13567
13618
|
discriminator: { propertyName: "event_type" },
|
|
13568
13619
|
oneOf: [
|
|
13569
13620
|
{
|
|
@@ -18488,7 +18539,7 @@ var openapi_default = {
|
|
|
18488
18539
|
"x-route-path": "/thermostats/schedules"
|
|
18489
18540
|
},
|
|
18490
18541
|
unmanaged_access_code: {
|
|
18491
|
-
description: "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.",
|
|
18542
|
+
description: "Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.\n\nNot all providers support unmanaged access codes. The following providers do not support unmanaged access codes:\n\n- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)",
|
|
18492
18543
|
properties: {
|
|
18493
18544
|
access_code_id: {
|
|
18494
18545
|
description: "Unique identifier for the access code.",
|
|
@@ -19495,7 +19546,7 @@ var openapi_default = {
|
|
|
19495
19546
|
type: "boolean"
|
|
19496
19547
|
},
|
|
19497
19548
|
name: {
|
|
19498
|
-
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.",
|
|
19549
|
+
description: "Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
19499
19550
|
nullable: true,
|
|
19500
19551
|
type: "string"
|
|
19501
19552
|
},
|
|
@@ -20792,6 +20843,7 @@ var openapi_default = {
|
|
|
20792
20843
|
"x-route-path": "/acs/users/unmanaged"
|
|
20793
20844
|
},
|
|
20794
20845
|
unmanaged_device: {
|
|
20846
|
+
description: "Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
|
|
20795
20847
|
properties: {
|
|
20796
20848
|
can_hvac_cool: { type: "boolean" },
|
|
20797
20849
|
can_hvac_heat: { type: "boolean" },
|
|
@@ -21286,7 +21338,7 @@ var openapi_default = {
|
|
|
21286
21338
|
type: "string"
|
|
21287
21339
|
},
|
|
21288
21340
|
manufacturer: {
|
|
21289
|
-
description: "Manufacturer of the device.",
|
|
21341
|
+
description: "Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.",
|
|
21290
21342
|
type: "string"
|
|
21291
21343
|
},
|
|
21292
21344
|
model: {
|
|
@@ -21616,7 +21668,7 @@ var openapi_default = {
|
|
|
21616
21668
|
"x-route-path": "/devices/unmanaged"
|
|
21617
21669
|
},
|
|
21618
21670
|
user_identity: {
|
|
21619
|
-
description: "Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
21671
|
+
description: "Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.",
|
|
21620
21672
|
properties: {
|
|
21621
21673
|
created_at: {
|
|
21622
21674
|
description: "Date and time at which the user identity was created.",
|
|
@@ -21678,6 +21730,7 @@ var openapi_default = {
|
|
|
21678
21730
|
"x-route-path": "/webhooks"
|
|
21679
21731
|
},
|
|
21680
21732
|
workspace: {
|
|
21733
|
+
description: "Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).",
|
|
21681
21734
|
properties: {
|
|
21682
21735
|
company_name: { type: "string" },
|
|
21683
21736
|
connect_partner_name: {
|
|
@@ -21809,7 +21862,7 @@ var openapi_default = {
|
|
|
21809
21862
|
type: "string"
|
|
21810
21863
|
},
|
|
21811
21864
|
device_id: {
|
|
21812
|
-
description: "ID of the device for which to create the new access code.",
|
|
21865
|
+
description: "ID of the device for which you want to create the new access code.",
|
|
21813
21866
|
format: "uuid",
|
|
21814
21867
|
type: "string"
|
|
21815
21868
|
},
|
|
@@ -21836,7 +21889,7 @@ var openapi_default = {
|
|
|
21836
21889
|
type: "string"
|
|
21837
21890
|
},
|
|
21838
21891
|
name: {
|
|
21839
|
-
description: "Name of the new access code.",
|
|
21892
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21840
21893
|
type: "string"
|
|
21841
21894
|
},
|
|
21842
21895
|
prefer_native_scheduling: {
|
|
@@ -21938,7 +21991,7 @@ var openapi_default = {
|
|
|
21938
21991
|
type: "string"
|
|
21939
21992
|
},
|
|
21940
21993
|
device_ids: {
|
|
21941
|
-
description: "IDs of the devices for which to create the new access codes.",
|
|
21994
|
+
description: "IDs of the devices for which you want to create the new access codes.",
|
|
21942
21995
|
items: { format: "uuid", type: "string" },
|
|
21943
21996
|
type: "array"
|
|
21944
21997
|
},
|
|
@@ -21965,7 +22018,7 @@ var openapi_default = {
|
|
|
21965
22018
|
type: "string"
|
|
21966
22019
|
},
|
|
21967
22020
|
name: {
|
|
21968
|
-
description: "Name of the new access code.",
|
|
22021
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
21969
22022
|
type: "string"
|
|
21970
22023
|
},
|
|
21971
22024
|
prefer_native_scheduling: {
|
|
@@ -22059,7 +22112,7 @@ var openapi_default = {
|
|
|
22059
22112
|
type: "string"
|
|
22060
22113
|
},
|
|
22061
22114
|
device_ids: {
|
|
22062
|
-
description: "IDs of the devices for which to create the new access codes.",
|
|
22115
|
+
description: "IDs of the devices for which you want to create the new access codes.",
|
|
22063
22116
|
items: { format: "uuid", type: "string" },
|
|
22064
22117
|
type: "array"
|
|
22065
22118
|
},
|
|
@@ -22086,7 +22139,7 @@ var openapi_default = {
|
|
|
22086
22139
|
type: "string"
|
|
22087
22140
|
},
|
|
22088
22141
|
name: {
|
|
22089
|
-
description: "Name of the new access code.",
|
|
22142
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
22090
22143
|
type: "string"
|
|
22091
22144
|
},
|
|
22092
22145
|
prefer_native_scheduling: {
|
|
@@ -22159,12 +22212,12 @@ var openapi_default = {
|
|
|
22159
22212
|
schema: {
|
|
22160
22213
|
properties: {
|
|
22161
22214
|
access_code_id: {
|
|
22162
|
-
description: "ID of the access code to delete.",
|
|
22215
|
+
description: "ID of the access code that you want to delete.",
|
|
22163
22216
|
format: "uuid",
|
|
22164
22217
|
type: "string"
|
|
22165
22218
|
},
|
|
22166
22219
|
device_id: {
|
|
22167
|
-
description: "ID of the device for which to delete the access code.",
|
|
22220
|
+
description: "ID of the device for which you want to delete the access code.",
|
|
22168
22221
|
format: "uuid",
|
|
22169
22222
|
type: "string"
|
|
22170
22223
|
},
|
|
@@ -22218,12 +22271,19 @@ var openapi_default = {
|
|
|
22218
22271
|
},
|
|
22219
22272
|
"/access_codes/generate_code": {
|
|
22220
22273
|
post: {
|
|
22274
|
+
description: "Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.",
|
|
22221
22275
|
operationId: "accessCodesGenerateCodePost",
|
|
22222
22276
|
requestBody: {
|
|
22223
22277
|
content: {
|
|
22224
22278
|
"application/json": {
|
|
22225
22279
|
schema: {
|
|
22226
|
-
properties: {
|
|
22280
|
+
properties: {
|
|
22281
|
+
device_id: {
|
|
22282
|
+
description: "ID of the device for which you want to generate a code.",
|
|
22283
|
+
format: "uuid",
|
|
22284
|
+
type: "string"
|
|
22285
|
+
}
|
|
22286
|
+
},
|
|
22227
22287
|
required: ["device_id"],
|
|
22228
22288
|
type: "object"
|
|
22229
22289
|
}
|
|
@@ -22262,7 +22322,8 @@ var openapi_default = {
|
|
|
22262
22322
|
"x-fern-sdk-group-name": ["access_codes"],
|
|
22263
22323
|
"x-fern-sdk-method-name": "generate_code",
|
|
22264
22324
|
"x-fern-sdk-return-value": "generated_code",
|
|
22265
|
-
"x-response-key": "generated_code"
|
|
22325
|
+
"x-response-key": "generated_code",
|
|
22326
|
+
"x-title": "Generate a Code"
|
|
22266
22327
|
}
|
|
22267
22328
|
},
|
|
22268
22329
|
"/access_codes/get": {
|
|
@@ -22408,7 +22469,7 @@ var openapi_default = {
|
|
|
22408
22469
|
},
|
|
22409
22470
|
"/access_codes/pull_backup_access_code": {
|
|
22410
22471
|
post: {
|
|
22411
|
-
description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes
|
|
22472
|
+
description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code\u2014be it due to intermittent connectivity, manual removal from a device, or provider outages\u2014a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
|
|
22412
22473
|
operationId: "accessCodesPullBackupAccessCodePost",
|
|
22413
22474
|
requestBody: {
|
|
22414
22475
|
content: {
|
|
@@ -22466,7 +22527,7 @@ var openapi_default = {
|
|
|
22466
22527
|
},
|
|
22467
22528
|
"/access_codes/report_device_constraints": {
|
|
22468
22529
|
post: {
|
|
22469
|
-
description: "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices
|
|
22530
|
+
description: "Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.",
|
|
22470
22531
|
operationId: "accessCodesReportDeviceConstraintsPost",
|
|
22471
22532
|
requestBody: {
|
|
22472
22533
|
content: {
|
|
@@ -22474,7 +22535,7 @@ var openapi_default = {
|
|
|
22474
22535
|
schema: {
|
|
22475
22536
|
properties: {
|
|
22476
22537
|
device_id: {
|
|
22477
|
-
description: "ID of the device for which to report constraints.",
|
|
22538
|
+
description: "ID of the device for which you want to report constraints.",
|
|
22478
22539
|
format: "uuid",
|
|
22479
22540
|
type: "string"
|
|
22480
22541
|
},
|
|
@@ -22616,7 +22677,7 @@ var openapi_default = {
|
|
|
22616
22677
|
type: "string"
|
|
22617
22678
|
},
|
|
22618
22679
|
allow_external_modification: {
|
|
22619
|
-
description: "Indicates whether external modification of the access code is allowed.",
|
|
22680
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
|
|
22620
22681
|
type: "boolean"
|
|
22621
22682
|
},
|
|
22622
22683
|
force: {
|
|
@@ -22624,7 +22685,7 @@ var openapi_default = {
|
|
|
22624
22685
|
type: "boolean"
|
|
22625
22686
|
},
|
|
22626
22687
|
is_external_modification_allowed: {
|
|
22627
|
-
description: "Indicates whether external modification of the access code is allowed.",
|
|
22688
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
|
|
22628
22689
|
type: "boolean"
|
|
22629
22690
|
},
|
|
22630
22691
|
sync: {
|
|
@@ -22682,7 +22743,7 @@ var openapi_default = {
|
|
|
22682
22743
|
type: "string"
|
|
22683
22744
|
},
|
|
22684
22745
|
allow_external_modification: {
|
|
22685
|
-
description: "Indicates whether external modification of the access code is allowed.",
|
|
22746
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
|
|
22686
22747
|
type: "boolean"
|
|
22687
22748
|
},
|
|
22688
22749
|
force: {
|
|
@@ -22690,7 +22751,7 @@ var openapi_default = {
|
|
|
22690
22751
|
type: "boolean"
|
|
22691
22752
|
},
|
|
22692
22753
|
is_external_modification_allowed: {
|
|
22693
|
-
description: "Indicates whether external modification of the access code is allowed.",
|
|
22754
|
+
description: "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.",
|
|
22694
22755
|
type: "boolean"
|
|
22695
22756
|
},
|
|
22696
22757
|
sync: {
|
|
@@ -22746,7 +22807,7 @@ var openapi_default = {
|
|
|
22746
22807
|
schema: {
|
|
22747
22808
|
properties: {
|
|
22748
22809
|
access_code_id: {
|
|
22749
|
-
description: "ID of the unmanaged access code to delete.",
|
|
22810
|
+
description: "ID of the unmanaged access code that you want to delete.",
|
|
22750
22811
|
format: "uuid",
|
|
22751
22812
|
type: "string"
|
|
22752
22813
|
},
|
|
@@ -23113,7 +23174,7 @@ var openapi_default = {
|
|
|
23113
23174
|
type: "string"
|
|
23114
23175
|
},
|
|
23115
23176
|
name: {
|
|
23116
|
-
description: "Name of the new access code.",
|
|
23177
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23117
23178
|
type: "string"
|
|
23118
23179
|
},
|
|
23119
23180
|
prefer_native_scheduling: {
|
|
@@ -23245,7 +23306,7 @@ var openapi_default = {
|
|
|
23245
23306
|
type: "string"
|
|
23246
23307
|
},
|
|
23247
23308
|
name: {
|
|
23248
|
-
description: "Name of the new access code.",
|
|
23309
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23249
23310
|
type: "string"
|
|
23250
23311
|
},
|
|
23251
23312
|
prefer_native_scheduling: {
|
|
@@ -23378,7 +23439,7 @@ var openapi_default = {
|
|
|
23378
23439
|
type: "string"
|
|
23379
23440
|
},
|
|
23380
23441
|
name: {
|
|
23381
|
-
description: "Name of the new access code.",
|
|
23442
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23382
23443
|
type: "string"
|
|
23383
23444
|
},
|
|
23384
23445
|
prefer_native_scheduling: {
|
|
@@ -23469,7 +23530,7 @@ var openapi_default = {
|
|
|
23469
23530
|
type: "string"
|
|
23470
23531
|
},
|
|
23471
23532
|
name: {
|
|
23472
|
-
description: "Name of the new access code.",
|
|
23533
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23473
23534
|
type: "string"
|
|
23474
23535
|
},
|
|
23475
23536
|
starts_at: {
|
|
@@ -23528,7 +23589,7 @@ var openapi_default = {
|
|
|
23528
23589
|
type: "string"
|
|
23529
23590
|
},
|
|
23530
23591
|
name: {
|
|
23531
|
-
description: "Name of the new access code.",
|
|
23592
|
+
description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
23532
23593
|
type: "string"
|
|
23533
23594
|
},
|
|
23534
23595
|
starts_at: {
|
|
@@ -23574,7 +23635,7 @@ var openapi_default = {
|
|
|
23574
23635
|
},
|
|
23575
23636
|
"/acs/access_groups/add_user": {
|
|
23576
23637
|
post: {
|
|
23577
|
-
description: "Adds a specified [
|
|
23638
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
23578
23639
|
operationId: "acsAccessGroupsAddUserPost",
|
|
23579
23640
|
requestBody: {
|
|
23580
23641
|
content: {
|
|
@@ -23582,17 +23643,22 @@ var openapi_default = {
|
|
|
23582
23643
|
schema: {
|
|
23583
23644
|
properties: {
|
|
23584
23645
|
acs_access_group_id: {
|
|
23585
|
-
description: "ID of the
|
|
23646
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
23586
23647
|
format: "uuid",
|
|
23587
23648
|
type: "string"
|
|
23588
23649
|
},
|
|
23589
23650
|
acs_user_id: {
|
|
23590
|
-
description: "ID of the
|
|
23651
|
+
description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
|
|
23652
|
+
format: "uuid",
|
|
23653
|
+
type: "string"
|
|
23654
|
+
},
|
|
23655
|
+
user_identity_id: {
|
|
23656
|
+
description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
23591
23657
|
format: "uuid",
|
|
23592
23658
|
type: "string"
|
|
23593
23659
|
}
|
|
23594
23660
|
},
|
|
23595
|
-
required: ["acs_access_group_id"
|
|
23661
|
+
required: ["acs_access_group_id"],
|
|
23596
23662
|
type: "object"
|
|
23597
23663
|
}
|
|
23598
23664
|
}
|
|
@@ -23627,7 +23693,7 @@ var openapi_default = {
|
|
|
23627
23693
|
"x-title": "Add an ACS User to an Access Group"
|
|
23628
23694
|
},
|
|
23629
23695
|
put: {
|
|
23630
|
-
description: "Adds a specified [
|
|
23696
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
23631
23697
|
operationId: "acsAccessGroupsAddUserPut",
|
|
23632
23698
|
requestBody: {
|
|
23633
23699
|
content: {
|
|
@@ -23635,17 +23701,22 @@ var openapi_default = {
|
|
|
23635
23701
|
schema: {
|
|
23636
23702
|
properties: {
|
|
23637
23703
|
acs_access_group_id: {
|
|
23638
|
-
description: "ID of the
|
|
23704
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
23639
23705
|
format: "uuid",
|
|
23640
23706
|
type: "string"
|
|
23641
23707
|
},
|
|
23642
23708
|
acs_user_id: {
|
|
23643
|
-
description: "ID of the
|
|
23709
|
+
description: "ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.",
|
|
23710
|
+
format: "uuid",
|
|
23711
|
+
type: "string"
|
|
23712
|
+
},
|
|
23713
|
+
user_identity_id: {
|
|
23714
|
+
description: "ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
|
|
23644
23715
|
format: "uuid",
|
|
23645
23716
|
type: "string"
|
|
23646
23717
|
}
|
|
23647
23718
|
},
|
|
23648
|
-
required: ["acs_access_group_id"
|
|
23719
|
+
required: ["acs_access_group_id"],
|
|
23649
23720
|
type: "object"
|
|
23650
23721
|
}
|
|
23651
23722
|
}
|
|
@@ -23689,7 +23760,7 @@ var openapi_default = {
|
|
|
23689
23760
|
schema: {
|
|
23690
23761
|
properties: {
|
|
23691
23762
|
acs_access_group_id: {
|
|
23692
|
-
description: "ID of the
|
|
23763
|
+
description: "ID of the access group that you want to get.",
|
|
23693
23764
|
format: "uuid",
|
|
23694
23765
|
type: "string"
|
|
23695
23766
|
}
|
|
@@ -23745,12 +23816,12 @@ var openapi_default = {
|
|
|
23745
23816
|
schema: {
|
|
23746
23817
|
properties: {
|
|
23747
23818
|
acs_system_id: {
|
|
23748
|
-
description: "ID of the access
|
|
23819
|
+
description: "ID of the access system for which you want to retrieve all access groups.",
|
|
23749
23820
|
format: "uuid",
|
|
23750
23821
|
type: "string"
|
|
23751
23822
|
},
|
|
23752
23823
|
acs_user_id: {
|
|
23753
|
-
description: "ID of the user for which you want to retrieve all access groups.",
|
|
23824
|
+
description: "ID of the access system user for which you want to retrieve all access groups.",
|
|
23754
23825
|
format: "uuid",
|
|
23755
23826
|
type: "string"
|
|
23756
23827
|
},
|
|
@@ -23860,7 +23931,7 @@ var openapi_default = {
|
|
|
23860
23931
|
},
|
|
23861
23932
|
"/acs/access_groups/list_users": {
|
|
23862
23933
|
post: {
|
|
23863
|
-
description: "Returns a list of all [
|
|
23934
|
+
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
23864
23935
|
operationId: "acsAccessGroupsListUsersPost",
|
|
23865
23936
|
requestBody: {
|
|
23866
23937
|
content: {
|
|
@@ -23868,7 +23939,7 @@ var openapi_default = {
|
|
|
23868
23939
|
schema: {
|
|
23869
23940
|
properties: {
|
|
23870
23941
|
acs_access_group_id: {
|
|
23871
|
-
description: "ID of the access group for which you want to retrieve all users.",
|
|
23942
|
+
description: "ID of the access group for which you want to retrieve all access system users.",
|
|
23872
23943
|
format: "uuid",
|
|
23873
23944
|
type: "string"
|
|
23874
23945
|
}
|
|
@@ -23917,7 +23988,7 @@ var openapi_default = {
|
|
|
23917
23988
|
},
|
|
23918
23989
|
"/acs/access_groups/remove_user": {
|
|
23919
23990
|
post: {
|
|
23920
|
-
description: "Removes a specified [
|
|
23991
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
23921
23992
|
operationId: "acsAccessGroupsRemoveUserPost",
|
|
23922
23993
|
requestBody: {
|
|
23923
23994
|
content: {
|
|
@@ -23925,17 +23996,17 @@ var openapi_default = {
|
|
|
23925
23996
|
schema: {
|
|
23926
23997
|
properties: {
|
|
23927
23998
|
acs_access_group_id: {
|
|
23928
|
-
description: "ID of the
|
|
23999
|
+
description: "ID of the access group from which you want to remove an access system user.",
|
|
23929
24000
|
format: "uuid",
|
|
23930
24001
|
type: "string"
|
|
23931
24002
|
},
|
|
23932
24003
|
acs_user_id: {
|
|
23933
|
-
description: "ID of the
|
|
24004
|
+
description: "ID of the access system user that you want to remove from an access group.",
|
|
23934
24005
|
format: "uuid",
|
|
23935
24006
|
type: "string"
|
|
23936
24007
|
},
|
|
23937
24008
|
user_identity_id: {
|
|
23938
|
-
description: "ID of the
|
|
24009
|
+
description: "ID of the user identity associated with the user that you want to remove from an access group.",
|
|
23939
24010
|
format: "uuid",
|
|
23940
24011
|
type: "string"
|
|
23941
24012
|
}
|
|
@@ -23985,7 +24056,7 @@ var openapi_default = {
|
|
|
23985
24056
|
schema: {
|
|
23986
24057
|
properties: {
|
|
23987
24058
|
acs_access_group_id: {
|
|
23988
|
-
description: "ID of the
|
|
24059
|
+
description: "ID of the unmanaged access group that you want to get.",
|
|
23989
24060
|
format: "uuid",
|
|
23990
24061
|
type: "string"
|
|
23991
24062
|
}
|
|
@@ -24028,6 +24099,7 @@ var openapi_default = {
|
|
|
24028
24099
|
"x-fern-sdk-method-name": "get",
|
|
24029
24100
|
"x-fern-sdk-return-value": "acs_access_group",
|
|
24030
24101
|
"x-response-key": "acs_access_group",
|
|
24102
|
+
"x-title": "Get an Unmanaged Access Group",
|
|
24031
24103
|
"x-undocumented": "No unmanaged access groups are currently implemented."
|
|
24032
24104
|
}
|
|
24033
24105
|
},
|
|
@@ -24041,12 +24113,12 @@ var openapi_default = {
|
|
|
24041
24113
|
schema: {
|
|
24042
24114
|
properties: {
|
|
24043
24115
|
acs_system_id: {
|
|
24044
|
-
description: "ID of the access
|
|
24116
|
+
description: "ID of the access system for which you want to retrieve all unmanaged access groups.",
|
|
24045
24117
|
format: "uuid",
|
|
24046
24118
|
type: "string"
|
|
24047
24119
|
},
|
|
24048
24120
|
acs_user_id: {
|
|
24049
|
-
description: "ID of the user for which you want to retrieve all unmanaged access groups.",
|
|
24121
|
+
description: "ID of the access system user for which you want to retrieve all unmanaged access groups.",
|
|
24050
24122
|
format: "uuid",
|
|
24051
24123
|
type: "string"
|
|
24052
24124
|
}
|
|
@@ -24091,18 +24163,24 @@ var openapi_default = {
|
|
|
24091
24163
|
"x-fern-sdk-method-name": "list",
|
|
24092
24164
|
"x-fern-sdk-return-value": "acs_access_groups",
|
|
24093
24165
|
"x-response-key": "acs_access_groups",
|
|
24166
|
+
"x-title": "List Unmanaged Access Groups",
|
|
24094
24167
|
"x-undocumented": "No unmanaged access groups are currently implemented."
|
|
24095
24168
|
}
|
|
24096
24169
|
},
|
|
24097
24170
|
"/acs/credential_pools/list": {
|
|
24098
24171
|
post: {
|
|
24172
|
+
description: "Returns a list of all credential pools.",
|
|
24099
24173
|
operationId: "acsCredentialPoolsListPost",
|
|
24100
24174
|
requestBody: {
|
|
24101
24175
|
content: {
|
|
24102
24176
|
"application/json": {
|
|
24103
24177
|
schema: {
|
|
24104
24178
|
properties: {
|
|
24105
|
-
acs_system_id: {
|
|
24179
|
+
acs_system_id: {
|
|
24180
|
+
description: "ID of the access system for which you want to list credential pools.",
|
|
24181
|
+
format: "uuid",
|
|
24182
|
+
type: "string"
|
|
24183
|
+
}
|
|
24106
24184
|
},
|
|
24107
24185
|
required: ["acs_system_id"],
|
|
24108
24186
|
type: "object"
|
|
@@ -24146,28 +24224,43 @@ var openapi_default = {
|
|
|
24146
24224
|
"x-fern-sdk-method-name": "list",
|
|
24147
24225
|
"x-fern-sdk-return-value": "acs_credential_pools",
|
|
24148
24226
|
"x-response-key": "acs_credential_pools",
|
|
24227
|
+
"x-title": "List Credential Pools",
|
|
24149
24228
|
"x-undocumented": "Replaced by enrollment automations."
|
|
24150
24229
|
}
|
|
24151
24230
|
},
|
|
24152
24231
|
"/acs/credential_provisioning_automations/launch": {
|
|
24153
24232
|
post: {
|
|
24233
|
+
description: "Launches a credential provisioning automation.",
|
|
24154
24234
|
operationId: "acsCredentialProvisioningAutomationsLaunchPost",
|
|
24155
24235
|
requestBody: {
|
|
24156
24236
|
content: {
|
|
24157
24237
|
"application/json": {
|
|
24158
24238
|
schema: {
|
|
24159
24239
|
properties: {
|
|
24160
|
-
acs_credential_pool_id: {
|
|
24161
|
-
|
|
24240
|
+
acs_credential_pool_id: {
|
|
24241
|
+
description: "ID of the credential pool for which you want to launch a credential provisioning automation.",
|
|
24242
|
+
format: "uuid",
|
|
24243
|
+
type: "string"
|
|
24244
|
+
},
|
|
24245
|
+
create_credential_manager_user: {
|
|
24246
|
+
description: "Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.",
|
|
24247
|
+
type: "boolean"
|
|
24248
|
+
},
|
|
24162
24249
|
credential_manager_acs_system_id: {
|
|
24250
|
+
description: "Access system ID of the credential manager for which you want to launch a credential provisioning automation.",
|
|
24163
24251
|
format: "uuid",
|
|
24164
24252
|
type: "string"
|
|
24165
24253
|
},
|
|
24166
24254
|
credential_manager_acs_user_id: {
|
|
24255
|
+
description: "ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.",
|
|
24167
24256
|
format: "uuid",
|
|
24168
24257
|
type: "string"
|
|
24169
24258
|
},
|
|
24170
|
-
user_identity_id: {
|
|
24259
|
+
user_identity_id: {
|
|
24260
|
+
description: "ID of the user identity for which you want to launch a credential provisioning automation.",
|
|
24261
|
+
format: "uuid",
|
|
24262
|
+
type: "string"
|
|
24263
|
+
}
|
|
24171
24264
|
},
|
|
24172
24265
|
required: [
|
|
24173
24266
|
"user_identity_id",
|
|
@@ -24211,12 +24304,13 @@ var openapi_default = {
|
|
|
24211
24304
|
"x-fern-sdk-method-name": "launch",
|
|
24212
24305
|
"x-fern-sdk-return-value": "acs_credential_provisioning_automation",
|
|
24213
24306
|
"x-response-key": "acs_credential_provisioning_automation",
|
|
24307
|
+
"x-title": "Launch a Credential Provisioning Automation",
|
|
24214
24308
|
"x-undocumented": "Replaced by enrollment automations."
|
|
24215
24309
|
}
|
|
24216
24310
|
},
|
|
24217
24311
|
"/acs/credentials/assign": {
|
|
24218
24312
|
patch: {
|
|
24219
|
-
description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [
|
|
24313
|
+
description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
24220
24314
|
operationId: "acsCredentialsAssignPatch",
|
|
24221
24315
|
requestBody: {
|
|
24222
24316
|
content: {
|
|
@@ -24224,12 +24318,12 @@ var openapi_default = {
|
|
|
24224
24318
|
schema: {
|
|
24225
24319
|
properties: {
|
|
24226
24320
|
acs_credential_id: {
|
|
24227
|
-
description: "ID of the
|
|
24321
|
+
description: "ID of the credential that you want to assign to an access system user.",
|
|
24228
24322
|
format: "uuid",
|
|
24229
24323
|
type: "string"
|
|
24230
24324
|
},
|
|
24231
24325
|
acs_user_id: {
|
|
24232
|
-
description: "ID of the
|
|
24326
|
+
description: "ID of the access system user to whom you want to assign a credential.",
|
|
24233
24327
|
format: "uuid",
|
|
24234
24328
|
type: "string"
|
|
24235
24329
|
}
|
|
@@ -24273,7 +24367,7 @@ var openapi_default = {
|
|
|
24273
24367
|
"x-title": "Assign a Credential to an ACS User"
|
|
24274
24368
|
},
|
|
24275
24369
|
post: {
|
|
24276
|
-
description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [
|
|
24370
|
+
description: "Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
24277
24371
|
operationId: "acsCredentialsAssignPost",
|
|
24278
24372
|
requestBody: {
|
|
24279
24373
|
content: {
|
|
@@ -24281,12 +24375,12 @@ var openapi_default = {
|
|
|
24281
24375
|
schema: {
|
|
24282
24376
|
properties: {
|
|
24283
24377
|
acs_credential_id: {
|
|
24284
|
-
description: "ID of the
|
|
24378
|
+
description: "ID of the credential that you want to assign to an access system user.",
|
|
24285
24379
|
format: "uuid",
|
|
24286
24380
|
type: "string"
|
|
24287
24381
|
},
|
|
24288
24382
|
acs_user_id: {
|
|
24289
|
-
description: "ID of the
|
|
24383
|
+
description: "ID of the access system user to whom you want to assign a credential.",
|
|
24290
24384
|
format: "uuid",
|
|
24291
24385
|
type: "string"
|
|
24292
24386
|
}
|
|
@@ -24346,12 +24440,12 @@ var openapi_default = {
|
|
|
24346
24440
|
type: "string"
|
|
24347
24441
|
},
|
|
24348
24442
|
acs_system_id: {
|
|
24349
|
-
description: "ID of the
|
|
24443
|
+
description: "ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.",
|
|
24350
24444
|
format: "uuid",
|
|
24351
24445
|
type: "string"
|
|
24352
24446
|
},
|
|
24353
24447
|
acs_user_id: {
|
|
24354
|
-
description: "ID of the
|
|
24448
|
+
description: "ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.",
|
|
24355
24449
|
format: "uuid",
|
|
24356
24450
|
type: "string"
|
|
24357
24451
|
},
|
|
@@ -24397,8 +24491,14 @@ var openapi_default = {
|
|
|
24397
24491
|
salto_space_metadata: {
|
|
24398
24492
|
description: "Salto Space-specific metadata for the new credential.",
|
|
24399
24493
|
properties: {
|
|
24400
|
-
assign_new_key: {
|
|
24401
|
-
|
|
24494
|
+
assign_new_key: {
|
|
24495
|
+
description: "Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).",
|
|
24496
|
+
type: "boolean"
|
|
24497
|
+
},
|
|
24498
|
+
update_current_key: {
|
|
24499
|
+
description: "Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).",
|
|
24500
|
+
type: "boolean"
|
|
24501
|
+
}
|
|
24402
24502
|
},
|
|
24403
24503
|
type: "object"
|
|
24404
24504
|
},
|
|
@@ -24408,7 +24508,7 @@ var openapi_default = {
|
|
|
24408
24508
|
type: "string"
|
|
24409
24509
|
},
|
|
24410
24510
|
user_identity_id: {
|
|
24411
|
-
description: "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the
|
|
24511
|
+
description: "ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.",
|
|
24412
24512
|
format: "uuid",
|
|
24413
24513
|
type: "string"
|
|
24414
24514
|
},
|
|
@@ -24490,7 +24590,7 @@ var openapi_default = {
|
|
|
24490
24590
|
},
|
|
24491
24591
|
"/acs/credentials/create_offline_code": {
|
|
24492
24592
|
post: {
|
|
24493
|
-
description: "Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [
|
|
24593
|
+
description: "Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
24494
24594
|
operationId: "acsCredentialsCreateOfflineCodePost",
|
|
24495
24595
|
requestBody: {
|
|
24496
24596
|
content: {
|
|
@@ -24498,7 +24598,7 @@ var openapi_default = {
|
|
|
24498
24598
|
schema: {
|
|
24499
24599
|
properties: {
|
|
24500
24600
|
acs_user_id: {
|
|
24501
|
-
description: "ID of the
|
|
24601
|
+
description: "ID of the access system user to whom the new credential belongs.",
|
|
24502
24602
|
format: "uuid",
|
|
24503
24603
|
type: "string"
|
|
24504
24604
|
},
|
|
@@ -24575,7 +24675,7 @@ var openapi_default = {
|
|
|
24575
24675
|
schema: {
|
|
24576
24676
|
properties: {
|
|
24577
24677
|
acs_credential_id: {
|
|
24578
|
-
description: "ID of the
|
|
24678
|
+
description: "ID of the credential that you want to delete.",
|
|
24579
24679
|
format: "uuid",
|
|
24580
24680
|
type: "string"
|
|
24581
24681
|
}
|
|
@@ -24625,7 +24725,7 @@ var openapi_default = {
|
|
|
24625
24725
|
schema: {
|
|
24626
24726
|
properties: {
|
|
24627
24727
|
acs_credential_id: {
|
|
24628
|
-
description: "ID of the
|
|
24728
|
+
description: "ID of the credential that you want to get.",
|
|
24629
24729
|
format: "uuid",
|
|
24630
24730
|
type: "string"
|
|
24631
24731
|
}
|
|
@@ -24685,7 +24785,7 @@ var openapi_default = {
|
|
|
24685
24785
|
{
|
|
24686
24786
|
properties: {
|
|
24687
24787
|
acs_user_id: {
|
|
24688
|
-
description: "ID of the
|
|
24788
|
+
description: "ID of the access system user for which you want to retrieve all credentials.",
|
|
24689
24789
|
format: "uuid",
|
|
24690
24790
|
type: "string"
|
|
24691
24791
|
}
|
|
@@ -24696,7 +24796,7 @@ var openapi_default = {
|
|
|
24696
24796
|
{
|
|
24697
24797
|
properties: {
|
|
24698
24798
|
acs_system_id: {
|
|
24699
|
-
description: "ID of the access
|
|
24799
|
+
description: "ID of the access system for which you want to retrieve all credentials.",
|
|
24700
24800
|
format: "uuid",
|
|
24701
24801
|
type: "string"
|
|
24702
24802
|
}
|
|
@@ -24707,12 +24807,12 @@ var openapi_default = {
|
|
|
24707
24807
|
{
|
|
24708
24808
|
properties: {
|
|
24709
24809
|
acs_system_id: {
|
|
24710
|
-
description: "ID of the access
|
|
24810
|
+
description: "ID of the access system for which you want to retrieve all credentials.",
|
|
24711
24811
|
format: "uuid",
|
|
24712
24812
|
type: "string"
|
|
24713
24813
|
},
|
|
24714
24814
|
acs_user_id: {
|
|
24715
|
-
description: "ID of the
|
|
24815
|
+
description: "ID of the access system user for which you want to retrieve all credentials.",
|
|
24716
24816
|
format: "uuid",
|
|
24717
24817
|
type: "string"
|
|
24718
24818
|
}
|
|
@@ -24806,7 +24906,7 @@ var openapi_default = {
|
|
|
24806
24906
|
schema: {
|
|
24807
24907
|
properties: {
|
|
24808
24908
|
acs_credential_id: {
|
|
24809
|
-
description: "ID of the credential for which you want to retrieve all entrances to which
|
|
24909
|
+
description: "ID of the credential for which you want to retrieve all entrances to which the credential grants access.",
|
|
24810
24910
|
format: "uuid",
|
|
24811
24911
|
type: "string"
|
|
24812
24912
|
}
|
|
@@ -24855,7 +24955,7 @@ var openapi_default = {
|
|
|
24855
24955
|
},
|
|
24856
24956
|
"/acs/credentials/unassign": {
|
|
24857
24957
|
patch: {
|
|
24858
|
-
description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [
|
|
24958
|
+
description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
24859
24959
|
operationId: "acsCredentialsUnassignPatch",
|
|
24860
24960
|
requestBody: {
|
|
24861
24961
|
content: {
|
|
@@ -24863,12 +24963,12 @@ var openapi_default = {
|
|
|
24863
24963
|
schema: {
|
|
24864
24964
|
properties: {
|
|
24865
24965
|
acs_credential_id: {
|
|
24866
|
-
description: "ID of the
|
|
24966
|
+
description: "ID of the credential that you want to unassign from an access system user.",
|
|
24867
24967
|
format: "uuid",
|
|
24868
24968
|
type: "string"
|
|
24869
24969
|
},
|
|
24870
24970
|
acs_user_id: {
|
|
24871
|
-
description: "ID of the
|
|
24971
|
+
description: "ID of the access system user from which you want to unassign a credential.",
|
|
24872
24972
|
format: "uuid",
|
|
24873
24973
|
type: "string"
|
|
24874
24974
|
}
|
|
@@ -24912,7 +25012,7 @@ var openapi_default = {
|
|
|
24912
25012
|
"x-title": "Unassign a Credential from an ACS User"
|
|
24913
25013
|
},
|
|
24914
25014
|
post: {
|
|
24915
|
-
description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [
|
|
25015
|
+
description: "Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
24916
25016
|
operationId: "acsCredentialsUnassignPost",
|
|
24917
25017
|
requestBody: {
|
|
24918
25018
|
content: {
|
|
@@ -24920,12 +25020,12 @@ var openapi_default = {
|
|
|
24920
25020
|
schema: {
|
|
24921
25021
|
properties: {
|
|
24922
25022
|
acs_credential_id: {
|
|
24923
|
-
description: "ID of the
|
|
25023
|
+
description: "ID of the credential that you want to unassign from an access system user.",
|
|
24924
25024
|
format: "uuid",
|
|
24925
25025
|
type: "string"
|
|
24926
25026
|
},
|
|
24927
25027
|
acs_user_id: {
|
|
24928
|
-
description: "ID of the
|
|
25028
|
+
description: "ID of the access system user from which you want to unassign a credential.",
|
|
24929
25029
|
format: "uuid",
|
|
24930
25030
|
type: "string"
|
|
24931
25031
|
}
|
|
@@ -24980,7 +25080,7 @@ var openapi_default = {
|
|
|
24980
25080
|
schema: {
|
|
24981
25081
|
properties: {
|
|
24982
25082
|
acs_credential_id: {
|
|
24983
|
-
description: "ID of the
|
|
25083
|
+
description: "ID of the unmanaged credential that you want to get.",
|
|
24984
25084
|
format: "uuid",
|
|
24985
25085
|
type: "string"
|
|
24986
25086
|
}
|
|
@@ -25037,9 +25137,10 @@ var openapi_default = {
|
|
|
25037
25137
|
schema: {
|
|
25038
25138
|
oneOf: [
|
|
25039
25139
|
{
|
|
25140
|
+
description: "ID of the access system user for which you want to list unmanaged credentials.",
|
|
25040
25141
|
properties: {
|
|
25041
25142
|
acs_user_id: {
|
|
25042
|
-
description: "ID of the
|
|
25143
|
+
description: "ID of the access system user for which you want to retrieve all credentials.",
|
|
25043
25144
|
format: "uuid",
|
|
25044
25145
|
type: "string"
|
|
25045
25146
|
}
|
|
@@ -25048,9 +25149,10 @@ var openapi_default = {
|
|
|
25048
25149
|
type: "object"
|
|
25049
25150
|
},
|
|
25050
25151
|
{
|
|
25152
|
+
description: "ID of the access system for which you want to list unmanaged credentials.",
|
|
25051
25153
|
properties: {
|
|
25052
25154
|
acs_system_id: {
|
|
25053
|
-
description: "ID of the access
|
|
25155
|
+
description: "ID of the access system for which you want to retrieve all credentials.",
|
|
25054
25156
|
format: "uuid",
|
|
25055
25157
|
type: "string"
|
|
25056
25158
|
}
|
|
@@ -25059,14 +25161,15 @@ var openapi_default = {
|
|
|
25059
25161
|
type: "object"
|
|
25060
25162
|
},
|
|
25061
25163
|
{
|
|
25164
|
+
description: "ID of the access system and ID of the access system user for which you want to list unmanaged credentials.",
|
|
25062
25165
|
properties: {
|
|
25063
25166
|
acs_system_id: {
|
|
25064
|
-
description: "ID of the access
|
|
25167
|
+
description: "ID of the access system for which you want to retrieve all credentials.",
|
|
25065
25168
|
format: "uuid",
|
|
25066
25169
|
type: "string"
|
|
25067
25170
|
},
|
|
25068
25171
|
acs_user_id: {
|
|
25069
|
-
description: "ID of the
|
|
25172
|
+
description: "ID of the access system user for which you want to retrieve all credentials.",
|
|
25070
25173
|
format: "uuid",
|
|
25071
25174
|
type: "string"
|
|
25072
25175
|
}
|
|
@@ -25075,6 +25178,7 @@ var openapi_default = {
|
|
|
25075
25178
|
type: "object"
|
|
25076
25179
|
},
|
|
25077
25180
|
{
|
|
25181
|
+
description: "ID of the user identity for which you want to list unmanaged credentials.",
|
|
25078
25182
|
properties: {
|
|
25079
25183
|
user_identity_id: {
|
|
25080
25184
|
description: "ID of the user identity for which you want to retrieve all credentials.",
|
|
@@ -25139,11 +25243,11 @@ var openapi_default = {
|
|
|
25139
25243
|
schema: {
|
|
25140
25244
|
properties: {
|
|
25141
25245
|
acs_credential_id: {
|
|
25142
|
-
description: "ID of the
|
|
25246
|
+
description: "ID of the credential that you want to update.",
|
|
25143
25247
|
type: "string"
|
|
25144
25248
|
},
|
|
25145
25249
|
code: {
|
|
25146
|
-
description: "Replacement access (PIN) code for the credential.",
|
|
25250
|
+
description: "Replacement access (PIN) code for the credential that you want to update.",
|
|
25147
25251
|
pattern: "^\\d+$",
|
|
25148
25252
|
type: "string"
|
|
25149
25253
|
},
|
|
@@ -25200,11 +25304,11 @@ var openapi_default = {
|
|
|
25200
25304
|
schema: {
|
|
25201
25305
|
properties: {
|
|
25202
25306
|
acs_credential_id: {
|
|
25203
|
-
description: "ID of the
|
|
25307
|
+
description: "ID of the credential that you want to update.",
|
|
25204
25308
|
type: "string"
|
|
25205
25309
|
},
|
|
25206
25310
|
code: {
|
|
25207
|
-
description: "Replacement access (PIN) code for the credential.",
|
|
25311
|
+
description: "Replacement access (PIN) code for the credential that you want to update.",
|
|
25208
25312
|
pattern: "^\\d+$",
|
|
25209
25313
|
type: "string"
|
|
25210
25314
|
},
|
|
@@ -25388,7 +25492,7 @@ var openapi_default = {
|
|
|
25388
25492
|
schema: {
|
|
25389
25493
|
properties: {
|
|
25390
25494
|
acs_encoder_id: {
|
|
25391
|
-
description: "ID of the
|
|
25495
|
+
description: "ID of the encoder that you want to get.",
|
|
25392
25496
|
format: "uuid",
|
|
25393
25497
|
type: "string"
|
|
25394
25498
|
}
|
|
@@ -25444,13 +25548,13 @@ var openapi_default = {
|
|
|
25444
25548
|
{
|
|
25445
25549
|
properties: {
|
|
25446
25550
|
acs_system_id: {
|
|
25447
|
-
description: "ID of the
|
|
25551
|
+
description: "ID of the access system for which you want to retrieve all encoders.",
|
|
25448
25552
|
format: "uuid",
|
|
25449
25553
|
type: "string"
|
|
25450
25554
|
},
|
|
25451
25555
|
limit: {
|
|
25452
25556
|
default: 500,
|
|
25453
|
-
description: "Number of
|
|
25557
|
+
description: "Number of encoders to return.",
|
|
25454
25558
|
format: "float",
|
|
25455
25559
|
type: "number"
|
|
25456
25560
|
}
|
|
@@ -25461,13 +25565,13 @@ var openapi_default = {
|
|
|
25461
25565
|
{
|
|
25462
25566
|
properties: {
|
|
25463
25567
|
acs_system_ids: {
|
|
25464
|
-
description: "IDs of the
|
|
25568
|
+
description: "IDs of the access systems for which you want to retrieve all encoders.",
|
|
25465
25569
|
items: { format: "uuid", type: "string" },
|
|
25466
25570
|
type: "array"
|
|
25467
25571
|
},
|
|
25468
25572
|
limit: {
|
|
25469
25573
|
default: 500,
|
|
25470
|
-
description: "Number of
|
|
25574
|
+
description: "Number of encoders to return.",
|
|
25471
25575
|
format: "float",
|
|
25472
25576
|
type: "number"
|
|
25473
25577
|
}
|
|
@@ -25478,13 +25582,13 @@ var openapi_default = {
|
|
|
25478
25582
|
{
|
|
25479
25583
|
properties: {
|
|
25480
25584
|
acs_encoder_ids: {
|
|
25481
|
-
description: "IDs of the
|
|
25585
|
+
description: "IDs of the encoders that you want to retrieve.",
|
|
25482
25586
|
items: { format: "uuid", type: "string" },
|
|
25483
25587
|
type: "array"
|
|
25484
25588
|
},
|
|
25485
25589
|
limit: {
|
|
25486
25590
|
default: 500,
|
|
25487
|
-
description: "Number of
|
|
25591
|
+
description: "Number of encoders to return.",
|
|
25488
25592
|
format: "float",
|
|
25489
25593
|
type: "number"
|
|
25490
25594
|
}
|
|
@@ -25543,7 +25647,7 @@ var openapi_default = {
|
|
|
25543
25647
|
schema: {
|
|
25544
25648
|
properties: {
|
|
25545
25649
|
acs_encoder_id: {
|
|
25546
|
-
description: "ID of the
|
|
25650
|
+
description: "ID of the encoder to use for the scan.",
|
|
25547
25651
|
format: "uuid",
|
|
25548
25652
|
type: "string"
|
|
25549
25653
|
}
|
|
@@ -25915,14 +26019,18 @@ var openapi_default = {
|
|
|
25915
26019
|
},
|
|
25916
26020
|
"/acs/entrances/get": {
|
|
25917
26021
|
post: {
|
|
25918
|
-
description: "Returns a specified [
|
|
26022
|
+
description: "Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
25919
26023
|
operationId: "acsEntrancesGetPost",
|
|
25920
26024
|
requestBody: {
|
|
25921
26025
|
content: {
|
|
25922
26026
|
"application/json": {
|
|
25923
26027
|
schema: {
|
|
25924
26028
|
properties: {
|
|
25925
|
-
acs_entrance_id: {
|
|
26029
|
+
acs_entrance_id: {
|
|
26030
|
+
description: "ID of the entrance that you want to get.",
|
|
26031
|
+
format: "uuid",
|
|
26032
|
+
type: "string"
|
|
26033
|
+
}
|
|
25926
26034
|
},
|
|
25927
26035
|
required: ["acs_entrance_id"],
|
|
25928
26036
|
type: "object"
|
|
@@ -25966,14 +26074,23 @@ var openapi_default = {
|
|
|
25966
26074
|
},
|
|
25967
26075
|
"/acs/entrances/grant_access": {
|
|
25968
26076
|
post: {
|
|
26077
|
+
description: "Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
25969
26078
|
operationId: "acsEntrancesGrantAccessPost",
|
|
25970
26079
|
requestBody: {
|
|
25971
26080
|
content: {
|
|
25972
26081
|
"application/json": {
|
|
25973
26082
|
schema: {
|
|
25974
26083
|
properties: {
|
|
25975
|
-
acs_entrance_id: {
|
|
25976
|
-
|
|
26084
|
+
acs_entrance_id: {
|
|
26085
|
+
description: "ID of the entrance to which you want to grant an access system user access.",
|
|
26086
|
+
format: "uuid",
|
|
26087
|
+
type: "string"
|
|
26088
|
+
},
|
|
26089
|
+
acs_user_id: {
|
|
26090
|
+
description: "ID of the access system user to whom you want to grant access to an entrance.",
|
|
26091
|
+
format: "uuid",
|
|
26092
|
+
type: "string"
|
|
26093
|
+
}
|
|
25977
26094
|
},
|
|
25978
26095
|
required: ["acs_entrance_id", "acs_user_id"],
|
|
25979
26096
|
type: "object"
|
|
@@ -26012,16 +26129,25 @@ var openapi_default = {
|
|
|
26012
26129
|
},
|
|
26013
26130
|
"/acs/entrances/list": {
|
|
26014
26131
|
post: {
|
|
26015
|
-
description: "Returns a list of all [
|
|
26132
|
+
description: "Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
26016
26133
|
operationId: "acsEntrancesListPost",
|
|
26017
26134
|
requestBody: {
|
|
26018
26135
|
content: {
|
|
26019
26136
|
"application/json": {
|
|
26020
26137
|
schema: {
|
|
26021
26138
|
properties: {
|
|
26022
|
-
acs_credential_id: {
|
|
26023
|
-
|
|
26139
|
+
acs_credential_id: {
|
|
26140
|
+
description: "ID of the credential for which you want to retrieve all entrances.",
|
|
26141
|
+
format: "uuid",
|
|
26142
|
+
type: "string"
|
|
26143
|
+
},
|
|
26144
|
+
acs_system_id: {
|
|
26145
|
+
description: "ID of the access system for which you want to retrieve all entrances.",
|
|
26146
|
+
format: "uuid",
|
|
26147
|
+
type: "string"
|
|
26148
|
+
},
|
|
26024
26149
|
location_id: {
|
|
26150
|
+
description: "ID of the location for which you want to retrieve all entrances.",
|
|
26025
26151
|
format: "uuid",
|
|
26026
26152
|
nullable: true,
|
|
26027
26153
|
type: "string",
|
|
@@ -26079,8 +26205,13 @@ var openapi_default = {
|
|
|
26079
26205
|
"application/json": {
|
|
26080
26206
|
schema: {
|
|
26081
26207
|
properties: {
|
|
26082
|
-
acs_entrance_id: {
|
|
26208
|
+
acs_entrance_id: {
|
|
26209
|
+
description: "ID of the entrance for which you want to list all credentials that grant access.",
|
|
26210
|
+
format: "uuid",
|
|
26211
|
+
type: "string"
|
|
26212
|
+
},
|
|
26083
26213
|
include_if: {
|
|
26214
|
+
description: "Conditions that credentials must meet to be included in the returned list.",
|
|
26084
26215
|
items: {
|
|
26085
26216
|
enum: ["visionline_metadata.is_valid"],
|
|
26086
26217
|
type: "string"
|
|
@@ -26133,7 +26264,7 @@ var openapi_default = {
|
|
|
26133
26264
|
},
|
|
26134
26265
|
"/acs/systems/get": {
|
|
26135
26266
|
post: {
|
|
26136
|
-
description: "Returns a specified [access
|
|
26267
|
+
description: "Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).",
|
|
26137
26268
|
operationId: "acsSystemsGetPost",
|
|
26138
26269
|
requestBody: {
|
|
26139
26270
|
content: {
|
|
@@ -26141,7 +26272,7 @@ var openapi_default = {
|
|
|
26141
26272
|
schema: {
|
|
26142
26273
|
properties: {
|
|
26143
26274
|
acs_system_id: {
|
|
26144
|
-
description: "ID of the
|
|
26275
|
+
description: "ID of the access system that you want to get.",
|
|
26145
26276
|
format: "uuid",
|
|
26146
26277
|
type: "string"
|
|
26147
26278
|
}
|
|
@@ -26187,7 +26318,7 @@ var openapi_default = {
|
|
|
26187
26318
|
},
|
|
26188
26319
|
"/acs/systems/list": {
|
|
26189
26320
|
post: {
|
|
26190
|
-
description: "Returns a list of all [access
|
|
26321
|
+
description: "Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.",
|
|
26191
26322
|
operationId: "acsSystemsListPost",
|
|
26192
26323
|
requestBody: {
|
|
26193
26324
|
content: {
|
|
@@ -26195,7 +26326,7 @@ var openapi_default = {
|
|
|
26195
26326
|
schema: {
|
|
26196
26327
|
properties: {
|
|
26197
26328
|
connected_account_id: {
|
|
26198
|
-
description: "ID of the connected account by which to filter the list of
|
|
26329
|
+
description: "ID of the connected account by which you want to filter the list of access systems.",
|
|
26199
26330
|
format: "uuid",
|
|
26200
26331
|
type: "string"
|
|
26201
26332
|
}
|
|
@@ -26244,7 +26375,7 @@ var openapi_default = {
|
|
|
26244
26375
|
},
|
|
26245
26376
|
"/acs/systems/list_compatible_credential_manager_acs_systems": {
|
|
26246
26377
|
post: {
|
|
26247
|
-
description: "Returns a list of all credential manager
|
|
26378
|
+
description: "Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.",
|
|
26248
26379
|
operationId: "acsSystemsListCompatibleCredentialManagerAcsSystemsPost",
|
|
26249
26380
|
requestBody: {
|
|
26250
26381
|
content: {
|
|
@@ -26252,7 +26383,7 @@ var openapi_default = {
|
|
|
26252
26383
|
schema: {
|
|
26253
26384
|
properties: {
|
|
26254
26385
|
acs_system_id: {
|
|
26255
|
-
description: "ID of the
|
|
26386
|
+
description: "ID of the access system for which you want to retrieve all compatible credential manager systems.",
|
|
26256
26387
|
format: "uuid",
|
|
26257
26388
|
type: "string"
|
|
26258
26389
|
}
|
|
@@ -26301,7 +26432,7 @@ var openapi_default = {
|
|
|
26301
26432
|
},
|
|
26302
26433
|
"/acs/users/add_to_access_group": {
|
|
26303
26434
|
post: {
|
|
26304
|
-
description: "Adds a specified [
|
|
26435
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
26305
26436
|
operationId: "acsUsersAddToAccessGroupPost",
|
|
26306
26437
|
requestBody: {
|
|
26307
26438
|
content: {
|
|
@@ -26309,12 +26440,12 @@ var openapi_default = {
|
|
|
26309
26440
|
schema: {
|
|
26310
26441
|
properties: {
|
|
26311
26442
|
acs_access_group_id: {
|
|
26312
|
-
description: "ID of the
|
|
26443
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
26313
26444
|
format: "uuid",
|
|
26314
26445
|
type: "string"
|
|
26315
26446
|
},
|
|
26316
26447
|
acs_user_id: {
|
|
26317
|
-
description: "ID of the
|
|
26448
|
+
description: "ID of the access system user that you want to add to an access group.",
|
|
26318
26449
|
format: "uuid",
|
|
26319
26450
|
type: "string"
|
|
26320
26451
|
}
|
|
@@ -26354,7 +26485,7 @@ var openapi_default = {
|
|
|
26354
26485
|
"x-title": "Add an ACS User to an Access Group"
|
|
26355
26486
|
},
|
|
26356
26487
|
put: {
|
|
26357
|
-
description: "Adds a specified [
|
|
26488
|
+
description: "Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
26358
26489
|
operationId: "acsUsersAddToAccessGroupPut",
|
|
26359
26490
|
requestBody: {
|
|
26360
26491
|
content: {
|
|
@@ -26362,12 +26493,12 @@ var openapi_default = {
|
|
|
26362
26493
|
schema: {
|
|
26363
26494
|
properties: {
|
|
26364
26495
|
acs_access_group_id: {
|
|
26365
|
-
description: "ID of the
|
|
26496
|
+
description: "ID of the access group to which you want to add an access system user.",
|
|
26366
26497
|
format: "uuid",
|
|
26367
26498
|
type: "string"
|
|
26368
26499
|
},
|
|
26369
26500
|
acs_user_id: {
|
|
26370
|
-
description: "ID of the
|
|
26501
|
+
description: "ID of the access system user that you want to add to an access group.",
|
|
26371
26502
|
format: "uuid",
|
|
26372
26503
|
type: "string"
|
|
26373
26504
|
}
|
|
@@ -26408,7 +26539,7 @@ var openapi_default = {
|
|
|
26408
26539
|
},
|
|
26409
26540
|
"/acs/users/create": {
|
|
26410
26541
|
post: {
|
|
26411
|
-
description: "Creates a new [
|
|
26542
|
+
description: "Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
26412
26543
|
operationId: "acsUsersCreatePost",
|
|
26413
26544
|
requestBody: {
|
|
26414
26545
|
content: {
|
|
@@ -26416,25 +26547,30 @@ var openapi_default = {
|
|
|
26416
26547
|
schema: {
|
|
26417
26548
|
properties: {
|
|
26418
26549
|
access_schedule: {
|
|
26419
|
-
description: "`starts_at` and `ends_at` timestamps for the new
|
|
26550
|
+
description: "`starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
|
|
26420
26551
|
properties: {
|
|
26421
26552
|
ends_at: {
|
|
26553
|
+
description: "Ending timestamp for the new access system user's access.",
|
|
26422
26554
|
format: "date-time",
|
|
26423
26555
|
nullable: true,
|
|
26424
26556
|
type: "string"
|
|
26425
26557
|
},
|
|
26426
|
-
starts_at: {
|
|
26558
|
+
starts_at: {
|
|
26559
|
+
description: "Starting timestamp for the new access system user's access.",
|
|
26560
|
+
format: "date-time",
|
|
26561
|
+
type: "string"
|
|
26562
|
+
}
|
|
26427
26563
|
},
|
|
26428
26564
|
type: "object"
|
|
26429
26565
|
},
|
|
26430
26566
|
acs_access_group_ids: {
|
|
26431
26567
|
default: [],
|
|
26432
|
-
description: "Array of
|
|
26568
|
+
description: "Array of access group IDs to indicate the access groups to which you want to add the new access system user.",
|
|
26433
26569
|
items: { format: "uuid", type: "string" },
|
|
26434
26570
|
type: "array"
|
|
26435
26571
|
},
|
|
26436
26572
|
acs_system_id: {
|
|
26437
|
-
description: "ID of the
|
|
26573
|
+
description: "ID of the access system to which you want to add the new access system user.",
|
|
26438
26574
|
format: "uuid",
|
|
26439
26575
|
type: "string"
|
|
26440
26576
|
},
|
|
@@ -26450,7 +26586,7 @@ var openapi_default = {
|
|
|
26450
26586
|
type: "string"
|
|
26451
26587
|
},
|
|
26452
26588
|
full_name: {
|
|
26453
|
-
description: "Full name of the new
|
|
26589
|
+
description: "Full name of the new access system user.",
|
|
26454
26590
|
type: "string"
|
|
26455
26591
|
},
|
|
26456
26592
|
phone_number: {
|
|
@@ -26458,7 +26594,7 @@ var openapi_default = {
|
|
|
26458
26594
|
type: "string"
|
|
26459
26595
|
},
|
|
26460
26596
|
user_identity_id: {
|
|
26461
|
-
description: "ID of the user identity with which to associate the new
|
|
26597
|
+
description: "ID of the user identity with which you want to associate the new access system user.",
|
|
26462
26598
|
format: "uuid",
|
|
26463
26599
|
type: "string"
|
|
26464
26600
|
}
|
|
@@ -26504,7 +26640,7 @@ var openapi_default = {
|
|
|
26504
26640
|
},
|
|
26505
26641
|
"/acs/users/delete": {
|
|
26506
26642
|
post: {
|
|
26507
|
-
description: "Deletes a specified [
|
|
26643
|
+
description: "Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
26508
26644
|
operationId: "acsUsersDeletePost",
|
|
26509
26645
|
requestBody: {
|
|
26510
26646
|
content: {
|
|
@@ -26512,7 +26648,7 @@ var openapi_default = {
|
|
|
26512
26648
|
schema: {
|
|
26513
26649
|
properties: {
|
|
26514
26650
|
acs_user_id: {
|
|
26515
|
-
description: "ID of the
|
|
26651
|
+
description: "ID of the access system user that you want to delete.",
|
|
26516
26652
|
format: "uuid",
|
|
26517
26653
|
type: "string"
|
|
26518
26654
|
}
|
|
@@ -26554,7 +26690,7 @@ var openapi_default = {
|
|
|
26554
26690
|
},
|
|
26555
26691
|
"/acs/users/get": {
|
|
26556
26692
|
post: {
|
|
26557
|
-
description: "Returns a specified [
|
|
26693
|
+
description: "Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
26558
26694
|
operationId: "acsUsersGetPost",
|
|
26559
26695
|
requestBody: {
|
|
26560
26696
|
content: {
|
|
@@ -26562,7 +26698,7 @@ var openapi_default = {
|
|
|
26562
26698
|
schema: {
|
|
26563
26699
|
properties: {
|
|
26564
26700
|
acs_user_id: {
|
|
26565
|
-
description: "ID of the
|
|
26701
|
+
description: "ID of the access system user that you want to get.",
|
|
26566
26702
|
format: "uuid",
|
|
26567
26703
|
type: "string"
|
|
26568
26704
|
}
|
|
@@ -26608,7 +26744,7 @@ var openapi_default = {
|
|
|
26608
26744
|
},
|
|
26609
26745
|
"/acs/users/list": {
|
|
26610
26746
|
post: {
|
|
26611
|
-
description: "Returns a list of all [
|
|
26747
|
+
description: "Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
26612
26748
|
operationId: "acsUsersListPost",
|
|
26613
26749
|
requestBody: {
|
|
26614
26750
|
content: {
|
|
@@ -26616,11 +26752,15 @@ var openapi_default = {
|
|
|
26616
26752
|
schema: {
|
|
26617
26753
|
properties: {
|
|
26618
26754
|
acs_system_id: {
|
|
26619
|
-
description: "ID of the `acs_system` for which you want to retrieve all
|
|
26755
|
+
description: "ID of the `acs_system` for which you want to retrieve all access system users.",
|
|
26620
26756
|
format: "uuid",
|
|
26621
26757
|
type: "string"
|
|
26622
26758
|
},
|
|
26623
|
-
created_before: {
|
|
26759
|
+
created_before: {
|
|
26760
|
+
description: "Timestamp by which to limit returned access system users. Returns users created before this timestamp.",
|
|
26761
|
+
format: "date-time",
|
|
26762
|
+
type: "string"
|
|
26763
|
+
},
|
|
26624
26764
|
limit: {
|
|
26625
26765
|
default: 500,
|
|
26626
26766
|
description: "Maximum number of records to return per page.",
|
|
@@ -26634,21 +26774,21 @@ var openapi_default = {
|
|
|
26634
26774
|
type: "string"
|
|
26635
26775
|
},
|
|
26636
26776
|
search: {
|
|
26637
|
-
description: "String for which to search. Filters returned
|
|
26777
|
+
description: "String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.",
|
|
26638
26778
|
minLength: 1,
|
|
26639
26779
|
type: "string"
|
|
26640
26780
|
},
|
|
26641
26781
|
user_identity_email_address: {
|
|
26642
|
-
description: "Email address of the user identity for which you want to retrieve all
|
|
26782
|
+
description: "Email address of the user identity for which you want to retrieve all access system users.",
|
|
26643
26783
|
type: "string"
|
|
26644
26784
|
},
|
|
26645
26785
|
user_identity_id: {
|
|
26646
|
-
description: "ID of the user identity for which you want to retrieve all
|
|
26786
|
+
description: "ID of the user identity for which you want to retrieve all access system users.",
|
|
26647
26787
|
format: "uuid",
|
|
26648
26788
|
type: "string"
|
|
26649
26789
|
},
|
|
26650
26790
|
user_identity_phone_number: {
|
|
26651
|
-
description: "Phone number of the user identity for which you want to retrieve all
|
|
26791
|
+
description: "Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).",
|
|
26652
26792
|
type: "string"
|
|
26653
26793
|
}
|
|
26654
26794
|
},
|
|
@@ -26697,7 +26837,7 @@ var openapi_default = {
|
|
|
26697
26837
|
},
|
|
26698
26838
|
"/acs/users/list_accessible_entrances": {
|
|
26699
26839
|
post: {
|
|
26700
|
-
description: "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [
|
|
26840
|
+
description: "Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.",
|
|
26701
26841
|
operationId: "acsUsersListAccessibleEntrancesPost",
|
|
26702
26842
|
requestBody: {
|
|
26703
26843
|
content: {
|
|
@@ -26705,7 +26845,7 @@ var openapi_default = {
|
|
|
26705
26845
|
schema: {
|
|
26706
26846
|
properties: {
|
|
26707
26847
|
acs_user_id: {
|
|
26708
|
-
description: "ID of the
|
|
26848
|
+
description: "ID of the access system user for whom you want to list accessible entrances.",
|
|
26709
26849
|
format: "uuid",
|
|
26710
26850
|
type: "string"
|
|
26711
26851
|
}
|
|
@@ -26755,7 +26895,7 @@ var openapi_default = {
|
|
|
26755
26895
|
},
|
|
26756
26896
|
"/acs/users/remove_from_access_group": {
|
|
26757
26897
|
post: {
|
|
26758
|
-
description: "Removes a specified [
|
|
26898
|
+
description: "Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).",
|
|
26759
26899
|
operationId: "acsUsersRemoveFromAccessGroupPost",
|
|
26760
26900
|
requestBody: {
|
|
26761
26901
|
content: {
|
|
@@ -26763,12 +26903,12 @@ var openapi_default = {
|
|
|
26763
26903
|
schema: {
|
|
26764
26904
|
properties: {
|
|
26765
26905
|
acs_access_group_id: {
|
|
26766
|
-
description: "ID of the
|
|
26906
|
+
description: "ID of the access group from which you want to remove an access system user.",
|
|
26767
26907
|
format: "uuid",
|
|
26768
26908
|
type: "string"
|
|
26769
26909
|
},
|
|
26770
26910
|
acs_user_id: {
|
|
26771
|
-
description: "ID of the
|
|
26911
|
+
description: "ID of the access system user that you want to remove from an access group.",
|
|
26772
26912
|
format: "uuid",
|
|
26773
26913
|
type: "string"
|
|
26774
26914
|
}
|
|
@@ -26810,7 +26950,7 @@ var openapi_default = {
|
|
|
26810
26950
|
},
|
|
26811
26951
|
"/acs/users/revoke_access_to_all_entrances": {
|
|
26812
26952
|
post: {
|
|
26813
|
-
description: "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [
|
|
26953
|
+
description: "Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
26814
26954
|
operationId: "acsUsersRevokeAccessToAllEntrancesPost",
|
|
26815
26955
|
requestBody: {
|
|
26816
26956
|
content: {
|
|
@@ -26818,7 +26958,7 @@ var openapi_default = {
|
|
|
26818
26958
|
schema: {
|
|
26819
26959
|
properties: {
|
|
26820
26960
|
acs_user_id: {
|
|
26821
|
-
description: "ID of the
|
|
26961
|
+
description: "ID of the access system user for whom you want to revoke access.",
|
|
26822
26962
|
format: "uuid",
|
|
26823
26963
|
type: "string"
|
|
26824
26964
|
}
|
|
@@ -26860,7 +27000,7 @@ var openapi_default = {
|
|
|
26860
27000
|
},
|
|
26861
27001
|
"/acs/users/suspend": {
|
|
26862
27002
|
post: {
|
|
26863
|
-
description: "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [
|
|
27003
|
+
description: "[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.",
|
|
26864
27004
|
operationId: "acsUsersSuspendPost",
|
|
26865
27005
|
requestBody: {
|
|
26866
27006
|
content: {
|
|
@@ -26868,7 +27008,7 @@ var openapi_default = {
|
|
|
26868
27008
|
schema: {
|
|
26869
27009
|
properties: {
|
|
26870
27010
|
acs_user_id: {
|
|
26871
|
-
description: "ID of the
|
|
27011
|
+
description: "ID of the access system user that you want to suspend.",
|
|
26872
27012
|
format: "uuid",
|
|
26873
27013
|
type: "string"
|
|
26874
27014
|
}
|
|
@@ -26910,12 +27050,19 @@ var openapi_default = {
|
|
|
26910
27050
|
},
|
|
26911
27051
|
"/acs/users/unmanaged/get": {
|
|
26912
27052
|
post: {
|
|
27053
|
+
description: "Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
26913
27054
|
operationId: "acsUsersUnmanagedGetPost",
|
|
26914
27055
|
requestBody: {
|
|
26915
27056
|
content: {
|
|
26916
27057
|
"application/json": {
|
|
26917
27058
|
schema: {
|
|
26918
|
-
properties: {
|
|
27059
|
+
properties: {
|
|
27060
|
+
acs_user_id: {
|
|
27061
|
+
description: "ID of the unmanaged access system user that you want to get.",
|
|
27062
|
+
format: "uuid",
|
|
27063
|
+
type: "string"
|
|
27064
|
+
}
|
|
27065
|
+
},
|
|
26919
27066
|
required: ["acs_user_id"],
|
|
26920
27067
|
type: "object"
|
|
26921
27068
|
}
|
|
@@ -26954,22 +27101,43 @@ var openapi_default = {
|
|
|
26954
27101
|
"x-fern-sdk-method-name": "get",
|
|
26955
27102
|
"x-fern-sdk-return-value": "acs_user",
|
|
26956
27103
|
"x-response-key": "acs_user",
|
|
27104
|
+
"x-title": "Get an Unmanaged ACS User",
|
|
26957
27105
|
"x-undocumented": "No unmanaged users are currently implemented."
|
|
26958
27106
|
}
|
|
26959
27107
|
},
|
|
26960
27108
|
"/acs/users/unmanaged/list": {
|
|
26961
27109
|
post: {
|
|
27110
|
+
description: "Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
26962
27111
|
operationId: "acsUsersUnmanagedListPost",
|
|
26963
27112
|
requestBody: {
|
|
26964
27113
|
content: {
|
|
26965
27114
|
"application/json": {
|
|
26966
27115
|
schema: {
|
|
26967
27116
|
properties: {
|
|
26968
|
-
acs_system_id: {
|
|
26969
|
-
|
|
26970
|
-
|
|
26971
|
-
|
|
26972
|
-
|
|
27117
|
+
acs_system_id: {
|
|
27118
|
+
description: "ID of the access system for which you want to retrieve all unmanaged access system users.",
|
|
27119
|
+
format: "uuid",
|
|
27120
|
+
type: "string"
|
|
27121
|
+
},
|
|
27122
|
+
limit: {
|
|
27123
|
+
default: 500,
|
|
27124
|
+
description: "Number of unmanaged access system users to return.",
|
|
27125
|
+
format: "float",
|
|
27126
|
+
type: "number"
|
|
27127
|
+
},
|
|
27128
|
+
user_identity_email_address: {
|
|
27129
|
+
description: "Email address of the user identity for which you want to retrieve all unmanaged access system users.",
|
|
27130
|
+
type: "string"
|
|
27131
|
+
},
|
|
27132
|
+
user_identity_id: {
|
|
27133
|
+
description: "ID of the user identity for which you want to retrieve all unmanaged access system users.",
|
|
27134
|
+
format: "uuid",
|
|
27135
|
+
type: "string"
|
|
27136
|
+
},
|
|
27137
|
+
user_identity_phone_number: {
|
|
27138
|
+
description: "Phone number of the user identity for which you want to retrieve all unmanaged access system users.",
|
|
27139
|
+
type: "string"
|
|
27140
|
+
}
|
|
26973
27141
|
},
|
|
26974
27142
|
type: "object"
|
|
26975
27143
|
}
|
|
@@ -27011,12 +27179,13 @@ var openapi_default = {
|
|
|
27011
27179
|
"x-fern-sdk-method-name": "list",
|
|
27012
27180
|
"x-fern-sdk-return-value": "acs_users",
|
|
27013
27181
|
"x-response-key": "acs_users",
|
|
27182
|
+
"x-title": "List Unmanaged ACS Users",
|
|
27014
27183
|
"x-undocumented": "No unmanaged users are currently implemented."
|
|
27015
27184
|
}
|
|
27016
27185
|
},
|
|
27017
27186
|
"/acs/users/unsuspend": {
|
|
27018
27187
|
post: {
|
|
27019
|
-
description: "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [
|
|
27188
|
+
description: "[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.",
|
|
27020
27189
|
operationId: "acsUsersUnsuspendPost",
|
|
27021
27190
|
requestBody: {
|
|
27022
27191
|
content: {
|
|
@@ -27024,7 +27193,7 @@ var openapi_default = {
|
|
|
27024
27193
|
schema: {
|
|
27025
27194
|
properties: {
|
|
27026
27195
|
acs_user_id: {
|
|
27027
|
-
description: "ID of the
|
|
27196
|
+
description: "ID of the access system user that you want to unsuspend.",
|
|
27028
27197
|
format: "uuid",
|
|
27029
27198
|
type: "string"
|
|
27030
27199
|
}
|
|
@@ -27066,7 +27235,7 @@ var openapi_default = {
|
|
|
27066
27235
|
},
|
|
27067
27236
|
"/acs/users/update": {
|
|
27068
27237
|
patch: {
|
|
27069
|
-
description: "Updates the properties of a specified [
|
|
27238
|
+
description: "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
27070
27239
|
operationId: "acsUsersUpdatePatch",
|
|
27071
27240
|
requestBody: {
|
|
27072
27241
|
content: {
|
|
@@ -27074,11 +27243,19 @@ var openapi_default = {
|
|
|
27074
27243
|
schema: {
|
|
27075
27244
|
properties: {
|
|
27076
27245
|
access_schedule: {
|
|
27077
|
-
description: "`starts_at` and `ends_at` timestamps for the
|
|
27246
|
+
description: "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
|
|
27078
27247
|
nullable: true,
|
|
27079
27248
|
properties: {
|
|
27080
|
-
ends_at: {
|
|
27081
|
-
|
|
27249
|
+
ends_at: {
|
|
27250
|
+
description: "Ending timestamp for the access system user's access.",
|
|
27251
|
+
format: "date-time",
|
|
27252
|
+
type: "string"
|
|
27253
|
+
},
|
|
27254
|
+
starts_at: {
|
|
27255
|
+
description: "Starting timestamp for the access system user's access.",
|
|
27256
|
+
format: "date-time",
|
|
27257
|
+
type: "string"
|
|
27258
|
+
}
|
|
27082
27259
|
},
|
|
27083
27260
|
required: ["starts_at", "ends_at"],
|
|
27084
27261
|
type: "object"
|
|
@@ -27144,7 +27321,7 @@ var openapi_default = {
|
|
|
27144
27321
|
"x-title": "Update an ACS User"
|
|
27145
27322
|
},
|
|
27146
27323
|
post: {
|
|
27147
|
-
description: "Updates the properties of a specified [
|
|
27324
|
+
description: "Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).",
|
|
27148
27325
|
operationId: "acsUsersUpdatePost",
|
|
27149
27326
|
requestBody: {
|
|
27150
27327
|
content: {
|
|
@@ -27152,11 +27329,19 @@ var openapi_default = {
|
|
|
27152
27329
|
schema: {
|
|
27153
27330
|
properties: {
|
|
27154
27331
|
access_schedule: {
|
|
27155
|
-
description: "`starts_at` and `ends_at` timestamps for the
|
|
27332
|
+
description: "`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
|
|
27156
27333
|
nullable: true,
|
|
27157
27334
|
properties: {
|
|
27158
|
-
ends_at: {
|
|
27159
|
-
|
|
27335
|
+
ends_at: {
|
|
27336
|
+
description: "Ending timestamp for the access system user's access.",
|
|
27337
|
+
format: "date-time",
|
|
27338
|
+
type: "string"
|
|
27339
|
+
},
|
|
27340
|
+
starts_at: {
|
|
27341
|
+
description: "Starting timestamp for the access system user's access.",
|
|
27342
|
+
format: "date-time",
|
|
27343
|
+
type: "string"
|
|
27344
|
+
}
|
|
27160
27345
|
},
|
|
27161
27346
|
required: ["starts_at", "ends_at"],
|
|
27162
27347
|
type: "object"
|
|
@@ -27225,13 +27410,18 @@ var openapi_default = {
|
|
|
27225
27410
|
},
|
|
27226
27411
|
"/action_attempts/get": {
|
|
27227
27412
|
post: {
|
|
27413
|
+
description: "Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).",
|
|
27228
27414
|
operationId: "actionAttemptsGetPost",
|
|
27229
27415
|
requestBody: {
|
|
27230
27416
|
content: {
|
|
27231
27417
|
"application/json": {
|
|
27232
27418
|
schema: {
|
|
27233
27419
|
properties: {
|
|
27234
|
-
action_attempt_id: {
|
|
27420
|
+
action_attempt_id: {
|
|
27421
|
+
description: "ID of the action attempt that you want to get.",
|
|
27422
|
+
format: "uuid",
|
|
27423
|
+
type: "string"
|
|
27424
|
+
}
|
|
27235
27425
|
},
|
|
27236
27426
|
required: ["action_attempt_id"],
|
|
27237
27427
|
type: "object"
|
|
@@ -27271,11 +27461,13 @@ var openapi_default = {
|
|
|
27271
27461
|
"x-fern-sdk-group-name": ["action_attempts"],
|
|
27272
27462
|
"x-fern-sdk-method-name": "get",
|
|
27273
27463
|
"x-fern-sdk-return-value": "action_attempt",
|
|
27274
|
-
"x-response-key": "action_attempt"
|
|
27464
|
+
"x-response-key": "action_attempt",
|
|
27465
|
+
"x-title": "Get an Action Attempt"
|
|
27275
27466
|
}
|
|
27276
27467
|
},
|
|
27277
27468
|
"/action_attempts/list": {
|
|
27278
27469
|
post: {
|
|
27470
|
+
description: "Returns a list of the [action attempts](https://docs.seam.co/latest/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.",
|
|
27279
27471
|
operationId: "actionAttemptsListPost",
|
|
27280
27472
|
requestBody: {
|
|
27281
27473
|
content: {
|
|
@@ -27283,6 +27475,7 @@ var openapi_default = {
|
|
|
27283
27475
|
schema: {
|
|
27284
27476
|
properties: {
|
|
27285
27477
|
action_attempt_ids: {
|
|
27478
|
+
description: "IDs of the action attempts that you want to retrieve.",
|
|
27286
27479
|
items: { format: "uuid", type: "string" },
|
|
27287
27480
|
type: "array"
|
|
27288
27481
|
}
|
|
@@ -27325,17 +27518,25 @@ var openapi_default = {
|
|
|
27325
27518
|
"x-fern-sdk-group-name": ["action_attempts"],
|
|
27326
27519
|
"x-fern-sdk-method-name": "list",
|
|
27327
27520
|
"x-fern-sdk-return-value": "action_attempts",
|
|
27328
|
-
"x-response-key": "action_attempts"
|
|
27521
|
+
"x-response-key": "action_attempts",
|
|
27522
|
+
"x-title": "List Action Attempts"
|
|
27329
27523
|
}
|
|
27330
27524
|
},
|
|
27331
27525
|
"/bridges/get": {
|
|
27332
27526
|
post: {
|
|
27527
|
+
description: "Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).",
|
|
27333
27528
|
operationId: "bridgesGetPost",
|
|
27334
27529
|
requestBody: {
|
|
27335
27530
|
content: {
|
|
27336
27531
|
"application/json": {
|
|
27337
27532
|
schema: {
|
|
27338
|
-
properties: {
|
|
27533
|
+
properties: {
|
|
27534
|
+
bridge_id: {
|
|
27535
|
+
description: "ID of the Seam Bridge that you want to get.",
|
|
27536
|
+
format: "uuid",
|
|
27537
|
+
type: "string"
|
|
27538
|
+
}
|
|
27539
|
+
},
|
|
27339
27540
|
required: ["bridge_id"],
|
|
27340
27541
|
type: "object"
|
|
27341
27542
|
}
|
|
@@ -27381,11 +27582,14 @@ var openapi_default = {
|
|
|
27381
27582
|
"x-fern-sdk-group-name": ["bridges"],
|
|
27382
27583
|
"x-fern-sdk-method-name": "get",
|
|
27383
27584
|
"x-fern-sdk-return-value": "bridge",
|
|
27384
|
-
"x-response-key": "bridge"
|
|
27585
|
+
"x-response-key": "bridge",
|
|
27586
|
+
"x-title": "Get a Seam Bridge",
|
|
27587
|
+
"x-undocumented": "Not yet for customer use."
|
|
27385
27588
|
}
|
|
27386
27589
|
},
|
|
27387
27590
|
"/bridges/list": {
|
|
27388
27591
|
post: {
|
|
27592
|
+
description: "Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).",
|
|
27389
27593
|
operationId: "bridgesListPost",
|
|
27390
27594
|
requestBody: {
|
|
27391
27595
|
content: {
|
|
@@ -27434,11 +27638,14 @@ var openapi_default = {
|
|
|
27434
27638
|
"x-fern-sdk-group-name": ["bridges"],
|
|
27435
27639
|
"x-fern-sdk-method-name": "list",
|
|
27436
27640
|
"x-fern-sdk-return-value": "bridges",
|
|
27437
|
-
"x-response-key": "bridges"
|
|
27641
|
+
"x-response-key": "bridges",
|
|
27642
|
+
"x-title": "List Seam Bridges",
|
|
27643
|
+
"x-undocumented": "Not yet for customer use."
|
|
27438
27644
|
}
|
|
27439
27645
|
},
|
|
27440
27646
|
"/client_sessions/create": {
|
|
27441
27647
|
post: {
|
|
27648
|
+
description: "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
|
|
27442
27649
|
operationId: "clientSessionsCreatePost",
|
|
27443
27650
|
requestBody: {
|
|
27444
27651
|
content: {
|
|
@@ -27446,16 +27653,27 @@ var openapi_default = {
|
|
|
27446
27653
|
schema: {
|
|
27447
27654
|
properties: {
|
|
27448
27655
|
connect_webview_ids: {
|
|
27656
|
+
description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.",
|
|
27449
27657
|
items: { type: "string" },
|
|
27450
27658
|
type: "array"
|
|
27451
27659
|
},
|
|
27452
27660
|
connected_account_ids: {
|
|
27661
|
+
description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.",
|
|
27453
27662
|
items: { type: "string" },
|
|
27454
27663
|
type: "array"
|
|
27455
27664
|
},
|
|
27456
|
-
expires_at: {
|
|
27457
|
-
|
|
27665
|
+
expires_at: {
|
|
27666
|
+
description: "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
27667
|
+
format: "date-time",
|
|
27668
|
+
type: "string"
|
|
27669
|
+
},
|
|
27670
|
+
user_identifier_key: {
|
|
27671
|
+
description: "Your user ID for the user for whom you want to create a client session.",
|
|
27672
|
+
minLength: 1,
|
|
27673
|
+
type: "string"
|
|
27674
|
+
},
|
|
27458
27675
|
user_identity_ids: {
|
|
27676
|
+
description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.",
|
|
27459
27677
|
items: { type: "string" },
|
|
27460
27678
|
type: "array"
|
|
27461
27679
|
}
|
|
@@ -27497,9 +27715,11 @@ var openapi_default = {
|
|
|
27497
27715
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27498
27716
|
"x-fern-sdk-method-name": "create",
|
|
27499
27717
|
"x-fern-sdk-return-value": "client_session",
|
|
27500
|
-
"x-response-key": "client_session"
|
|
27718
|
+
"x-response-key": "client_session",
|
|
27719
|
+
"x-title": "Create a Client Session"
|
|
27501
27720
|
},
|
|
27502
27721
|
put: {
|
|
27722
|
+
description: "Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
|
|
27503
27723
|
operationId: "clientSessionsCreatePut",
|
|
27504
27724
|
requestBody: {
|
|
27505
27725
|
content: {
|
|
@@ -27507,16 +27727,27 @@ var openapi_default = {
|
|
|
27507
27727
|
schema: {
|
|
27508
27728
|
properties: {
|
|
27509
27729
|
connect_webview_ids: {
|
|
27730
|
+
description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.",
|
|
27510
27731
|
items: { type: "string" },
|
|
27511
27732
|
type: "array"
|
|
27512
27733
|
},
|
|
27513
27734
|
connected_account_ids: {
|
|
27735
|
+
description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.",
|
|
27514
27736
|
items: { type: "string" },
|
|
27515
27737
|
type: "array"
|
|
27516
27738
|
},
|
|
27517
|
-
expires_at: {
|
|
27518
|
-
|
|
27739
|
+
expires_at: {
|
|
27740
|
+
description: "Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
27741
|
+
format: "date-time",
|
|
27742
|
+
type: "string"
|
|
27743
|
+
},
|
|
27744
|
+
user_identifier_key: {
|
|
27745
|
+
description: "Your user ID for the user for whom you want to create a client session.",
|
|
27746
|
+
minLength: 1,
|
|
27747
|
+
type: "string"
|
|
27748
|
+
},
|
|
27519
27749
|
user_identity_ids: {
|
|
27750
|
+
description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.",
|
|
27520
27751
|
items: { type: "string" },
|
|
27521
27752
|
type: "array"
|
|
27522
27753
|
}
|
|
@@ -27556,18 +27787,24 @@ var openapi_default = {
|
|
|
27556
27787
|
summary: "/client_sessions/create",
|
|
27557
27788
|
tags: ["/client_sessions"],
|
|
27558
27789
|
"x-fern-ignore": true,
|
|
27559
|
-
"x-response-key": "client_session"
|
|
27790
|
+
"x-response-key": "client_session",
|
|
27791
|
+
"x-title": "Create a Client Session"
|
|
27560
27792
|
}
|
|
27561
27793
|
},
|
|
27562
27794
|
"/client_sessions/delete": {
|
|
27563
27795
|
post: {
|
|
27796
|
+
description: "Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
|
|
27564
27797
|
operationId: "clientSessionsDeletePost",
|
|
27565
27798
|
requestBody: {
|
|
27566
27799
|
content: {
|
|
27567
27800
|
"application/json": {
|
|
27568
27801
|
schema: {
|
|
27569
27802
|
properties: {
|
|
27570
|
-
client_session_id: {
|
|
27803
|
+
client_session_id: {
|
|
27804
|
+
description: "ID of the client session that you want to delete.",
|
|
27805
|
+
format: "uuid",
|
|
27806
|
+
type: "string"
|
|
27807
|
+
}
|
|
27571
27808
|
},
|
|
27572
27809
|
required: ["client_session_id"],
|
|
27573
27810
|
type: "object"
|
|
@@ -27600,19 +27837,27 @@ var openapi_default = {
|
|
|
27600
27837
|
tags: ["/client_sessions"],
|
|
27601
27838
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27602
27839
|
"x-fern-sdk-method-name": "delete",
|
|
27603
|
-
"x-response-key": null
|
|
27840
|
+
"x-response-key": null,
|
|
27841
|
+
"x-title": "Delete a Client Session"
|
|
27604
27842
|
}
|
|
27605
27843
|
},
|
|
27606
27844
|
"/client_sessions/get": {
|
|
27607
27845
|
post: {
|
|
27846
|
+
description: "Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
|
|
27608
27847
|
operationId: "clientSessionsGetPost",
|
|
27609
27848
|
requestBody: {
|
|
27610
27849
|
content: {
|
|
27611
27850
|
"application/json": {
|
|
27612
27851
|
schema: {
|
|
27613
27852
|
properties: {
|
|
27614
|
-
client_session_id: {
|
|
27615
|
-
|
|
27853
|
+
client_session_id: {
|
|
27854
|
+
description: "ID of the client session that you want to get.",
|
|
27855
|
+
type: "string"
|
|
27856
|
+
},
|
|
27857
|
+
user_identifier_key: {
|
|
27858
|
+
description: "User identifier key associated with the client session that you want to get.",
|
|
27859
|
+
type: "string"
|
|
27860
|
+
}
|
|
27616
27861
|
},
|
|
27617
27862
|
type: "object"
|
|
27618
27863
|
}
|
|
@@ -27651,11 +27896,13 @@ var openapi_default = {
|
|
|
27651
27896
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27652
27897
|
"x-fern-sdk-method-name": "get",
|
|
27653
27898
|
"x-fern-sdk-return-value": "client_session",
|
|
27654
|
-
"x-response-key": "client_session"
|
|
27899
|
+
"x-response-key": "client_session",
|
|
27900
|
+
"x-title": "Get a Client Session"
|
|
27655
27901
|
}
|
|
27656
27902
|
},
|
|
27657
27903
|
"/client_sessions/get_or_create": {
|
|
27658
27904
|
post: {
|
|
27905
|
+
description: "Returns a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.",
|
|
27659
27906
|
operationId: "clientSessionsGetOrCreatePost",
|
|
27660
27907
|
requestBody: {
|
|
27661
27908
|
content: {
|
|
@@ -27663,16 +27910,27 @@ var openapi_default = {
|
|
|
27663
27910
|
schema: {
|
|
27664
27911
|
properties: {
|
|
27665
27912
|
connect_webview_ids: {
|
|
27913
|
+
description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).",
|
|
27666
27914
|
items: { type: "string" },
|
|
27667
27915
|
type: "array"
|
|
27668
27916
|
},
|
|
27669
27917
|
connected_account_ids: {
|
|
27918
|
+
description: "IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session).",
|
|
27670
27919
|
items: { type: "string" },
|
|
27671
27920
|
type: "array"
|
|
27672
27921
|
},
|
|
27673
|
-
expires_at: {
|
|
27674
|
-
|
|
27922
|
+
expires_at: {
|
|
27923
|
+
description: "Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
27924
|
+
format: "date-time",
|
|
27925
|
+
type: "string"
|
|
27926
|
+
},
|
|
27927
|
+
user_identifier_key: {
|
|
27928
|
+
description: "Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).",
|
|
27929
|
+
minLength: 1,
|
|
27930
|
+
type: "string"
|
|
27931
|
+
},
|
|
27675
27932
|
user_identity_ids: {
|
|
27933
|
+
description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).",
|
|
27676
27934
|
items: { type: "string" },
|
|
27677
27935
|
type: "array"
|
|
27678
27936
|
}
|
|
@@ -27714,28 +27972,39 @@ var openapi_default = {
|
|
|
27714
27972
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27715
27973
|
"x-fern-sdk-method-name": "get_or_create",
|
|
27716
27974
|
"x-fern-sdk-return-value": "client_session",
|
|
27717
|
-
"x-response-key": "client_session"
|
|
27975
|
+
"x-response-key": "client_session",
|
|
27976
|
+
"x-title": "Get or Create a Client Session"
|
|
27718
27977
|
}
|
|
27719
27978
|
},
|
|
27720
27979
|
"/client_sessions/grant_access": {
|
|
27721
27980
|
patch: {
|
|
27981
|
+
description: "Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.",
|
|
27722
27982
|
operationId: "clientSessionsGrantAccessPatch",
|
|
27723
27983
|
requestBody: {
|
|
27724
27984
|
content: {
|
|
27725
27985
|
"application/json": {
|
|
27726
27986
|
schema: {
|
|
27727
27987
|
properties: {
|
|
27728
|
-
client_session_id: {
|
|
27988
|
+
client_session_id: {
|
|
27989
|
+
description: "ID of the client session to which you want to grant access to resources.",
|
|
27990
|
+
type: "string"
|
|
27991
|
+
},
|
|
27729
27992
|
connect_webview_ids: {
|
|
27993
|
+
description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.",
|
|
27730
27994
|
items: { type: "string" },
|
|
27731
27995
|
type: "array"
|
|
27732
27996
|
},
|
|
27733
27997
|
connected_account_ids: {
|
|
27998
|
+
description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.",
|
|
27734
27999
|
items: { type: "string" },
|
|
27735
28000
|
type: "array"
|
|
27736
28001
|
},
|
|
27737
|
-
user_identifier_key: {
|
|
28002
|
+
user_identifier_key: {
|
|
28003
|
+
description: "Your user ID for the user that you want to associate with the client session.",
|
|
28004
|
+
type: "string"
|
|
28005
|
+
},
|
|
27738
28006
|
user_identity_ids: {
|
|
28007
|
+
description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
|
|
27739
28008
|
items: { type: "string" },
|
|
27740
28009
|
type: "array"
|
|
27741
28010
|
}
|
|
@@ -27774,26 +28043,37 @@ var openapi_default = {
|
|
|
27774
28043
|
summary: "/client_sessions/grant_access",
|
|
27775
28044
|
tags: ["/client_sessions"],
|
|
27776
28045
|
"x-fern-ignore": true,
|
|
27777
|
-
"x-response-key": null
|
|
28046
|
+
"x-response-key": null,
|
|
28047
|
+
"x-title": "Grant Access to a Client Session"
|
|
27778
28048
|
},
|
|
27779
28049
|
post: {
|
|
28050
|
+
description: "Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.",
|
|
27780
28051
|
operationId: "clientSessionsGrantAccessPost",
|
|
27781
28052
|
requestBody: {
|
|
27782
28053
|
content: {
|
|
27783
28054
|
"application/json": {
|
|
27784
28055
|
schema: {
|
|
27785
28056
|
properties: {
|
|
27786
|
-
client_session_id: {
|
|
28057
|
+
client_session_id: {
|
|
28058
|
+
description: "ID of the client session to which you want to grant access to resources.",
|
|
28059
|
+
type: "string"
|
|
28060
|
+
},
|
|
27787
28061
|
connect_webview_ids: {
|
|
28062
|
+
description: "IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.",
|
|
27788
28063
|
items: { type: "string" },
|
|
27789
28064
|
type: "array"
|
|
27790
28065
|
},
|
|
27791
28066
|
connected_account_ids: {
|
|
28067
|
+
description: "IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.",
|
|
27792
28068
|
items: { type: "string" },
|
|
27793
28069
|
type: "array"
|
|
27794
28070
|
},
|
|
27795
|
-
user_identifier_key: {
|
|
28071
|
+
user_identifier_key: {
|
|
28072
|
+
description: "Your user ID for the user that you want to associate with the client session.",
|
|
28073
|
+
type: "string"
|
|
28074
|
+
},
|
|
27796
28075
|
user_identity_ids: {
|
|
28076
|
+
description: "IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.",
|
|
27797
28077
|
items: { type: "string" },
|
|
27798
28078
|
type: "array"
|
|
27799
28079
|
}
|
|
@@ -27833,22 +28113,39 @@ var openapi_default = {
|
|
|
27833
28113
|
tags: ["/client_sessions"],
|
|
27834
28114
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27835
28115
|
"x-fern-sdk-method-name": "grant_access",
|
|
27836
|
-
"x-response-key": null
|
|
28116
|
+
"x-response-key": null,
|
|
28117
|
+
"x-title": "Grant Access to a Client Session"
|
|
27837
28118
|
}
|
|
27838
28119
|
},
|
|
27839
28120
|
"/client_sessions/list": {
|
|
27840
28121
|
post: {
|
|
28122
|
+
description: "Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).",
|
|
27841
28123
|
operationId: "clientSessionsListPost",
|
|
27842
28124
|
requestBody: {
|
|
27843
28125
|
content: {
|
|
27844
28126
|
"application/json": {
|
|
27845
28127
|
schema: {
|
|
27846
28128
|
properties: {
|
|
27847
|
-
client_session_id: {
|
|
27848
|
-
|
|
27849
|
-
|
|
27850
|
-
|
|
27851
|
-
|
|
28129
|
+
client_session_id: {
|
|
28130
|
+
description: "ID of the client session that you want to retrieve.",
|
|
28131
|
+
type: "string"
|
|
28132
|
+
},
|
|
28133
|
+
connect_webview_id: {
|
|
28134
|
+
description: "ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.",
|
|
28135
|
+
type: "string"
|
|
28136
|
+
},
|
|
28137
|
+
user_identifier_key: {
|
|
28138
|
+
description: "Your user ID for the user by which you want to filter client sessions.",
|
|
28139
|
+
type: "string"
|
|
28140
|
+
},
|
|
28141
|
+
user_identity_id: {
|
|
28142
|
+
description: "ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.",
|
|
28143
|
+
type: "string"
|
|
28144
|
+
},
|
|
28145
|
+
without_user_identifier_key: {
|
|
28146
|
+
description: "Indicates whether to retrieve only client sessions without associated user identifier keys.",
|
|
28147
|
+
type: "boolean"
|
|
28148
|
+
}
|
|
27852
28149
|
},
|
|
27853
28150
|
type: "object"
|
|
27854
28151
|
}
|
|
@@ -27887,18 +28184,24 @@ var openapi_default = {
|
|
|
27887
28184
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27888
28185
|
"x-fern-sdk-method-name": "list",
|
|
27889
28186
|
"x-fern-sdk-return-value": "client_sessions",
|
|
27890
|
-
"x-response-key": "client_sessions"
|
|
28187
|
+
"x-response-key": "client_sessions",
|
|
28188
|
+
"x-title": "List Client Sessions"
|
|
27891
28189
|
}
|
|
27892
28190
|
},
|
|
27893
28191
|
"/client_sessions/revoke": {
|
|
27894
28192
|
post: {
|
|
28193
|
+
description: "Revokes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).\n\nNote that [deleting a client session](https://docs.seam.co/latest/api/client_sessions/delete) is a separate action.",
|
|
27895
28194
|
operationId: "clientSessionsRevokePost",
|
|
27896
28195
|
requestBody: {
|
|
27897
28196
|
content: {
|
|
27898
28197
|
"application/json": {
|
|
27899
28198
|
schema: {
|
|
27900
28199
|
properties: {
|
|
27901
|
-
client_session_id: {
|
|
28200
|
+
client_session_id: {
|
|
28201
|
+
description: "ID of the client session that you want to revoke.",
|
|
28202
|
+
format: "uuid",
|
|
28203
|
+
type: "string"
|
|
28204
|
+
}
|
|
27902
28205
|
},
|
|
27903
28206
|
required: ["client_session_id"],
|
|
27904
28207
|
type: "object"
|
|
@@ -27931,11 +28234,13 @@ var openapi_default = {
|
|
|
27931
28234
|
tags: ["/client_sessions"],
|
|
27932
28235
|
"x-fern-sdk-group-name": ["client_sessions"],
|
|
27933
28236
|
"x-fern-sdk-method-name": "revoke",
|
|
27934
|
-
"x-response-key": null
|
|
28237
|
+
"x-response-key": null,
|
|
28238
|
+
"x-title": "Revoke a Client Session"
|
|
27935
28239
|
}
|
|
27936
28240
|
},
|
|
27937
28241
|
"/connect_webviews/create": {
|
|
27938
28242
|
post: {
|
|
28243
|
+
description: "Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).",
|
|
27939
28244
|
operationId: "connectWebviewsCreatePost",
|
|
27940
28245
|
requestBody: {
|
|
27941
28246
|
content: {
|
|
@@ -27943,6 +28248,7 @@ var openapi_default = {
|
|
|
27943
28248
|
schema: {
|
|
27944
28249
|
properties: {
|
|
27945
28250
|
accepted_providers: {
|
|
28251
|
+
description: "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.",
|
|
27946
28252
|
items: {
|
|
27947
28253
|
enum: [
|
|
27948
28254
|
"dormakaba_community",
|
|
@@ -28002,6 +28308,7 @@ var openapi_default = {
|
|
|
28002
28308
|
},
|
|
28003
28309
|
automatically_manage_new_devices: {
|
|
28004
28310
|
default: true,
|
|
28311
|
+
description: "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).",
|
|
28005
28312
|
type: "boolean"
|
|
28006
28313
|
},
|
|
28007
28314
|
custom_metadata: {
|
|
@@ -28012,15 +28319,24 @@ var openapi_default = {
|
|
|
28012
28319
|
{ type: "boolean" }
|
|
28013
28320
|
]
|
|
28014
28321
|
},
|
|
28322
|
+
description: "Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).",
|
|
28015
28323
|
type: "object"
|
|
28016
28324
|
},
|
|
28017
|
-
custom_redirect_failure_url: {
|
|
28018
|
-
|
|
28325
|
+
custom_redirect_failure_url: {
|
|
28326
|
+
description: "Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.",
|
|
28327
|
+
type: "string"
|
|
28328
|
+
},
|
|
28329
|
+
custom_redirect_url: {
|
|
28330
|
+
description: "URL that you want to redirect the user to after the provider login is complete.",
|
|
28331
|
+
type: "string"
|
|
28332
|
+
},
|
|
28019
28333
|
device_selection_mode: {
|
|
28020
28334
|
enum: ["none", "single", "multiple"],
|
|
28021
|
-
type: "string"
|
|
28335
|
+
type: "string",
|
|
28336
|
+
"x-undocumented": "Not supported."
|
|
28022
28337
|
},
|
|
28023
28338
|
provider_category: {
|
|
28339
|
+
description: "Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter.",
|
|
28024
28340
|
enum: [
|
|
28025
28341
|
"stable",
|
|
28026
28342
|
"consumer_smartlocks",
|
|
@@ -28031,7 +28347,11 @@ var openapi_default = {
|
|
|
28031
28347
|
],
|
|
28032
28348
|
type: "string"
|
|
28033
28349
|
},
|
|
28034
|
-
wait_for_device_creation: {
|
|
28350
|
+
wait_for_device_creation: {
|
|
28351
|
+
default: false,
|
|
28352
|
+
description: "Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).",
|
|
28353
|
+
type: "boolean"
|
|
28354
|
+
}
|
|
28035
28355
|
},
|
|
28036
28356
|
type: "object"
|
|
28037
28357
|
}
|
|
@@ -28070,18 +28390,24 @@ var openapi_default = {
|
|
|
28070
28390
|
"x-fern-sdk-group-name": ["connect_webviews"],
|
|
28071
28391
|
"x-fern-sdk-method-name": "create",
|
|
28072
28392
|
"x-fern-sdk-return-value": "connect_webview",
|
|
28073
|
-
"x-response-key": "connect_webview"
|
|
28393
|
+
"x-response-key": "connect_webview",
|
|
28394
|
+
"x-title": "Create a Connect Webview"
|
|
28074
28395
|
}
|
|
28075
28396
|
},
|
|
28076
28397
|
"/connect_webviews/delete": {
|
|
28077
28398
|
post: {
|
|
28399
|
+
description: "Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.",
|
|
28078
28400
|
operationId: "connectWebviewsDeletePost",
|
|
28079
28401
|
requestBody: {
|
|
28080
28402
|
content: {
|
|
28081
28403
|
"application/json": {
|
|
28082
28404
|
schema: {
|
|
28083
28405
|
properties: {
|
|
28084
|
-
connect_webview_id: {
|
|
28406
|
+
connect_webview_id: {
|
|
28407
|
+
description: "ID of the Connect Webview that you want to delete.",
|
|
28408
|
+
format: "uuid",
|
|
28409
|
+
type: "string"
|
|
28410
|
+
}
|
|
28085
28411
|
},
|
|
28086
28412
|
required: ["connect_webview_id"],
|
|
28087
28413
|
type: "object"
|
|
@@ -28114,18 +28440,24 @@ var openapi_default = {
|
|
|
28114
28440
|
tags: ["/connect_webviews"],
|
|
28115
28441
|
"x-fern-sdk-group-name": ["connect_webviews"],
|
|
28116
28442
|
"x-fern-sdk-method-name": "delete",
|
|
28117
|
-
"x-response-key": null
|
|
28443
|
+
"x-response-key": null,
|
|
28444
|
+
"x-title": "Delete a Connect Webview"
|
|
28118
28445
|
}
|
|
28119
28446
|
},
|
|
28120
28447
|
"/connect_webviews/get": {
|
|
28121
28448
|
post: {
|
|
28449
|
+
description: "Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.",
|
|
28122
28450
|
operationId: "connectWebviewsGetPost",
|
|
28123
28451
|
requestBody: {
|
|
28124
28452
|
content: {
|
|
28125
28453
|
"application/json": {
|
|
28126
28454
|
schema: {
|
|
28127
28455
|
properties: {
|
|
28128
|
-
connect_webview_id: {
|
|
28456
|
+
connect_webview_id: {
|
|
28457
|
+
description: "ID of the Connect Webview that you want to get.",
|
|
28458
|
+
format: "uuid",
|
|
28459
|
+
type: "string"
|
|
28460
|
+
}
|
|
28129
28461
|
},
|
|
28130
28462
|
required: ["connect_webview_id"],
|
|
28131
28463
|
type: "object"
|
|
@@ -28165,11 +28497,13 @@ var openapi_default = {
|
|
|
28165
28497
|
"x-fern-sdk-group-name": ["connect_webviews"],
|
|
28166
28498
|
"x-fern-sdk-method-name": "get",
|
|
28167
28499
|
"x-fern-sdk-return-value": "connect_webview",
|
|
28168
|
-
"x-response-key": "connect_webview"
|
|
28500
|
+
"x-response-key": "connect_webview",
|
|
28501
|
+
"x-title": "Get a Connect Webview"
|
|
28169
28502
|
}
|
|
28170
28503
|
},
|
|
28171
28504
|
"/connect_webviews/list": {
|
|
28172
28505
|
post: {
|
|
28506
|
+
description: "Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).",
|
|
28173
28507
|
operationId: "connectWebviewsListPost",
|
|
28174
28508
|
requestBody: {
|
|
28175
28509
|
content: {
|
|
@@ -28180,12 +28514,17 @@ var openapi_default = {
|
|
|
28180
28514
|
additionalProperties: {
|
|
28181
28515
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
28182
28516
|
},
|
|
28183
|
-
description: "
|
|
28517
|
+
description: "Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.",
|
|
28184
28518
|
type: "object"
|
|
28185
28519
|
},
|
|
28186
|
-
limit: {
|
|
28520
|
+
limit: {
|
|
28521
|
+
default: 500,
|
|
28522
|
+
description: "Maximum number of records to return per page.",
|
|
28523
|
+
format: "float",
|
|
28524
|
+
type: "number"
|
|
28525
|
+
},
|
|
28187
28526
|
user_identifier_key: {
|
|
28188
|
-
description: "
|
|
28527
|
+
description: "Your user ID for the user by which you want to filter Connect Webviews.",
|
|
28189
28528
|
type: "string"
|
|
28190
28529
|
}
|
|
28191
28530
|
},
|
|
@@ -28227,19 +28566,29 @@ var openapi_default = {
|
|
|
28227
28566
|
"x-fern-sdk-group-name": ["connect_webviews"],
|
|
28228
28567
|
"x-fern-sdk-method-name": "list",
|
|
28229
28568
|
"x-fern-sdk-return-value": "connect_webviews",
|
|
28230
|
-
"x-response-key": "connect_webviews"
|
|
28569
|
+
"x-response-key": "connect_webviews",
|
|
28570
|
+
"x-title": "List Connect Webviews"
|
|
28231
28571
|
}
|
|
28232
28572
|
},
|
|
28233
28573
|
"/connected_accounts/delete": {
|
|
28234
28574
|
post: {
|
|
28575
|
+
description: "Deletes a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.",
|
|
28235
28576
|
operationId: "connectedAccountsDeletePost",
|
|
28236
28577
|
requestBody: {
|
|
28237
28578
|
content: {
|
|
28238
28579
|
"application/json": {
|
|
28239
28580
|
schema: {
|
|
28240
28581
|
properties: {
|
|
28241
|
-
connected_account_id: {
|
|
28242
|
-
|
|
28582
|
+
connected_account_id: {
|
|
28583
|
+
description: "ID of the connected account that you want to delete.",
|
|
28584
|
+
format: "uuid",
|
|
28585
|
+
type: "string"
|
|
28586
|
+
},
|
|
28587
|
+
sync: {
|
|
28588
|
+
default: false,
|
|
28589
|
+
type: "boolean",
|
|
28590
|
+
"x-undocumented": "Only used internally."
|
|
28591
|
+
}
|
|
28243
28592
|
},
|
|
28244
28593
|
required: ["connected_account_id"],
|
|
28245
28594
|
type: "object"
|
|
@@ -28278,6 +28627,7 @@ var openapi_default = {
|
|
|
28278
28627
|
},
|
|
28279
28628
|
"/connected_accounts/get": {
|
|
28280
28629
|
post: {
|
|
28630
|
+
description: "Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
28281
28631
|
operationId: "connectedAccountsGetPost",
|
|
28282
28632
|
requestBody: {
|
|
28283
28633
|
content: {
|
|
@@ -28286,13 +28636,23 @@ var openapi_default = {
|
|
|
28286
28636
|
oneOf: [
|
|
28287
28637
|
{
|
|
28288
28638
|
properties: {
|
|
28289
|
-
connected_account_id: {
|
|
28639
|
+
connected_account_id: {
|
|
28640
|
+
description: "ID of the connected account that you want to get.",
|
|
28641
|
+
format: "uuid",
|
|
28642
|
+
type: "string"
|
|
28643
|
+
}
|
|
28290
28644
|
},
|
|
28291
28645
|
required: ["connected_account_id"],
|
|
28292
28646
|
type: "object"
|
|
28293
28647
|
},
|
|
28294
28648
|
{
|
|
28295
|
-
properties: {
|
|
28649
|
+
properties: {
|
|
28650
|
+
email: {
|
|
28651
|
+
description: "Email address associated with the connected account that you want to get.",
|
|
28652
|
+
format: "email",
|
|
28653
|
+
type: "string"
|
|
28654
|
+
}
|
|
28655
|
+
},
|
|
28296
28656
|
required: ["email"],
|
|
28297
28657
|
type: "object"
|
|
28298
28658
|
}
|
|
@@ -28339,6 +28699,7 @@ var openapi_default = {
|
|
|
28339
28699
|
},
|
|
28340
28700
|
"/connected_accounts/list": {
|
|
28341
28701
|
post: {
|
|
28702
|
+
description: "Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
28342
28703
|
operationId: "connectedAccountsListPost",
|
|
28343
28704
|
requestBody: {
|
|
28344
28705
|
content: {
|
|
@@ -28349,7 +28710,7 @@ var openapi_default = {
|
|
|
28349
28710
|
additionalProperties: {
|
|
28350
28711
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
28351
28712
|
},
|
|
28352
|
-
description: "Returns accounts
|
|
28713
|
+
description: "Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.",
|
|
28353
28714
|
type: "object"
|
|
28354
28715
|
},
|
|
28355
28716
|
customer_ids: {
|
|
@@ -28369,7 +28730,7 @@ var openapi_default = {
|
|
|
28369
28730
|
type: "string"
|
|
28370
28731
|
},
|
|
28371
28732
|
user_identifier_key: {
|
|
28372
|
-
description: "
|
|
28733
|
+
description: "Your user ID for the user by which you want to filter connected accounts.",
|
|
28373
28734
|
type: "string"
|
|
28374
28735
|
}
|
|
28375
28736
|
},
|
|
@@ -28417,14 +28778,22 @@ var openapi_default = {
|
|
|
28417
28778
|
},
|
|
28418
28779
|
"/connected_accounts/update": {
|
|
28419
28780
|
post: {
|
|
28781
|
+
description: "Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).",
|
|
28420
28782
|
operationId: "connectedAccountsUpdatePost",
|
|
28421
28783
|
requestBody: {
|
|
28422
28784
|
content: {
|
|
28423
28785
|
"application/json": {
|
|
28424
28786
|
schema: {
|
|
28425
28787
|
properties: {
|
|
28426
|
-
automatically_manage_new_devices: {
|
|
28427
|
-
|
|
28788
|
+
automatically_manage_new_devices: {
|
|
28789
|
+
description: "Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
|
|
28790
|
+
type: "boolean"
|
|
28791
|
+
},
|
|
28792
|
+
connected_account_id: {
|
|
28793
|
+
description: "ID of the connected account that you want to update.",
|
|
28794
|
+
format: "uuid",
|
|
28795
|
+
type: "string"
|
|
28796
|
+
},
|
|
28428
28797
|
custom_metadata: {
|
|
28429
28798
|
additionalProperties: {
|
|
28430
28799
|
nullable: true,
|
|
@@ -28433,6 +28802,7 @@ var openapi_default = {
|
|
|
28433
28802
|
{ type: "boolean" }
|
|
28434
28803
|
]
|
|
28435
28804
|
},
|
|
28805
|
+
description: "Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).",
|
|
28436
28806
|
type: "object"
|
|
28437
28807
|
}
|
|
28438
28808
|
},
|
|
@@ -28478,12 +28848,19 @@ var openapi_default = {
|
|
|
28478
28848
|
},
|
|
28479
28849
|
"/devices/delete": {
|
|
28480
28850
|
post: {
|
|
28851
|
+
description: "Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).",
|
|
28481
28852
|
operationId: "devicesDeletePost",
|
|
28482
28853
|
requestBody: {
|
|
28483
28854
|
content: {
|
|
28484
28855
|
"application/json": {
|
|
28485
28856
|
schema: {
|
|
28486
|
-
properties: {
|
|
28857
|
+
properties: {
|
|
28858
|
+
device_id: {
|
|
28859
|
+
description: "ID of the device that you want to delete.",
|
|
28860
|
+
format: "uuid",
|
|
28861
|
+
type: "string"
|
|
28862
|
+
}
|
|
28863
|
+
},
|
|
28487
28864
|
required: ["device_id"],
|
|
28488
28865
|
type: "object"
|
|
28489
28866
|
}
|
|
@@ -28517,19 +28894,28 @@ var openapi_default = {
|
|
|
28517
28894
|
"x-fern-sdk-group-name": ["devices"],
|
|
28518
28895
|
"x-fern-sdk-method-name": "delete",
|
|
28519
28896
|
"x-response-key": null,
|
|
28897
|
+
"x-title": "Delete a Device",
|
|
28520
28898
|
"x-undocumented": "Deleting a device is no longer supported and will be removed."
|
|
28521
28899
|
}
|
|
28522
28900
|
},
|
|
28523
28901
|
"/devices/get": {
|
|
28524
28902
|
post: {
|
|
28903
|
+
description: "Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.",
|
|
28525
28904
|
operationId: "devicesGetPost",
|
|
28526
28905
|
requestBody: {
|
|
28527
28906
|
content: {
|
|
28528
28907
|
"application/json": {
|
|
28529
28908
|
schema: {
|
|
28530
28909
|
properties: {
|
|
28531
|
-
device_id: {
|
|
28532
|
-
|
|
28910
|
+
device_id: {
|
|
28911
|
+
description: "ID of the device that you want to get.",
|
|
28912
|
+
format: "uuid",
|
|
28913
|
+
type: "string"
|
|
28914
|
+
},
|
|
28915
|
+
name: {
|
|
28916
|
+
description: "Name of the device that you want to get.",
|
|
28917
|
+
type: "string"
|
|
28918
|
+
}
|
|
28533
28919
|
},
|
|
28534
28920
|
type: "object"
|
|
28535
28921
|
}
|
|
@@ -28566,7 +28952,8 @@ var openapi_default = {
|
|
|
28566
28952
|
"x-fern-sdk-group-name": ["devices"],
|
|
28567
28953
|
"x-fern-sdk-method-name": "get",
|
|
28568
28954
|
"x-fern-sdk-return-value": "device",
|
|
28569
|
-
"x-response-key": "device"
|
|
28955
|
+
"x-response-key": "device",
|
|
28956
|
+
"x-title": "Get a Device"
|
|
28570
28957
|
}
|
|
28571
28958
|
},
|
|
28572
28959
|
"/devices/list": {
|
|
@@ -28579,22 +28966,22 @@ var openapi_default = {
|
|
|
28579
28966
|
schema: {
|
|
28580
28967
|
properties: {
|
|
28581
28968
|
connect_webview_id: {
|
|
28582
|
-
description: "ID of the Connect Webview
|
|
28969
|
+
description: "ID of the Connect Webview for which you want to list devices.",
|
|
28583
28970
|
format: "uuid",
|
|
28584
28971
|
type: "string"
|
|
28585
28972
|
},
|
|
28586
28973
|
connected_account_id: {
|
|
28587
|
-
description: "ID of the connected account
|
|
28974
|
+
description: "ID of the connected account for which you want to list devices.",
|
|
28588
28975
|
format: "uuid",
|
|
28589
28976
|
type: "string"
|
|
28590
28977
|
},
|
|
28591
28978
|
connected_account_ids: {
|
|
28592
|
-
description: "Array of IDs of the connected accounts
|
|
28979
|
+
description: "Array of IDs of the connected accounts for which you want to list devices.",
|
|
28593
28980
|
items: { format: "uuid", type: "string" },
|
|
28594
28981
|
type: "array"
|
|
28595
28982
|
},
|
|
28596
28983
|
created_before: {
|
|
28597
|
-
description: "
|
|
28984
|
+
description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
|
|
28598
28985
|
format: "date-time",
|
|
28599
28986
|
type: "string"
|
|
28600
28987
|
},
|
|
@@ -28602,7 +28989,7 @@ var openapi_default = {
|
|
|
28602
28989
|
additionalProperties: {
|
|
28603
28990
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
28604
28991
|
},
|
|
28605
|
-
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
28992
|
+
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
|
|
28606
28993
|
type: "object"
|
|
28607
28994
|
},
|
|
28608
28995
|
customer_ids: {
|
|
@@ -28610,12 +28997,12 @@ var openapi_default = {
|
|
|
28610
28997
|
type: "array"
|
|
28611
28998
|
},
|
|
28612
28999
|
device_ids: {
|
|
28613
|
-
description: "Array of device IDs
|
|
29000
|
+
description: "Array of device IDs for which you want to list devices.",
|
|
28614
29001
|
items: { format: "uuid", type: "string" },
|
|
28615
29002
|
type: "array"
|
|
28616
29003
|
},
|
|
28617
29004
|
device_type: {
|
|
28618
|
-
description: "Device type
|
|
29005
|
+
description: "Device type for which you want to list devices.",
|
|
28619
29006
|
oneOf: [
|
|
28620
29007
|
{
|
|
28621
29008
|
enum: [
|
|
@@ -28672,7 +29059,7 @@ var openapi_default = {
|
|
|
28672
29059
|
]
|
|
28673
29060
|
},
|
|
28674
29061
|
device_types: {
|
|
28675
|
-
description: "Array of device types
|
|
29062
|
+
description: "Array of device types for which you want to list devices.",
|
|
28676
29063
|
items: {
|
|
28677
29064
|
oneOf: [
|
|
28678
29065
|
{
|
|
@@ -28778,7 +29165,7 @@ var openapi_default = {
|
|
|
28778
29165
|
type: "number"
|
|
28779
29166
|
},
|
|
28780
29167
|
manufacturer: {
|
|
28781
|
-
description: "Manufacturer
|
|
29168
|
+
description: "Manufacturer for which you want to list devices.",
|
|
28782
29169
|
enum: [
|
|
28783
29170
|
"akuvox",
|
|
28784
29171
|
"august",
|
|
@@ -28827,13 +29214,14 @@ var openapi_default = {
|
|
|
28827
29214
|
type: "string"
|
|
28828
29215
|
},
|
|
28829
29216
|
unstable_location_id: {
|
|
29217
|
+
description: "ID of the location for which you want to list devices.",
|
|
28830
29218
|
format: "uuid",
|
|
28831
29219
|
nullable: true,
|
|
28832
29220
|
type: "string",
|
|
28833
29221
|
"x-undocumented": "Experimental locations."
|
|
28834
29222
|
},
|
|
28835
29223
|
user_identifier_key: {
|
|
28836
|
-
description: "Your own internal user ID for the user
|
|
29224
|
+
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
28837
29225
|
type: "string"
|
|
28838
29226
|
}
|
|
28839
29227
|
},
|
|
@@ -28882,6 +29270,7 @@ var openapi_default = {
|
|
|
28882
29270
|
},
|
|
28883
29271
|
"/devices/list_device_providers": {
|
|
28884
29272
|
post: {
|
|
29273
|
+
description: "Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers\u2014that is, the brands\u2014that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).",
|
|
28885
29274
|
operationId: "devicesListDeviceProvidersPost",
|
|
28886
29275
|
requestBody: {
|
|
28887
29276
|
content: {
|
|
@@ -28889,6 +29278,7 @@ var openapi_default = {
|
|
|
28889
29278
|
schema: {
|
|
28890
29279
|
properties: {
|
|
28891
29280
|
provider_category: {
|
|
29281
|
+
description: "Category for which you want to list providers.",
|
|
28892
29282
|
enum: [
|
|
28893
29283
|
"stable",
|
|
28894
29284
|
"consumer_smartlocks",
|
|
@@ -28937,17 +29327,25 @@ var openapi_default = {
|
|
|
28937
29327
|
"x-fern-sdk-group-name": ["devices"],
|
|
28938
29328
|
"x-fern-sdk-method-name": "list_device_providers",
|
|
28939
29329
|
"x-fern-sdk-return-value": "device_providers",
|
|
28940
|
-
"x-response-key": "device_providers"
|
|
29330
|
+
"x-response-key": "device_providers",
|
|
29331
|
+
"x-title": "List Device Providers"
|
|
28941
29332
|
}
|
|
28942
29333
|
},
|
|
28943
29334
|
"/devices/simulate/connect": {
|
|
28944
29335
|
post: {
|
|
29336
|
+
description: "Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
|
|
28945
29337
|
operationId: "devicesSimulateConnectPost",
|
|
28946
29338
|
requestBody: {
|
|
28947
29339
|
content: {
|
|
28948
29340
|
"application/json": {
|
|
28949
29341
|
schema: {
|
|
28950
|
-
properties: {
|
|
29342
|
+
properties: {
|
|
29343
|
+
device_id: {
|
|
29344
|
+
description: "ID of the device that you want to simulate connecting to Seam.",
|
|
29345
|
+
format: "uuid",
|
|
29346
|
+
type: "string"
|
|
29347
|
+
}
|
|
29348
|
+
},
|
|
28951
29349
|
required: ["device_id"],
|
|
28952
29350
|
type: "object"
|
|
28953
29351
|
}
|
|
@@ -28979,17 +29377,25 @@ var openapi_default = {
|
|
|
28979
29377
|
tags: ["/devices"],
|
|
28980
29378
|
"x-fern-sdk-group-name": ["devices", "simulate"],
|
|
28981
29379
|
"x-fern-sdk-method-name": "connect",
|
|
28982
|
-
"x-response-key": null
|
|
29380
|
+
"x-response-key": null,
|
|
29381
|
+
"x-title": "Simulate Device Connection"
|
|
28983
29382
|
}
|
|
28984
29383
|
},
|
|
28985
29384
|
"/devices/simulate/disconnect": {
|
|
28986
29385
|
post: {
|
|
29386
|
+
description: "Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
|
|
28987
29387
|
operationId: "devicesSimulateDisconnectPost",
|
|
28988
29388
|
requestBody: {
|
|
28989
29389
|
content: {
|
|
28990
29390
|
"application/json": {
|
|
28991
29391
|
schema: {
|
|
28992
|
-
properties: {
|
|
29392
|
+
properties: {
|
|
29393
|
+
device_id: {
|
|
29394
|
+
description: "ID of the device that you want to simulate disconnecting from Seam.",
|
|
29395
|
+
format: "uuid",
|
|
29396
|
+
type: "string"
|
|
29397
|
+
}
|
|
29398
|
+
},
|
|
28993
29399
|
required: ["device_id"],
|
|
28994
29400
|
type: "object"
|
|
28995
29401
|
}
|
|
@@ -29021,17 +29427,25 @@ var openapi_default = {
|
|
|
29021
29427
|
tags: ["/devices"],
|
|
29022
29428
|
"x-fern-sdk-group-name": ["devices", "simulate"],
|
|
29023
29429
|
"x-fern-sdk-method-name": "disconnect",
|
|
29024
|
-
"x-response-key": null
|
|
29430
|
+
"x-response-key": null,
|
|
29431
|
+
"x-title": "Simulate Device Disconnection"
|
|
29025
29432
|
}
|
|
29026
29433
|
},
|
|
29027
29434
|
"/devices/simulate/remove": {
|
|
29028
29435
|
post: {
|
|
29436
|
+
description: "Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).",
|
|
29029
29437
|
operationId: "devicesSimulateRemovePost",
|
|
29030
29438
|
requestBody: {
|
|
29031
29439
|
content: {
|
|
29032
29440
|
"application/json": {
|
|
29033
29441
|
schema: {
|
|
29034
|
-
properties: {
|
|
29442
|
+
properties: {
|
|
29443
|
+
device_id: {
|
|
29444
|
+
description: "ID of the device that you want to simulate removing from Seam.",
|
|
29445
|
+
format: "uuid",
|
|
29446
|
+
type: "string"
|
|
29447
|
+
}
|
|
29448
|
+
},
|
|
29035
29449
|
required: ["device_id"],
|
|
29036
29450
|
type: "object"
|
|
29037
29451
|
}
|
|
@@ -29063,19 +29477,28 @@ var openapi_default = {
|
|
|
29063
29477
|
tags: ["/devices"],
|
|
29064
29478
|
"x-fern-sdk-group-name": ["devices", "simulate"],
|
|
29065
29479
|
"x-fern-sdk-method-name": "remove",
|
|
29066
|
-
"x-response-key": null
|
|
29480
|
+
"x-response-key": null,
|
|
29481
|
+
"x-title": "Simulate Device Removal"
|
|
29067
29482
|
}
|
|
29068
29483
|
},
|
|
29069
29484
|
"/devices/unmanaged/get": {
|
|
29070
29485
|
post: {
|
|
29486
|
+
description: "Returns a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.",
|
|
29071
29487
|
operationId: "devicesUnmanagedGetPost",
|
|
29072
29488
|
requestBody: {
|
|
29073
29489
|
content: {
|
|
29074
29490
|
"application/json": {
|
|
29075
29491
|
schema: {
|
|
29076
29492
|
properties: {
|
|
29077
|
-
device_id: {
|
|
29078
|
-
|
|
29493
|
+
device_id: {
|
|
29494
|
+
description: "ID of the unmanaged device that you want to get.",
|
|
29495
|
+
format: "uuid",
|
|
29496
|
+
type: "string"
|
|
29497
|
+
},
|
|
29498
|
+
name: {
|
|
29499
|
+
description: "Name of the unmanaged device that you want to get.",
|
|
29500
|
+
type: "string"
|
|
29501
|
+
}
|
|
29079
29502
|
},
|
|
29080
29503
|
type: "object"
|
|
29081
29504
|
}
|
|
@@ -29112,11 +29535,13 @@ var openapi_default = {
|
|
|
29112
29535
|
"x-fern-sdk-group-name": ["devices", "unmanaged"],
|
|
29113
29536
|
"x-fern-sdk-method-name": "get",
|
|
29114
29537
|
"x-fern-sdk-return-value": "device",
|
|
29115
|
-
"x-response-key": "device"
|
|
29538
|
+
"x-response-key": "device",
|
|
29539
|
+
"x-title": "Get an Unmanaged Device"
|
|
29116
29540
|
}
|
|
29117
29541
|
},
|
|
29118
29542
|
"/devices/unmanaged/list": {
|
|
29119
29543
|
post: {
|
|
29544
|
+
description: "Returns a list of all [unmanaged devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
|
|
29120
29545
|
operationId: "devicesUnmanagedListPost",
|
|
29121
29546
|
requestBody: {
|
|
29122
29547
|
content: {
|
|
@@ -29124,22 +29549,22 @@ var openapi_default = {
|
|
|
29124
29549
|
schema: {
|
|
29125
29550
|
properties: {
|
|
29126
29551
|
connect_webview_id: {
|
|
29127
|
-
description: "ID of the Connect Webview
|
|
29552
|
+
description: "ID of the Connect Webview for which you want to list devices.",
|
|
29128
29553
|
format: "uuid",
|
|
29129
29554
|
type: "string"
|
|
29130
29555
|
},
|
|
29131
29556
|
connected_account_id: {
|
|
29132
|
-
description: "ID of the connected account
|
|
29557
|
+
description: "ID of the connected account for which you want to list devices.",
|
|
29133
29558
|
format: "uuid",
|
|
29134
29559
|
type: "string"
|
|
29135
29560
|
},
|
|
29136
29561
|
connected_account_ids: {
|
|
29137
|
-
description: "Array of IDs of the connected accounts
|
|
29562
|
+
description: "Array of IDs of the connected accounts for which you want to list devices.",
|
|
29138
29563
|
items: { format: "uuid", type: "string" },
|
|
29139
29564
|
type: "array"
|
|
29140
29565
|
},
|
|
29141
29566
|
created_before: {
|
|
29142
|
-
description: "
|
|
29567
|
+
description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
|
|
29143
29568
|
format: "date-time",
|
|
29144
29569
|
type: "string"
|
|
29145
29570
|
},
|
|
@@ -29147,7 +29572,7 @@ var openapi_default = {
|
|
|
29147
29572
|
additionalProperties: {
|
|
29148
29573
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
29149
29574
|
},
|
|
29150
|
-
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
29575
|
+
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
|
|
29151
29576
|
type: "object"
|
|
29152
29577
|
},
|
|
29153
29578
|
customer_ids: {
|
|
@@ -29155,12 +29580,12 @@ var openapi_default = {
|
|
|
29155
29580
|
type: "array"
|
|
29156
29581
|
},
|
|
29157
29582
|
device_ids: {
|
|
29158
|
-
description: "Array of device IDs
|
|
29583
|
+
description: "Array of device IDs for which you want to list devices.",
|
|
29159
29584
|
items: { format: "uuid", type: "string" },
|
|
29160
29585
|
type: "array"
|
|
29161
29586
|
},
|
|
29162
29587
|
device_type: {
|
|
29163
|
-
description: "Device type
|
|
29588
|
+
description: "Device type for which you want to list devices.",
|
|
29164
29589
|
oneOf: [
|
|
29165
29590
|
{
|
|
29166
29591
|
enum: [
|
|
@@ -29217,7 +29642,7 @@ var openapi_default = {
|
|
|
29217
29642
|
]
|
|
29218
29643
|
},
|
|
29219
29644
|
device_types: {
|
|
29220
|
-
description: "Array of device types
|
|
29645
|
+
description: "Array of device types for which you want to list devices.",
|
|
29221
29646
|
items: {
|
|
29222
29647
|
oneOf: [
|
|
29223
29648
|
{
|
|
@@ -29323,7 +29748,7 @@ var openapi_default = {
|
|
|
29323
29748
|
type: "number"
|
|
29324
29749
|
},
|
|
29325
29750
|
manufacturer: {
|
|
29326
|
-
description: "Manufacturer
|
|
29751
|
+
description: "Manufacturer for which you want to list devices.",
|
|
29327
29752
|
enum: [
|
|
29328
29753
|
"akuvox",
|
|
29329
29754
|
"august",
|
|
@@ -29372,13 +29797,14 @@ var openapi_default = {
|
|
|
29372
29797
|
type: "string"
|
|
29373
29798
|
},
|
|
29374
29799
|
unstable_location_id: {
|
|
29800
|
+
description: "ID of the location for which you want to list devices.",
|
|
29375
29801
|
format: "uuid",
|
|
29376
29802
|
nullable: true,
|
|
29377
29803
|
type: "string",
|
|
29378
29804
|
"x-undocumented": "Experimental locations."
|
|
29379
29805
|
},
|
|
29380
29806
|
user_identifier_key: {
|
|
29381
|
-
description: "Your own internal user ID for the user
|
|
29807
|
+
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
29382
29808
|
type: "string"
|
|
29383
29809
|
}
|
|
29384
29810
|
},
|
|
@@ -29419,19 +29845,29 @@ var openapi_default = {
|
|
|
29419
29845
|
"x-fern-sdk-group-name": ["devices", "unmanaged"],
|
|
29420
29846
|
"x-fern-sdk-method-name": "list",
|
|
29421
29847
|
"x-fern-sdk-return-value": "devices",
|
|
29422
|
-
"x-response-key": "devices"
|
|
29848
|
+
"x-response-key": "devices",
|
|
29849
|
+
"x-title": "List Unmanaged Devices"
|
|
29423
29850
|
}
|
|
29424
29851
|
},
|
|
29425
29852
|
"/devices/unmanaged/update": {
|
|
29426
29853
|
patch: {
|
|
29854
|
+
description: "Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
|
|
29427
29855
|
operationId: "devicesUnmanagedUpdatePatch",
|
|
29428
29856
|
requestBody: {
|
|
29429
29857
|
content: {
|
|
29430
29858
|
"application/json": {
|
|
29431
29859
|
schema: {
|
|
29432
29860
|
properties: {
|
|
29433
|
-
device_id: {
|
|
29434
|
-
|
|
29861
|
+
device_id: {
|
|
29862
|
+
description: "ID of the unmanaged device that you want to update.",
|
|
29863
|
+
format: "uuid",
|
|
29864
|
+
type: "string"
|
|
29865
|
+
},
|
|
29866
|
+
is_managed: {
|
|
29867
|
+
description: "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.",
|
|
29868
|
+
enum: [true],
|
|
29869
|
+
type: "boolean"
|
|
29870
|
+
}
|
|
29435
29871
|
},
|
|
29436
29872
|
required: ["device_id", "is_managed"],
|
|
29437
29873
|
type: "object"
|
|
@@ -29463,17 +29899,27 @@ var openapi_default = {
|
|
|
29463
29899
|
summary: "/devices/unmanaged/update",
|
|
29464
29900
|
tags: ["/devices"],
|
|
29465
29901
|
"x-fern-ignore": true,
|
|
29466
|
-
"x-response-key": null
|
|
29902
|
+
"x-response-key": null,
|
|
29903
|
+
"x-title": "Update an Unmanaged Device"
|
|
29467
29904
|
},
|
|
29468
29905
|
post: {
|
|
29906
|
+
description: "Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).",
|
|
29469
29907
|
operationId: "devicesUnmanagedUpdatePost",
|
|
29470
29908
|
requestBody: {
|
|
29471
29909
|
content: {
|
|
29472
29910
|
"application/json": {
|
|
29473
29911
|
schema: {
|
|
29474
29912
|
properties: {
|
|
29475
|
-
device_id: {
|
|
29476
|
-
|
|
29913
|
+
device_id: {
|
|
29914
|
+
description: "ID of the unmanaged device that you want to update.",
|
|
29915
|
+
format: "uuid",
|
|
29916
|
+
type: "string"
|
|
29917
|
+
},
|
|
29918
|
+
is_managed: {
|
|
29919
|
+
description: "Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.",
|
|
29920
|
+
enum: [true],
|
|
29921
|
+
type: "boolean"
|
|
29922
|
+
}
|
|
29477
29923
|
},
|
|
29478
29924
|
required: ["device_id", "is_managed"],
|
|
29479
29925
|
type: "object"
|
|
@@ -29506,11 +29952,13 @@ var openapi_default = {
|
|
|
29506
29952
|
tags: ["/devices"],
|
|
29507
29953
|
"x-fern-sdk-group-name": ["devices", "unmanaged"],
|
|
29508
29954
|
"x-fern-sdk-method-name": "update",
|
|
29509
|
-
"x-response-key": null
|
|
29955
|
+
"x-response-key": null,
|
|
29956
|
+
"x-title": "Update an Unmanaged Device"
|
|
29510
29957
|
}
|
|
29511
29958
|
},
|
|
29512
29959
|
"/devices/update": {
|
|
29513
29960
|
patch: {
|
|
29961
|
+
description: "Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
|
|
29514
29962
|
operationId: "devicesUpdatePatch",
|
|
29515
29963
|
requestBody: {
|
|
29516
29964
|
content: {
|
|
@@ -29525,13 +29973,32 @@ var openapi_default = {
|
|
|
29525
29973
|
{ type: "boolean" }
|
|
29526
29974
|
]
|
|
29527
29975
|
},
|
|
29976
|
+
description: "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).",
|
|
29528
29977
|
type: "object"
|
|
29529
29978
|
},
|
|
29530
|
-
device_id: {
|
|
29531
|
-
|
|
29532
|
-
|
|
29979
|
+
device_id: {
|
|
29980
|
+
description: "ID of the device that you want to update.",
|
|
29981
|
+
format: "uuid",
|
|
29982
|
+
type: "string"
|
|
29983
|
+
},
|
|
29984
|
+
is_managed: {
|
|
29985
|
+
default: true,
|
|
29986
|
+
description: "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.",
|
|
29987
|
+
type: "boolean"
|
|
29988
|
+
},
|
|
29989
|
+
name: {
|
|
29990
|
+
description: "Name for the device.",
|
|
29991
|
+
nullable: true,
|
|
29992
|
+
type: "string"
|
|
29993
|
+
},
|
|
29533
29994
|
properties: {
|
|
29534
|
-
properties: {
|
|
29995
|
+
properties: {
|
|
29996
|
+
name: {
|
|
29997
|
+
description: "Name for the device.",
|
|
29998
|
+
nullable: true,
|
|
29999
|
+
type: "string"
|
|
30000
|
+
}
|
|
30001
|
+
},
|
|
29535
30002
|
type: "object"
|
|
29536
30003
|
}
|
|
29537
30004
|
},
|
|
@@ -29566,9 +30033,11 @@ var openapi_default = {
|
|
|
29566
30033
|
summary: "/devices/update",
|
|
29567
30034
|
tags: ["/devices"],
|
|
29568
30035
|
"x-fern-ignore": true,
|
|
29569
|
-
"x-response-key": null
|
|
30036
|
+
"x-response-key": null,
|
|
30037
|
+
"x-title": "Update a Device"
|
|
29570
30038
|
},
|
|
29571
30039
|
post: {
|
|
30040
|
+
description: "Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
|
|
29572
30041
|
operationId: "devicesUpdatePost",
|
|
29573
30042
|
requestBody: {
|
|
29574
30043
|
content: {
|
|
@@ -29583,13 +30052,32 @@ var openapi_default = {
|
|
|
29583
30052
|
{ type: "boolean" }
|
|
29584
30053
|
]
|
|
29585
30054
|
},
|
|
30055
|
+
description: "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).",
|
|
29586
30056
|
type: "object"
|
|
29587
30057
|
},
|
|
29588
|
-
device_id: {
|
|
29589
|
-
|
|
29590
|
-
|
|
30058
|
+
device_id: {
|
|
30059
|
+
description: "ID of the device that you want to update.",
|
|
30060
|
+
format: "uuid",
|
|
30061
|
+
type: "string"
|
|
30062
|
+
},
|
|
30063
|
+
is_managed: {
|
|
30064
|
+
default: true,
|
|
30065
|
+
description: "Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.",
|
|
30066
|
+
type: "boolean"
|
|
30067
|
+
},
|
|
30068
|
+
name: {
|
|
30069
|
+
description: "Name for the device.",
|
|
30070
|
+
nullable: true,
|
|
30071
|
+
type: "string"
|
|
30072
|
+
},
|
|
29591
30073
|
properties: {
|
|
29592
|
-
properties: {
|
|
30074
|
+
properties: {
|
|
30075
|
+
name: {
|
|
30076
|
+
description: "Name for the device.",
|
|
30077
|
+
nullable: true,
|
|
30078
|
+
type: "string"
|
|
30079
|
+
}
|
|
30080
|
+
},
|
|
29593
30081
|
type: "object"
|
|
29594
30082
|
}
|
|
29595
30083
|
},
|
|
@@ -29625,11 +30113,13 @@ var openapi_default = {
|
|
|
29625
30113
|
tags: ["/devices"],
|
|
29626
30114
|
"x-fern-sdk-group-name": ["devices"],
|
|
29627
30115
|
"x-fern-sdk-method-name": "update",
|
|
29628
|
-
"x-response-key": null
|
|
30116
|
+
"x-response-key": null,
|
|
30117
|
+
"x-title": "Update a Device"
|
|
29629
30118
|
}
|
|
29630
30119
|
},
|
|
29631
30120
|
"/events/get": {
|
|
29632
30121
|
post: {
|
|
30122
|
+
description: "Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to retrieve an event that already took place.",
|
|
29633
30123
|
operationId: "eventsGetPost",
|
|
29634
30124
|
requestBody: {
|
|
29635
30125
|
content: {
|
|
@@ -29676,11 +30166,13 @@ var openapi_default = {
|
|
|
29676
30166
|
"x-fern-sdk-group-name": ["events"],
|
|
29677
30167
|
"x-fern-sdk-method-name": "get",
|
|
29678
30168
|
"x-fern-sdk-return-value": "event",
|
|
29679
|
-
"x-response-key": "event"
|
|
30169
|
+
"x-response-key": "event",
|
|
30170
|
+
"x-title": "Get an Event"
|
|
29680
30171
|
}
|
|
29681
30172
|
},
|
|
29682
30173
|
"/events/list": {
|
|
29683
30174
|
post: {
|
|
30175
|
+
description: "Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.",
|
|
29684
30176
|
operationId: "eventsListPost",
|
|
29685
30177
|
requestBody: {
|
|
29686
30178
|
content: {
|
|
@@ -29954,7 +30446,8 @@ var openapi_default = {
|
|
|
29954
30446
|
"x-fern-sdk-group-name": ["events"],
|
|
29955
30447
|
"x-fern-sdk-method-name": "list",
|
|
29956
30448
|
"x-fern-sdk-return-value": "events",
|
|
29957
|
-
"x-response-key": "events"
|
|
30449
|
+
"x-response-key": "events",
|
|
30450
|
+
"x-title": "List Events"
|
|
29958
30451
|
}
|
|
29959
30452
|
},
|
|
29960
30453
|
"/locks/get": {
|
|
@@ -30017,22 +30510,22 @@ var openapi_default = {
|
|
|
30017
30510
|
schema: {
|
|
30018
30511
|
properties: {
|
|
30019
30512
|
connect_webview_id: {
|
|
30020
|
-
description: "ID of the Connect Webview
|
|
30513
|
+
description: "ID of the Connect Webview for which you want to list devices.",
|
|
30021
30514
|
format: "uuid",
|
|
30022
30515
|
type: "string"
|
|
30023
30516
|
},
|
|
30024
30517
|
connected_account_id: {
|
|
30025
|
-
description: "ID of the connected account
|
|
30518
|
+
description: "ID of the connected account for which you want to list devices.",
|
|
30026
30519
|
format: "uuid",
|
|
30027
30520
|
type: "string"
|
|
30028
30521
|
},
|
|
30029
30522
|
connected_account_ids: {
|
|
30030
|
-
description: "Array of IDs of the connected accounts
|
|
30523
|
+
description: "Array of IDs of the connected accounts for which you want to list devices.",
|
|
30031
30524
|
items: { format: "uuid", type: "string" },
|
|
30032
30525
|
type: "array"
|
|
30033
30526
|
},
|
|
30034
30527
|
created_before: {
|
|
30035
|
-
description: "
|
|
30528
|
+
description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
|
|
30036
30529
|
format: "date-time",
|
|
30037
30530
|
type: "string"
|
|
30038
30531
|
},
|
|
@@ -30040,7 +30533,7 @@ var openapi_default = {
|
|
|
30040
30533
|
additionalProperties: {
|
|
30041
30534
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
30042
30535
|
},
|
|
30043
|
-
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
30536
|
+
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
|
|
30044
30537
|
type: "object"
|
|
30045
30538
|
},
|
|
30046
30539
|
customer_ids: {
|
|
@@ -30048,7 +30541,7 @@ var openapi_default = {
|
|
|
30048
30541
|
type: "array"
|
|
30049
30542
|
},
|
|
30050
30543
|
device_ids: {
|
|
30051
|
-
description: "Array of device IDs
|
|
30544
|
+
description: "Array of device IDs for which you want to list devices.",
|
|
30052
30545
|
items: { format: "uuid", type: "string" },
|
|
30053
30546
|
type: "array"
|
|
30054
30547
|
},
|
|
@@ -30206,13 +30699,14 @@ var openapi_default = {
|
|
|
30206
30699
|
type: "string"
|
|
30207
30700
|
},
|
|
30208
30701
|
unstable_location_id: {
|
|
30702
|
+
description: "ID of the location for which you want to list devices.",
|
|
30209
30703
|
format: "uuid",
|
|
30210
30704
|
nullable: true,
|
|
30211
30705
|
type: "string",
|
|
30212
30706
|
"x-undocumented": "Experimental locations."
|
|
30213
30707
|
},
|
|
30214
30708
|
user_identifier_key: {
|
|
30215
|
-
description: "Your own internal user ID for the user
|
|
30709
|
+
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
30216
30710
|
type: "string"
|
|
30217
30711
|
}
|
|
30218
30712
|
},
|
|
@@ -30568,22 +31062,22 @@ var openapi_default = {
|
|
|
30568
31062
|
schema: {
|
|
30569
31063
|
properties: {
|
|
30570
31064
|
connect_webview_id: {
|
|
30571
|
-
description: "ID of the Connect Webview
|
|
31065
|
+
description: "ID of the Connect Webview for which you want to list devices.",
|
|
30572
31066
|
format: "uuid",
|
|
30573
31067
|
type: "string"
|
|
30574
31068
|
},
|
|
30575
31069
|
connected_account_id: {
|
|
30576
|
-
description: "ID of the connected account
|
|
31070
|
+
description: "ID of the connected account for which you want to list devices.",
|
|
30577
31071
|
format: "uuid",
|
|
30578
31072
|
type: "string"
|
|
30579
31073
|
},
|
|
30580
31074
|
connected_account_ids: {
|
|
30581
|
-
description: "Array of IDs of the connected accounts
|
|
31075
|
+
description: "Array of IDs of the connected accounts for which you want to list devices.",
|
|
30582
31076
|
items: { format: "uuid", type: "string" },
|
|
30583
31077
|
type: "array"
|
|
30584
31078
|
},
|
|
30585
31079
|
created_before: {
|
|
30586
|
-
description: "
|
|
31080
|
+
description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
|
|
30587
31081
|
format: "date-time",
|
|
30588
31082
|
type: "string"
|
|
30589
31083
|
},
|
|
@@ -30591,7 +31085,7 @@ var openapi_default = {
|
|
|
30591
31085
|
additionalProperties: {
|
|
30592
31086
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
30593
31087
|
},
|
|
30594
|
-
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
31088
|
+
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
|
|
30595
31089
|
type: "object"
|
|
30596
31090
|
},
|
|
30597
31091
|
customer_ids: {
|
|
@@ -30599,7 +31093,7 @@ var openapi_default = {
|
|
|
30599
31093
|
type: "array"
|
|
30600
31094
|
},
|
|
30601
31095
|
device_ids: {
|
|
30602
|
-
description: "Array of device IDs
|
|
31096
|
+
description: "Array of device IDs for which you want to list devices.",
|
|
30603
31097
|
items: { format: "uuid", type: "string" },
|
|
30604
31098
|
type: "array"
|
|
30605
31099
|
},
|
|
@@ -30673,13 +31167,14 @@ var openapi_default = {
|
|
|
30673
31167
|
type: "string"
|
|
30674
31168
|
},
|
|
30675
31169
|
unstable_location_id: {
|
|
31170
|
+
description: "ID of the location for which you want to list devices.",
|
|
30676
31171
|
format: "uuid",
|
|
30677
31172
|
nullable: true,
|
|
30678
31173
|
type: "string",
|
|
30679
31174
|
"x-undocumented": "Experimental locations."
|
|
30680
31175
|
},
|
|
30681
31176
|
user_identifier_key: {
|
|
30682
|
-
description: "Your own internal user ID for the user
|
|
31177
|
+
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
30683
31178
|
type: "string"
|
|
30684
31179
|
}
|
|
30685
31180
|
},
|
|
@@ -33461,22 +33956,22 @@ var openapi_default = {
|
|
|
33461
33956
|
schema: {
|
|
33462
33957
|
properties: {
|
|
33463
33958
|
connect_webview_id: {
|
|
33464
|
-
description: "ID of the Connect Webview
|
|
33959
|
+
description: "ID of the Connect Webview for which you want to list devices.",
|
|
33465
33960
|
format: "uuid",
|
|
33466
33961
|
type: "string"
|
|
33467
33962
|
},
|
|
33468
33963
|
connected_account_id: {
|
|
33469
|
-
description: "ID of the connected account
|
|
33964
|
+
description: "ID of the connected account for which you want to list devices.",
|
|
33470
33965
|
format: "uuid",
|
|
33471
33966
|
type: "string"
|
|
33472
33967
|
},
|
|
33473
33968
|
connected_account_ids: {
|
|
33474
|
-
description: "Array of IDs of the connected accounts
|
|
33969
|
+
description: "Array of IDs of the connected accounts for which you want to list devices.",
|
|
33475
33970
|
items: { format: "uuid", type: "string" },
|
|
33476
33971
|
type: "array"
|
|
33477
33972
|
},
|
|
33478
33973
|
created_before: {
|
|
33479
|
-
description: "
|
|
33974
|
+
description: "Timestamp by which to limit returned devices. Returns devices created before this timestamp.",
|
|
33480
33975
|
format: "date-time",
|
|
33481
33976
|
type: "string"
|
|
33482
33977
|
},
|
|
@@ -33484,7 +33979,7 @@ var openapi_default = {
|
|
|
33484
33979
|
additionalProperties: {
|
|
33485
33980
|
oneOf: [{ type: "string" }, { type: "boolean" }]
|
|
33486
33981
|
},
|
|
33487
|
-
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
33982
|
+
description: "Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.",
|
|
33488
33983
|
type: "object"
|
|
33489
33984
|
},
|
|
33490
33985
|
customer_ids: {
|
|
@@ -33492,7 +33987,7 @@ var openapi_default = {
|
|
|
33492
33987
|
type: "array"
|
|
33493
33988
|
},
|
|
33494
33989
|
device_ids: {
|
|
33495
|
-
description: "Array of device IDs
|
|
33990
|
+
description: "Array of device IDs for which you want to list devices.",
|
|
33496
33991
|
items: { format: "uuid", type: "string" },
|
|
33497
33992
|
type: "array"
|
|
33498
33993
|
},
|
|
@@ -33586,13 +34081,14 @@ var openapi_default = {
|
|
|
33586
34081
|
type: "string"
|
|
33587
34082
|
},
|
|
33588
34083
|
unstable_location_id: {
|
|
34084
|
+
description: "ID of the location for which you want to list devices.",
|
|
33589
34085
|
format: "uuid",
|
|
33590
34086
|
nullable: true,
|
|
33591
34087
|
type: "string",
|
|
33592
34088
|
"x-undocumented": "Experimental locations."
|
|
33593
34089
|
},
|
|
33594
34090
|
user_identifier_key: {
|
|
33595
|
-
description: "Your own internal user ID for the user
|
|
34091
|
+
description: "Your own internal user ID for the user for which you want to list devices.",
|
|
33596
34092
|
type: "string"
|
|
33597
34093
|
}
|
|
33598
34094
|
},
|
|
@@ -36731,6 +37227,101 @@ var openapi_default = {
|
|
|
36731
37227
|
"x-undocumented": "Experimental locations."
|
|
36732
37228
|
}
|
|
36733
37229
|
},
|
|
37230
|
+
"/unstable_partner/resources/push": {
|
|
37231
|
+
post: {
|
|
37232
|
+
description: "Send Seam some of your resources.",
|
|
37233
|
+
operationId: "unstablePartnerResourcesPushPost",
|
|
37234
|
+
requestBody: {
|
|
37235
|
+
content: {
|
|
37236
|
+
"application/json": {
|
|
37237
|
+
schema: {
|
|
37238
|
+
oneOf: [
|
|
37239
|
+
{
|
|
37240
|
+
items: {
|
|
37241
|
+
properties: {
|
|
37242
|
+
custom_metadata: {
|
|
37243
|
+
additionalProperties: { type: "string" },
|
|
37244
|
+
type: "object"
|
|
37245
|
+
},
|
|
37246
|
+
customer_key: { type: "string" },
|
|
37247
|
+
description: { type: "string" },
|
|
37248
|
+
email_address: { type: "string" },
|
|
37249
|
+
ends_at: { type: "string" },
|
|
37250
|
+
icon_url: { type: "string" },
|
|
37251
|
+
location_keys: {
|
|
37252
|
+
items: { type: "string" },
|
|
37253
|
+
type: "array"
|
|
37254
|
+
},
|
|
37255
|
+
name: { type: "string" },
|
|
37256
|
+
partner_resource_key: { type: "string" },
|
|
37257
|
+
partner_resource_type: { type: "string" },
|
|
37258
|
+
phone_number: { type: "string" },
|
|
37259
|
+
starts_at: { type: "string" },
|
|
37260
|
+
user_identity_key: { type: "string" }
|
|
37261
|
+
},
|
|
37262
|
+
type: "object"
|
|
37263
|
+
},
|
|
37264
|
+
type: "array"
|
|
37265
|
+
},
|
|
37266
|
+
{
|
|
37267
|
+
properties: {
|
|
37268
|
+
custom_metadata: {
|
|
37269
|
+
additionalProperties: { type: "string" },
|
|
37270
|
+
type: "object"
|
|
37271
|
+
},
|
|
37272
|
+
customer_key: { type: "string" },
|
|
37273
|
+
description: { type: "string" },
|
|
37274
|
+
email_address: { type: "string" },
|
|
37275
|
+
ends_at: { type: "string" },
|
|
37276
|
+
icon_url: { type: "string" },
|
|
37277
|
+
location_keys: {
|
|
37278
|
+
items: { type: "string" },
|
|
37279
|
+
type: "array"
|
|
37280
|
+
},
|
|
37281
|
+
name: { type: "string" },
|
|
37282
|
+
partner_resource_key: { type: "string" },
|
|
37283
|
+
partner_resource_type: { type: "string" },
|
|
37284
|
+
phone_number: { type: "string" },
|
|
37285
|
+
starts_at: { type: "string" },
|
|
37286
|
+
user_identity_key: { type: "string" }
|
|
37287
|
+
},
|
|
37288
|
+
type: "object"
|
|
37289
|
+
}
|
|
37290
|
+
]
|
|
37291
|
+
}
|
|
37292
|
+
}
|
|
37293
|
+
}
|
|
37294
|
+
},
|
|
37295
|
+
responses: {
|
|
37296
|
+
200: {
|
|
37297
|
+
content: {
|
|
37298
|
+
"application/json": {
|
|
37299
|
+
schema: {
|
|
37300
|
+
properties: { ok: { type: "boolean" } },
|
|
37301
|
+
required: ["ok"],
|
|
37302
|
+
type: "object"
|
|
37303
|
+
}
|
|
37304
|
+
}
|
|
37305
|
+
},
|
|
37306
|
+
description: "OK"
|
|
37307
|
+
},
|
|
37308
|
+
400: { description: "Bad Request" },
|
|
37309
|
+
401: { description: "Unauthorized" }
|
|
37310
|
+
},
|
|
37311
|
+
security: [
|
|
37312
|
+
{ pat_with_workspace: [] },
|
|
37313
|
+
{ console_session_with_workspace: [] },
|
|
37314
|
+
{ api_key: [] }
|
|
37315
|
+
],
|
|
37316
|
+
summary: "/unstable_partner/resources/push",
|
|
37317
|
+
tags: [],
|
|
37318
|
+
"x-fern-sdk-group-name": ["unstable_partner", "resources"],
|
|
37319
|
+
"x-fern-sdk-method-name": "push",
|
|
37320
|
+
"x-response-key": null,
|
|
37321
|
+
"x-title": "Push partner resources at Seam",
|
|
37322
|
+
"x-undocumented": "Experimental partner resources."
|
|
37323
|
+
}
|
|
37324
|
+
},
|
|
36734
37325
|
"/user_identities/add_acs_user": {
|
|
36735
37326
|
post: {
|
|
36736
37327
|
description: "Adds a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).",
|
|
@@ -36918,7 +37509,7 @@ var openapi_default = {
|
|
|
36918
37509
|
},
|
|
36919
37510
|
"/user_identities/delete": {
|
|
36920
37511
|
post: {
|
|
36921
|
-
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [
|
|
37512
|
+
description: "Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.",
|
|
36922
37513
|
operationId: "userIdentitiesDeletePost",
|
|
36923
37514
|
requestBody: {
|
|
36924
37515
|
content: {
|
|
@@ -38484,6 +39075,7 @@ var openapi_default = {
|
|
|
38484
39075
|
},
|
|
38485
39076
|
"/workspaces/reset_sandbox": {
|
|
38486
39077
|
post: {
|
|
39078
|
+
description: "Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.",
|
|
38487
39079
|
operationId: "workspacesResetSandboxPost",
|
|
38488
39080
|
responses: {
|
|
38489
39081
|
200: {
|