@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
|
@@ -3,7 +3,7 @@ export default {
|
|
|
3
3
|
schemas: {
|
|
4
4
|
access_code: {
|
|
5
5
|
description:
|
|
6
|
-
'Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound
|
|
6
|
+
'Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.',
|
|
7
7
|
properties: {
|
|
8
8
|
access_code_id: {
|
|
9
9
|
description: 'Unique identifier for the access code.',
|
|
@@ -1180,7 +1180,7 @@ export default {
|
|
|
1180
1180
|
},
|
|
1181
1181
|
name: {
|
|
1182
1182
|
description:
|
|
1183
|
-
|
|
1183
|
+
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
1184
1184
|
nullable: true,
|
|
1185
1185
|
type: 'string',
|
|
1186
1186
|
},
|
|
@@ -7124,6 +7124,8 @@ export default {
|
|
|
7124
7124
|
'x-route-path': '/action_attempts',
|
|
7125
7125
|
},
|
|
7126
7126
|
client_session: {
|
|
7127
|
+
description:
|
|
7128
|
+
"Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.\n\nYou create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.\n\nWhen calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.\n\nA client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.\n\nSee also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens).",
|
|
7127
7129
|
properties: {
|
|
7128
7130
|
client_session_id: { format: 'uuid', type: 'string' },
|
|
7129
7131
|
connect_webview_ids: {
|
|
@@ -7161,18 +7163,22 @@ export default {
|
|
|
7161
7163
|
'x-route-path': '/client_sessions',
|
|
7162
7164
|
},
|
|
7163
7165
|
connect_webview: {
|
|
7166
|
+
description:
|
|
7167
|
+
'Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nConnect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.\n\nConnect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.\n\nTo enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.\n\nWhen you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.\n\nTo list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters.',
|
|
7164
7168
|
properties: {
|
|
7165
7169
|
accepted_devices: {
|
|
7166
7170
|
deprecated: true,
|
|
7167
7171
|
items: { type: 'string' },
|
|
7168
7172
|
type: 'array',
|
|
7169
7173
|
'x-deprecated': 'Unused. Will be removed.',
|
|
7174
|
+
'x-undocumented': 'Unused. Will be removed.',
|
|
7170
7175
|
},
|
|
7171
7176
|
accepted_providers: { items: { type: 'string' }, type: 'array' },
|
|
7172
7177
|
any_device_allowed: {
|
|
7173
7178
|
deprecated: true,
|
|
7174
7179
|
type: 'boolean',
|
|
7175
7180
|
'x-deprecated': 'Unused. Will be removed.',
|
|
7181
|
+
'x-undocumented': 'Unused. Will be removed.',
|
|
7176
7182
|
},
|
|
7177
7183
|
any_provider_allowed: { type: 'boolean' },
|
|
7178
7184
|
authorized_at: {
|
|
@@ -7240,6 +7246,8 @@ export default {
|
|
|
7240
7246
|
'x-route-path': '/connect_webviews',
|
|
7241
7247
|
},
|
|
7242
7248
|
connected_account: {
|
|
7249
|
+
description:
|
|
7250
|
+
'Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.',
|
|
7243
7251
|
properties: {
|
|
7244
7252
|
account_type: { type: 'string' },
|
|
7245
7253
|
account_type_display_name: { type: 'string' },
|
|
@@ -7513,6 +7521,8 @@ export default {
|
|
|
7513
7521
|
'x-route-path': '/connected_accounts',
|
|
7514
7522
|
},
|
|
7515
7523
|
device: {
|
|
7524
|
+
description:
|
|
7525
|
+
'Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.',
|
|
7516
7526
|
properties: {
|
|
7517
7527
|
can_hvac_cool: { type: 'boolean' },
|
|
7518
7528
|
can_hvac_heat: { type: 'boolean' },
|
|
@@ -8082,7 +8092,8 @@ export default {
|
|
|
8082
8092
|
type: 'string',
|
|
8083
8093
|
},
|
|
8084
8094
|
manufacturer: {
|
|
8085
|
-
description:
|
|
8095
|
+
description:
|
|
8096
|
+
'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
|
|
8086
8097
|
type: 'string',
|
|
8087
8098
|
},
|
|
8088
8099
|
model: {
|
|
@@ -8778,6 +8789,8 @@ export default {
|
|
|
8778
8789
|
type: 'array',
|
|
8779
8790
|
},
|
|
8780
8791
|
code_constraints: {
|
|
8792
|
+
description:
|
|
8793
|
+
'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.',
|
|
8781
8794
|
items: {
|
|
8782
8795
|
oneOf: [
|
|
8783
8796
|
{
|
|
@@ -9901,6 +9914,8 @@ export default {
|
|
|
9901
9914
|
'x-route-path': '/user_identities/enrollment_automations',
|
|
9902
9915
|
},
|
|
9903
9916
|
event: {
|
|
9917
|
+
description:
|
|
9918
|
+
"Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.\n\nAs with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints.",
|
|
9904
9919
|
discriminator: { propertyName: 'event_type' },
|
|
9905
9920
|
oneOf: [
|
|
9906
9921
|
{
|
|
@@ -15203,7 +15218,7 @@ export default {
|
|
|
15203
15218
|
},
|
|
15204
15219
|
unmanaged_access_code: {
|
|
15205
15220
|
description:
|
|
15206
|
-
'Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.',
|
|
15221
|
+
'Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.\n\nNot all providers support unmanaged access codes. The following providers do not support unmanaged access codes:\n\n- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)',
|
|
15207
15222
|
properties: {
|
|
15208
15223
|
access_code_id: {
|
|
15209
15224
|
description: 'Unique identifier for the access code.',
|
|
@@ -16340,7 +16355,7 @@ export default {
|
|
|
16340
16355
|
},
|
|
16341
16356
|
name: {
|
|
16342
16357
|
description:
|
|
16343
|
-
|
|
16358
|
+
"Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
16344
16359
|
nullable: true,
|
|
16345
16360
|
type: 'string',
|
|
16346
16361
|
},
|
|
@@ -17807,6 +17822,8 @@ export default {
|
|
|
17807
17822
|
'x-route-path': '/acs/users/unmanaged',
|
|
17808
17823
|
},
|
|
17809
17824
|
unmanaged_device: {
|
|
17825
|
+
description:
|
|
17826
|
+
'Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
|
|
17810
17827
|
properties: {
|
|
17811
17828
|
can_hvac_cool: { type: 'boolean' },
|
|
17812
17829
|
can_hvac_heat: { type: 'boolean' },
|
|
@@ -18326,7 +18343,8 @@ export default {
|
|
|
18326
18343
|
type: 'string',
|
|
18327
18344
|
},
|
|
18328
18345
|
manufacturer: {
|
|
18329
|
-
description:
|
|
18346
|
+
description:
|
|
18347
|
+
'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
|
|
18330
18348
|
type: 'string',
|
|
18331
18349
|
},
|
|
18332
18350
|
model: {
|
|
@@ -18690,7 +18708,7 @@ export default {
|
|
|
18690
18708
|
},
|
|
18691
18709
|
user_identity: {
|
|
18692
18710
|
description:
|
|
18693
|
-
'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
18711
|
+
'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.',
|
|
18694
18712
|
properties: {
|
|
18695
18713
|
created_at: {
|
|
18696
18714
|
description:
|
|
@@ -18755,6 +18773,8 @@ export default {
|
|
|
18755
18773
|
'x-route-path': '/webhooks',
|
|
18756
18774
|
},
|
|
18757
18775
|
workspace: {
|
|
18776
|
+
description:
|
|
18777
|
+
'Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces).',
|
|
18758
18778
|
properties: {
|
|
18759
18779
|
company_name: { type: 'string' },
|
|
18760
18780
|
connect_partner_name: {
|
|
@@ -18891,7 +18911,7 @@ export default {
|
|
|
18891
18911
|
},
|
|
18892
18912
|
device_id: {
|
|
18893
18913
|
description:
|
|
18894
|
-
'ID of the device for which to create the new access code.',
|
|
18914
|
+
'ID of the device for which you want to create the new access code.',
|
|
18895
18915
|
format: 'uuid',
|
|
18896
18916
|
type: 'string',
|
|
18897
18917
|
},
|
|
@@ -18923,7 +18943,8 @@ export default {
|
|
|
18923
18943
|
type: 'string',
|
|
18924
18944
|
},
|
|
18925
18945
|
name: {
|
|
18926
|
-
description:
|
|
18946
|
+
description:
|
|
18947
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
18927
18948
|
type: 'string',
|
|
18928
18949
|
},
|
|
18929
18950
|
prefer_native_scheduling: {
|
|
@@ -19033,7 +19054,7 @@ export default {
|
|
|
19033
19054
|
},
|
|
19034
19055
|
device_ids: {
|
|
19035
19056
|
description:
|
|
19036
|
-
'IDs of the devices for which to create the new access codes.',
|
|
19057
|
+
'IDs of the devices for which you want to create the new access codes.',
|
|
19037
19058
|
items: { format: 'uuid', type: 'string' },
|
|
19038
19059
|
type: 'array',
|
|
19039
19060
|
},
|
|
@@ -19065,7 +19086,8 @@ export default {
|
|
|
19065
19086
|
type: 'string',
|
|
19066
19087
|
},
|
|
19067
19088
|
name: {
|
|
19068
|
-
description:
|
|
19089
|
+
description:
|
|
19090
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
19069
19091
|
type: 'string',
|
|
19070
19092
|
},
|
|
19071
19093
|
prefer_native_scheduling: {
|
|
@@ -19167,7 +19189,7 @@ export default {
|
|
|
19167
19189
|
},
|
|
19168
19190
|
device_ids: {
|
|
19169
19191
|
description:
|
|
19170
|
-
'IDs of the devices for which to create the new access codes.',
|
|
19192
|
+
'IDs of the devices for which you want to create the new access codes.',
|
|
19171
19193
|
items: { format: 'uuid', type: 'string' },
|
|
19172
19194
|
type: 'array',
|
|
19173
19195
|
},
|
|
@@ -19199,7 +19221,8 @@ export default {
|
|
|
19199
19221
|
type: 'string',
|
|
19200
19222
|
},
|
|
19201
19223
|
name: {
|
|
19202
|
-
description:
|
|
19224
|
+
description:
|
|
19225
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
19203
19226
|
type: 'string',
|
|
19204
19227
|
},
|
|
19205
19228
|
prefer_native_scheduling: {
|
|
@@ -19277,13 +19300,14 @@ export default {
|
|
|
19277
19300
|
schema: {
|
|
19278
19301
|
properties: {
|
|
19279
19302
|
access_code_id: {
|
|
19280
|
-
description:
|
|
19303
|
+
description:
|
|
19304
|
+
'ID of the access code that you want to delete.',
|
|
19281
19305
|
format: 'uuid',
|
|
19282
19306
|
type: 'string',
|
|
19283
19307
|
},
|
|
19284
19308
|
device_id: {
|
|
19285
19309
|
description:
|
|
19286
|
-
'ID of the device for which to delete the access code.',
|
|
19310
|
+
'ID of the device for which you want to delete the access code.',
|
|
19287
19311
|
format: 'uuid',
|
|
19288
19312
|
type: 'string',
|
|
19289
19313
|
},
|
|
@@ -19337,12 +19361,21 @@ export default {
|
|
|
19337
19361
|
},
|
|
19338
19362
|
'/access_codes/generate_code': {
|
|
19339
19363
|
post: {
|
|
19364
|
+
description:
|
|
19365
|
+
'Generates a code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes), given a device ID.',
|
|
19340
19366
|
operationId: 'accessCodesGenerateCodePost',
|
|
19341
19367
|
requestBody: {
|
|
19342
19368
|
content: {
|
|
19343
19369
|
'application/json': {
|
|
19344
19370
|
schema: {
|
|
19345
|
-
properties: {
|
|
19371
|
+
properties: {
|
|
19372
|
+
device_id: {
|
|
19373
|
+
description:
|
|
19374
|
+
'ID of the device for which you want to generate a code.',
|
|
19375
|
+
format: 'uuid',
|
|
19376
|
+
type: 'string',
|
|
19377
|
+
},
|
|
19378
|
+
},
|
|
19346
19379
|
required: ['device_id'],
|
|
19347
19380
|
type: 'object',
|
|
19348
19381
|
},
|
|
@@ -19382,6 +19415,7 @@ export default {
|
|
|
19382
19415
|
'x-fern-sdk-method-name': 'generate_code',
|
|
19383
19416
|
'x-fern-sdk-return-value': 'generated_code',
|
|
19384
19417
|
'x-response-key': 'generated_code',
|
|
19418
|
+
'x-title': 'Generate a Code',
|
|
19385
19419
|
},
|
|
19386
19420
|
},
|
|
19387
19421
|
'/access_codes/get': {
|
|
@@ -19538,7 +19572,7 @@ export default {
|
|
|
19538
19572
|
'/access_codes/pull_backup_access_code': {
|
|
19539
19573
|
post: {
|
|
19540
19574
|
description:
|
|
19541
|
-
"Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes
|
|
19575
|
+
"Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can pull a backup access code from the pool at any time. These backup codes are guaranteed to work immediately and automatically programmed to be removed from the device after the access code ends.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
|
|
19542
19576
|
operationId: 'accessCodesPullBackupAccessCodePost',
|
|
19543
19577
|
requestBody: {
|
|
19544
19578
|
content: {
|
|
@@ -19598,7 +19632,7 @@ export default {
|
|
|
19598
19632
|
'/access_codes/report_device_constraints': {
|
|
19599
19633
|
post: {
|
|
19600
19634
|
description:
|
|
19601
|
-
'Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices
|
|
19635
|
+
'Enables you to report access code-related constraints for a device. Currently, supports reporting supported code length constraints for SmartThings devices.\n\nSpecify either `supported_code_lengths` or `min_code_length`/`max_code_length`.',
|
|
19602
19636
|
operationId: 'accessCodesReportDeviceConstraintsPost',
|
|
19603
19637
|
requestBody: {
|
|
19604
19638
|
content: {
|
|
@@ -19607,7 +19641,7 @@ export default {
|
|
|
19607
19641
|
properties: {
|
|
19608
19642
|
device_id: {
|
|
19609
19643
|
description:
|
|
19610
|
-
'ID of the device for which to report constraints.',
|
|
19644
|
+
'ID of the device for which you want to report constraints.',
|
|
19611
19645
|
format: 'uuid',
|
|
19612
19646
|
type: 'string',
|
|
19613
19647
|
},
|
|
@@ -19757,7 +19791,7 @@ export default {
|
|
|
19757
19791
|
},
|
|
19758
19792
|
allow_external_modification: {
|
|
19759
19793
|
description:
|
|
19760
|
-
'Indicates whether external modification of the access code is allowed.',
|
|
19794
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
|
|
19761
19795
|
type: 'boolean',
|
|
19762
19796
|
},
|
|
19763
19797
|
force: {
|
|
@@ -19767,7 +19801,7 @@ export default {
|
|
|
19767
19801
|
},
|
|
19768
19802
|
is_external_modification_allowed: {
|
|
19769
19803
|
description:
|
|
19770
|
-
'Indicates whether external modification of the access code is allowed.',
|
|
19804
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
|
|
19771
19805
|
type: 'boolean',
|
|
19772
19806
|
},
|
|
19773
19807
|
sync: {
|
|
@@ -19828,7 +19862,7 @@ export default {
|
|
|
19828
19862
|
},
|
|
19829
19863
|
allow_external_modification: {
|
|
19830
19864
|
description:
|
|
19831
|
-
'Indicates whether external modification of the access code is allowed.',
|
|
19865
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
|
|
19832
19866
|
type: 'boolean',
|
|
19833
19867
|
},
|
|
19834
19868
|
force: {
|
|
@@ -19838,7 +19872,7 @@ export default {
|
|
|
19838
19872
|
},
|
|
19839
19873
|
is_external_modification_allowed: {
|
|
19840
19874
|
description:
|
|
19841
|
-
'Indicates whether external modification of the access code is allowed.',
|
|
19875
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed.',
|
|
19842
19876
|
type: 'boolean',
|
|
19843
19877
|
},
|
|
19844
19878
|
sync: {
|
|
@@ -19895,7 +19929,8 @@ export default {
|
|
|
19895
19929
|
schema: {
|
|
19896
19930
|
properties: {
|
|
19897
19931
|
access_code_id: {
|
|
19898
|
-
description:
|
|
19932
|
+
description:
|
|
19933
|
+
'ID of the unmanaged access code that you want to delete.',
|
|
19899
19934
|
format: 'uuid',
|
|
19900
19935
|
type: 'string',
|
|
19901
19936
|
},
|
|
@@ -20289,7 +20324,8 @@ export default {
|
|
|
20289
20324
|
type: 'string',
|
|
20290
20325
|
},
|
|
20291
20326
|
name: {
|
|
20292
|
-
description:
|
|
20327
|
+
description:
|
|
20328
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20293
20329
|
type: 'string',
|
|
20294
20330
|
},
|
|
20295
20331
|
prefer_native_scheduling: {
|
|
@@ -20436,7 +20472,8 @@ export default {
|
|
|
20436
20472
|
type: 'string',
|
|
20437
20473
|
},
|
|
20438
20474
|
name: {
|
|
20439
|
-
description:
|
|
20475
|
+
description:
|
|
20476
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20440
20477
|
type: 'string',
|
|
20441
20478
|
},
|
|
20442
20479
|
prefer_native_scheduling: {
|
|
@@ -20584,7 +20621,8 @@ export default {
|
|
|
20584
20621
|
type: 'string',
|
|
20585
20622
|
},
|
|
20586
20623
|
name: {
|
|
20587
|
-
description:
|
|
20624
|
+
description:
|
|
20625
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20588
20626
|
type: 'string',
|
|
20589
20627
|
},
|
|
20590
20628
|
prefer_native_scheduling: {
|
|
@@ -20683,7 +20721,8 @@ export default {
|
|
|
20683
20721
|
type: 'string',
|
|
20684
20722
|
},
|
|
20685
20723
|
name: {
|
|
20686
|
-
description:
|
|
20724
|
+
description:
|
|
20725
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20687
20726
|
type: 'string',
|
|
20688
20727
|
},
|
|
20689
20728
|
starts_at: {
|
|
@@ -20746,7 +20785,8 @@ export default {
|
|
|
20746
20785
|
type: 'string',
|
|
20747
20786
|
},
|
|
20748
20787
|
name: {
|
|
20749
|
-
description:
|
|
20788
|
+
description:
|
|
20789
|
+
"Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n \n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n \n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n \n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
|
|
20750
20790
|
type: 'string',
|
|
20751
20791
|
},
|
|
20752
20792
|
starts_at: {
|
|
@@ -20794,7 +20834,7 @@ export default {
|
|
|
20794
20834
|
'/acs/access_groups/add_user': {
|
|
20795
20835
|
post: {
|
|
20796
20836
|
description:
|
|
20797
|
-
'Adds a specified [
|
|
20837
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
20798
20838
|
operationId: 'acsAccessGroupsAddUserPost',
|
|
20799
20839
|
requestBody: {
|
|
20800
20840
|
content: {
|
|
@@ -20802,17 +20842,25 @@ export default {
|
|
|
20802
20842
|
schema: {
|
|
20803
20843
|
properties: {
|
|
20804
20844
|
acs_access_group_id: {
|
|
20805
|
-
description:
|
|
20845
|
+
description:
|
|
20846
|
+
'ID of the access group to which you want to add an access system user.',
|
|
20806
20847
|
format: 'uuid',
|
|
20807
20848
|
type: 'string',
|
|
20808
20849
|
},
|
|
20809
20850
|
acs_user_id: {
|
|
20810
|
-
description:
|
|
20851
|
+
description:
|
|
20852
|
+
'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.',
|
|
20853
|
+
format: 'uuid',
|
|
20854
|
+
type: 'string',
|
|
20855
|
+
},
|
|
20856
|
+
user_identity_id: {
|
|
20857
|
+
description:
|
|
20858
|
+
'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.',
|
|
20811
20859
|
format: 'uuid',
|
|
20812
20860
|
type: 'string',
|
|
20813
20861
|
},
|
|
20814
20862
|
},
|
|
20815
|
-
required: ['acs_access_group_id'
|
|
20863
|
+
required: ['acs_access_group_id'],
|
|
20816
20864
|
type: 'object',
|
|
20817
20865
|
},
|
|
20818
20866
|
},
|
|
@@ -20848,7 +20896,7 @@ export default {
|
|
|
20848
20896
|
},
|
|
20849
20897
|
put: {
|
|
20850
20898
|
description:
|
|
20851
|
-
'Adds a specified [
|
|
20899
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
20852
20900
|
operationId: 'acsAccessGroupsAddUserPut',
|
|
20853
20901
|
requestBody: {
|
|
20854
20902
|
content: {
|
|
@@ -20856,17 +20904,25 @@ export default {
|
|
|
20856
20904
|
schema: {
|
|
20857
20905
|
properties: {
|
|
20858
20906
|
acs_access_group_id: {
|
|
20859
|
-
description:
|
|
20907
|
+
description:
|
|
20908
|
+
'ID of the access group to which you want to add an access system user.',
|
|
20860
20909
|
format: 'uuid',
|
|
20861
20910
|
type: 'string',
|
|
20862
20911
|
},
|
|
20863
20912
|
acs_user_id: {
|
|
20864
|
-
description:
|
|
20913
|
+
description:
|
|
20914
|
+
'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.',
|
|
20915
|
+
format: 'uuid',
|
|
20916
|
+
type: 'string',
|
|
20917
|
+
},
|
|
20918
|
+
user_identity_id: {
|
|
20919
|
+
description:
|
|
20920
|
+
'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.',
|
|
20865
20921
|
format: 'uuid',
|
|
20866
20922
|
type: 'string',
|
|
20867
20923
|
},
|
|
20868
20924
|
},
|
|
20869
|
-
required: ['acs_access_group_id'
|
|
20925
|
+
required: ['acs_access_group_id'],
|
|
20870
20926
|
type: 'object',
|
|
20871
20927
|
},
|
|
20872
20928
|
},
|
|
@@ -20911,7 +20967,7 @@ export default {
|
|
|
20911
20967
|
schema: {
|
|
20912
20968
|
properties: {
|
|
20913
20969
|
acs_access_group_id: {
|
|
20914
|
-
description: 'ID of the
|
|
20970
|
+
description: 'ID of the access group that you want to get.',
|
|
20915
20971
|
format: 'uuid',
|
|
20916
20972
|
type: 'string',
|
|
20917
20973
|
},
|
|
@@ -20969,13 +21025,13 @@ export default {
|
|
|
20969
21025
|
properties: {
|
|
20970
21026
|
acs_system_id: {
|
|
20971
21027
|
description:
|
|
20972
|
-
'ID of the access
|
|
21028
|
+
'ID of the access system for which you want to retrieve all access groups.',
|
|
20973
21029
|
format: 'uuid',
|
|
20974
21030
|
type: 'string',
|
|
20975
21031
|
},
|
|
20976
21032
|
acs_user_id: {
|
|
20977
21033
|
description:
|
|
20978
|
-
'ID of the user for which you want to retrieve all access groups.',
|
|
21034
|
+
'ID of the access system user for which you want to retrieve all access groups.',
|
|
20979
21035
|
format: 'uuid',
|
|
20980
21036
|
type: 'string',
|
|
20981
21037
|
},
|
|
@@ -21089,7 +21145,7 @@ export default {
|
|
|
21089
21145
|
'/acs/access_groups/list_users': {
|
|
21090
21146
|
post: {
|
|
21091
21147
|
description:
|
|
21092
|
-
'Returns a list of all [
|
|
21148
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
21093
21149
|
operationId: 'acsAccessGroupsListUsersPost',
|
|
21094
21150
|
requestBody: {
|
|
21095
21151
|
content: {
|
|
@@ -21098,7 +21154,7 @@ export default {
|
|
|
21098
21154
|
properties: {
|
|
21099
21155
|
acs_access_group_id: {
|
|
21100
21156
|
description:
|
|
21101
|
-
'ID of the access group for which you want to retrieve all users.',
|
|
21157
|
+
'ID of the access group for which you want to retrieve all access system users.',
|
|
21102
21158
|
format: 'uuid',
|
|
21103
21159
|
type: 'string',
|
|
21104
21160
|
},
|
|
@@ -21148,7 +21204,7 @@ export default {
|
|
|
21148
21204
|
'/acs/access_groups/remove_user': {
|
|
21149
21205
|
post: {
|
|
21150
21206
|
description:
|
|
21151
|
-
'Removes a specified [
|
|
21207
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
21152
21208
|
operationId: 'acsAccessGroupsRemoveUserPost',
|
|
21153
21209
|
requestBody: {
|
|
21154
21210
|
content: {
|
|
@@ -21156,17 +21212,20 @@ export default {
|
|
|
21156
21212
|
schema: {
|
|
21157
21213
|
properties: {
|
|
21158
21214
|
acs_access_group_id: {
|
|
21159
|
-
description:
|
|
21215
|
+
description:
|
|
21216
|
+
'ID of the access group from which you want to remove an access system user.',
|
|
21160
21217
|
format: 'uuid',
|
|
21161
21218
|
type: 'string',
|
|
21162
21219
|
},
|
|
21163
21220
|
acs_user_id: {
|
|
21164
|
-
description:
|
|
21221
|
+
description:
|
|
21222
|
+
'ID of the access system user that you want to remove from an access group.',
|
|
21165
21223
|
format: 'uuid',
|
|
21166
21224
|
type: 'string',
|
|
21167
21225
|
},
|
|
21168
21226
|
user_identity_id: {
|
|
21169
|
-
description:
|
|
21227
|
+
description:
|
|
21228
|
+
'ID of the user identity associated with the user that you want to remove from an access group.',
|
|
21170
21229
|
format: 'uuid',
|
|
21171
21230
|
type: 'string',
|
|
21172
21231
|
},
|
|
@@ -21217,7 +21276,8 @@ export default {
|
|
|
21217
21276
|
schema: {
|
|
21218
21277
|
properties: {
|
|
21219
21278
|
acs_access_group_id: {
|
|
21220
|
-
description:
|
|
21279
|
+
description:
|
|
21280
|
+
'ID of the unmanaged access group that you want to get.',
|
|
21221
21281
|
format: 'uuid',
|
|
21222
21282
|
type: 'string',
|
|
21223
21283
|
},
|
|
@@ -21260,6 +21320,7 @@ export default {
|
|
|
21260
21320
|
'x-fern-sdk-method-name': 'get',
|
|
21261
21321
|
'x-fern-sdk-return-value': 'acs_access_group',
|
|
21262
21322
|
'x-response-key': 'acs_access_group',
|
|
21323
|
+
'x-title': 'Get an Unmanaged Access Group',
|
|
21263
21324
|
'x-undocumented':
|
|
21264
21325
|
'No unmanaged access groups are currently implemented.',
|
|
21265
21326
|
},
|
|
@@ -21276,13 +21337,13 @@ export default {
|
|
|
21276
21337
|
properties: {
|
|
21277
21338
|
acs_system_id: {
|
|
21278
21339
|
description:
|
|
21279
|
-
'ID of the access
|
|
21340
|
+
'ID of the access system for which you want to retrieve all unmanaged access groups.',
|
|
21280
21341
|
format: 'uuid',
|
|
21281
21342
|
type: 'string',
|
|
21282
21343
|
},
|
|
21283
21344
|
acs_user_id: {
|
|
21284
21345
|
description:
|
|
21285
|
-
'ID of the user for which you want to retrieve all unmanaged access groups.',
|
|
21346
|
+
'ID of the access system user for which you want to retrieve all unmanaged access groups.',
|
|
21286
21347
|
format: 'uuid',
|
|
21287
21348
|
type: 'string',
|
|
21288
21349
|
},
|
|
@@ -21327,19 +21388,26 @@ export default {
|
|
|
21327
21388
|
'x-fern-sdk-method-name': 'list',
|
|
21328
21389
|
'x-fern-sdk-return-value': 'acs_access_groups',
|
|
21329
21390
|
'x-response-key': 'acs_access_groups',
|
|
21391
|
+
'x-title': 'List Unmanaged Access Groups',
|
|
21330
21392
|
'x-undocumented':
|
|
21331
21393
|
'No unmanaged access groups are currently implemented.',
|
|
21332
21394
|
},
|
|
21333
21395
|
},
|
|
21334
21396
|
'/acs/credential_pools/list': {
|
|
21335
21397
|
post: {
|
|
21398
|
+
description: 'Returns a list of all credential pools.',
|
|
21336
21399
|
operationId: 'acsCredentialPoolsListPost',
|
|
21337
21400
|
requestBody: {
|
|
21338
21401
|
content: {
|
|
21339
21402
|
'application/json': {
|
|
21340
21403
|
schema: {
|
|
21341
21404
|
properties: {
|
|
21342
|
-
acs_system_id: {
|
|
21405
|
+
acs_system_id: {
|
|
21406
|
+
description:
|
|
21407
|
+
'ID of the access system for which you want to list credential pools.',
|
|
21408
|
+
format: 'uuid',
|
|
21409
|
+
type: 'string',
|
|
21410
|
+
},
|
|
21343
21411
|
},
|
|
21344
21412
|
required: ['acs_system_id'],
|
|
21345
21413
|
type: 'object',
|
|
@@ -21384,28 +21452,48 @@ export default {
|
|
|
21384
21452
|
'x-fern-sdk-method-name': 'list',
|
|
21385
21453
|
'x-fern-sdk-return-value': 'acs_credential_pools',
|
|
21386
21454
|
'x-response-key': 'acs_credential_pools',
|
|
21455
|
+
'x-title': 'List Credential Pools',
|
|
21387
21456
|
'x-undocumented': 'Replaced by enrollment automations.',
|
|
21388
21457
|
},
|
|
21389
21458
|
},
|
|
21390
21459
|
'/acs/credential_provisioning_automations/launch': {
|
|
21391
21460
|
post: {
|
|
21461
|
+
description: 'Launches a credential provisioning automation.',
|
|
21392
21462
|
operationId: 'acsCredentialProvisioningAutomationsLaunchPost',
|
|
21393
21463
|
requestBody: {
|
|
21394
21464
|
content: {
|
|
21395
21465
|
'application/json': {
|
|
21396
21466
|
schema: {
|
|
21397
21467
|
properties: {
|
|
21398
|
-
acs_credential_pool_id: {
|
|
21399
|
-
|
|
21468
|
+
acs_credential_pool_id: {
|
|
21469
|
+
description:
|
|
21470
|
+
'ID of the credential pool for which you want to launch a credential provisioning automation.',
|
|
21471
|
+
format: 'uuid',
|
|
21472
|
+
type: 'string',
|
|
21473
|
+
},
|
|
21474
|
+
create_credential_manager_user: {
|
|
21475
|
+
description:
|
|
21476
|
+
'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`.',
|
|
21477
|
+
type: 'boolean',
|
|
21478
|
+
},
|
|
21400
21479
|
credential_manager_acs_system_id: {
|
|
21480
|
+
description:
|
|
21481
|
+
'Access system ID of the credential manager for which you want to launch a credential provisioning automation.',
|
|
21401
21482
|
format: 'uuid',
|
|
21402
21483
|
type: 'string',
|
|
21403
21484
|
},
|
|
21404
21485
|
credential_manager_acs_user_id: {
|
|
21486
|
+
description:
|
|
21487
|
+
'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`.',
|
|
21488
|
+
format: 'uuid',
|
|
21489
|
+
type: 'string',
|
|
21490
|
+
},
|
|
21491
|
+
user_identity_id: {
|
|
21492
|
+
description:
|
|
21493
|
+
'ID of the user identity for which you want to launch a credential provisioning automation.',
|
|
21405
21494
|
format: 'uuid',
|
|
21406
21495
|
type: 'string',
|
|
21407
21496
|
},
|
|
21408
|
-
user_identity_id: { format: 'uuid', type: 'string' },
|
|
21409
21497
|
},
|
|
21410
21498
|
required: [
|
|
21411
21499
|
'user_identity_id',
|
|
@@ -21450,13 +21538,14 @@ export default {
|
|
|
21450
21538
|
'x-fern-sdk-method-name': 'launch',
|
|
21451
21539
|
'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
|
|
21452
21540
|
'x-response-key': 'acs_credential_provisioning_automation',
|
|
21541
|
+
'x-title': 'Launch a Credential Provisioning Automation',
|
|
21453
21542
|
'x-undocumented': 'Replaced by enrollment automations.',
|
|
21454
21543
|
},
|
|
21455
21544
|
},
|
|
21456
21545
|
'/acs/credentials/assign': {
|
|
21457
21546
|
patch: {
|
|
21458
21547
|
description:
|
|
21459
|
-
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [
|
|
21548
|
+
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
21460
21549
|
operationId: 'acsCredentialsAssignPatch',
|
|
21461
21550
|
requestBody: {
|
|
21462
21551
|
content: {
|
|
@@ -21464,12 +21553,14 @@ export default {
|
|
|
21464
21553
|
schema: {
|
|
21465
21554
|
properties: {
|
|
21466
21555
|
acs_credential_id: {
|
|
21467
|
-
description:
|
|
21556
|
+
description:
|
|
21557
|
+
'ID of the credential that you want to assign to an access system user.',
|
|
21468
21558
|
format: 'uuid',
|
|
21469
21559
|
type: 'string',
|
|
21470
21560
|
},
|
|
21471
21561
|
acs_user_id: {
|
|
21472
|
-
description:
|
|
21562
|
+
description:
|
|
21563
|
+
'ID of the access system user to whom you want to assign a credential.',
|
|
21473
21564
|
format: 'uuid',
|
|
21474
21565
|
type: 'string',
|
|
21475
21566
|
},
|
|
@@ -21514,7 +21605,7 @@ export default {
|
|
|
21514
21605
|
},
|
|
21515
21606
|
post: {
|
|
21516
21607
|
description:
|
|
21517
|
-
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [
|
|
21608
|
+
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
21518
21609
|
operationId: 'acsCredentialsAssignPost',
|
|
21519
21610
|
requestBody: {
|
|
21520
21611
|
content: {
|
|
@@ -21522,12 +21613,14 @@ export default {
|
|
|
21522
21613
|
schema: {
|
|
21523
21614
|
properties: {
|
|
21524
21615
|
acs_credential_id: {
|
|
21525
|
-
description:
|
|
21616
|
+
description:
|
|
21617
|
+
'ID of the credential that you want to assign to an access system user.',
|
|
21526
21618
|
format: 'uuid',
|
|
21527
21619
|
type: 'string',
|
|
21528
21620
|
},
|
|
21529
21621
|
acs_user_id: {
|
|
21530
|
-
description:
|
|
21622
|
+
description:
|
|
21623
|
+
'ID of the access system user to whom you want to assign a credential.',
|
|
21531
21624
|
format: 'uuid',
|
|
21532
21625
|
type: 'string',
|
|
21533
21626
|
},
|
|
@@ -21590,13 +21683,13 @@ export default {
|
|
|
21590
21683
|
},
|
|
21591
21684
|
acs_system_id: {
|
|
21592
21685
|
description:
|
|
21593
|
-
'ID of the
|
|
21686
|
+
'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`.',
|
|
21594
21687
|
format: 'uuid',
|
|
21595
21688
|
type: 'string',
|
|
21596
21689
|
},
|
|
21597
21690
|
acs_user_id: {
|
|
21598
21691
|
description:
|
|
21599
|
-
'ID of the
|
|
21692
|
+
'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`.',
|
|
21600
21693
|
format: 'uuid',
|
|
21601
21694
|
type: 'string',
|
|
21602
21695
|
},
|
|
@@ -21649,8 +21742,16 @@ export default {
|
|
|
21649
21742
|
description:
|
|
21650
21743
|
'Salto Space-specific metadata for the new credential.',
|
|
21651
21744
|
properties: {
|
|
21652
|
-
assign_new_key: {
|
|
21653
|
-
|
|
21745
|
+
assign_new_key: {
|
|
21746
|
+
description:
|
|
21747
|
+
'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).',
|
|
21748
|
+
type: 'boolean',
|
|
21749
|
+
},
|
|
21750
|
+
update_current_key: {
|
|
21751
|
+
description:
|
|
21752
|
+
"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).",
|
|
21753
|
+
type: 'boolean',
|
|
21754
|
+
},
|
|
21654
21755
|
},
|
|
21655
21756
|
type: 'object',
|
|
21656
21757
|
},
|
|
@@ -21662,7 +21763,7 @@ export default {
|
|
|
21662
21763
|
},
|
|
21663
21764
|
user_identity_id: {
|
|
21664
21765
|
description:
|
|
21665
|
-
'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
|
|
21766
|
+
'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.',
|
|
21666
21767
|
format: 'uuid',
|
|
21667
21768
|
type: 'string',
|
|
21668
21769
|
},
|
|
@@ -21748,7 +21849,7 @@ export default {
|
|
|
21748
21849
|
'/acs/credentials/create_offline_code': {
|
|
21749
21850
|
post: {
|
|
21750
21851
|
description:
|
|
21751
|
-
'Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [
|
|
21852
|
+
'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).',
|
|
21752
21853
|
operationId: 'acsCredentialsCreateOfflineCodePost',
|
|
21753
21854
|
requestBody: {
|
|
21754
21855
|
content: {
|
|
@@ -21757,7 +21858,7 @@ export default {
|
|
|
21757
21858
|
properties: {
|
|
21758
21859
|
acs_user_id: {
|
|
21759
21860
|
description:
|
|
21760
|
-
'ID of the
|
|
21861
|
+
'ID of the access system user to whom the new credential belongs.',
|
|
21761
21862
|
format: 'uuid',
|
|
21762
21863
|
type: 'string',
|
|
21763
21864
|
},
|
|
@@ -21839,7 +21940,8 @@ export default {
|
|
|
21839
21940
|
schema: {
|
|
21840
21941
|
properties: {
|
|
21841
21942
|
acs_credential_id: {
|
|
21842
|
-
description:
|
|
21943
|
+
description:
|
|
21944
|
+
'ID of the credential that you want to delete.',
|
|
21843
21945
|
format: 'uuid',
|
|
21844
21946
|
type: 'string',
|
|
21845
21947
|
},
|
|
@@ -21890,7 +21992,7 @@ export default {
|
|
|
21890
21992
|
schema: {
|
|
21891
21993
|
properties: {
|
|
21892
21994
|
acs_credential_id: {
|
|
21893
|
-
description: 'ID of the
|
|
21995
|
+
description: 'ID of the credential that you want to get.',
|
|
21894
21996
|
format: 'uuid',
|
|
21895
21997
|
type: 'string',
|
|
21896
21998
|
},
|
|
@@ -21952,7 +22054,7 @@ export default {
|
|
|
21952
22054
|
properties: {
|
|
21953
22055
|
acs_user_id: {
|
|
21954
22056
|
description:
|
|
21955
|
-
'ID of the
|
|
22057
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
21956
22058
|
format: 'uuid',
|
|
21957
22059
|
type: 'string',
|
|
21958
22060
|
},
|
|
@@ -21964,7 +22066,7 @@ export default {
|
|
|
21964
22066
|
properties: {
|
|
21965
22067
|
acs_system_id: {
|
|
21966
22068
|
description:
|
|
21967
|
-
'ID of the access
|
|
22069
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
21968
22070
|
format: 'uuid',
|
|
21969
22071
|
type: 'string',
|
|
21970
22072
|
},
|
|
@@ -21976,13 +22078,13 @@ export default {
|
|
|
21976
22078
|
properties: {
|
|
21977
22079
|
acs_system_id: {
|
|
21978
22080
|
description:
|
|
21979
|
-
'ID of the access
|
|
22081
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
21980
22082
|
format: 'uuid',
|
|
21981
22083
|
type: 'string',
|
|
21982
22084
|
},
|
|
21983
22085
|
acs_user_id: {
|
|
21984
22086
|
description:
|
|
21985
|
-
'ID of the
|
|
22087
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
21986
22088
|
format: 'uuid',
|
|
21987
22089
|
type: 'string',
|
|
21988
22090
|
},
|
|
@@ -22081,7 +22183,7 @@ export default {
|
|
|
22081
22183
|
properties: {
|
|
22082
22184
|
acs_credential_id: {
|
|
22083
22185
|
description:
|
|
22084
|
-
'ID of the credential for which you want to retrieve all entrances to which
|
|
22186
|
+
'ID of the credential for which you want to retrieve all entrances to which the credential grants access.',
|
|
22085
22187
|
format: 'uuid',
|
|
22086
22188
|
type: 'string',
|
|
22087
22189
|
},
|
|
@@ -22131,7 +22233,7 @@ export default {
|
|
|
22131
22233
|
'/acs/credentials/unassign': {
|
|
22132
22234
|
patch: {
|
|
22133
22235
|
description:
|
|
22134
|
-
'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [
|
|
22236
|
+
'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).',
|
|
22135
22237
|
operationId: 'acsCredentialsUnassignPatch',
|
|
22136
22238
|
requestBody: {
|
|
22137
22239
|
content: {
|
|
@@ -22139,12 +22241,14 @@ export default {
|
|
|
22139
22241
|
schema: {
|
|
22140
22242
|
properties: {
|
|
22141
22243
|
acs_credential_id: {
|
|
22142
|
-
description:
|
|
22244
|
+
description:
|
|
22245
|
+
'ID of the credential that you want to unassign from an access system user.',
|
|
22143
22246
|
format: 'uuid',
|
|
22144
22247
|
type: 'string',
|
|
22145
22248
|
},
|
|
22146
22249
|
acs_user_id: {
|
|
22147
|
-
description:
|
|
22250
|
+
description:
|
|
22251
|
+
'ID of the access system user from which you want to unassign a credential.',
|
|
22148
22252
|
format: 'uuid',
|
|
22149
22253
|
type: 'string',
|
|
22150
22254
|
},
|
|
@@ -22189,7 +22293,7 @@ export default {
|
|
|
22189
22293
|
},
|
|
22190
22294
|
post: {
|
|
22191
22295
|
description:
|
|
22192
|
-
'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [
|
|
22296
|
+
'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).',
|
|
22193
22297
|
operationId: 'acsCredentialsUnassignPost',
|
|
22194
22298
|
requestBody: {
|
|
22195
22299
|
content: {
|
|
@@ -22197,12 +22301,14 @@ export default {
|
|
|
22197
22301
|
schema: {
|
|
22198
22302
|
properties: {
|
|
22199
22303
|
acs_credential_id: {
|
|
22200
|
-
description:
|
|
22304
|
+
description:
|
|
22305
|
+
'ID of the credential that you want to unassign from an access system user.',
|
|
22201
22306
|
format: 'uuid',
|
|
22202
22307
|
type: 'string',
|
|
22203
22308
|
},
|
|
22204
22309
|
acs_user_id: {
|
|
22205
|
-
description:
|
|
22310
|
+
description:
|
|
22311
|
+
'ID of the access system user from which you want to unassign a credential.',
|
|
22206
22312
|
format: 'uuid',
|
|
22207
22313
|
type: 'string',
|
|
22208
22314
|
},
|
|
@@ -22258,7 +22364,8 @@ export default {
|
|
|
22258
22364
|
schema: {
|
|
22259
22365
|
properties: {
|
|
22260
22366
|
acs_credential_id: {
|
|
22261
|
-
description:
|
|
22367
|
+
description:
|
|
22368
|
+
'ID of the unmanaged credential that you want to get.',
|
|
22262
22369
|
format: 'uuid',
|
|
22263
22370
|
type: 'string',
|
|
22264
22371
|
},
|
|
@@ -22316,10 +22423,12 @@ export default {
|
|
|
22316
22423
|
schema: {
|
|
22317
22424
|
oneOf: [
|
|
22318
22425
|
{
|
|
22426
|
+
description:
|
|
22427
|
+
'ID of the access system user for which you want to list unmanaged credentials.',
|
|
22319
22428
|
properties: {
|
|
22320
22429
|
acs_user_id: {
|
|
22321
22430
|
description:
|
|
22322
|
-
'ID of the
|
|
22431
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
22323
22432
|
format: 'uuid',
|
|
22324
22433
|
type: 'string',
|
|
22325
22434
|
},
|
|
@@ -22328,10 +22437,12 @@ export default {
|
|
|
22328
22437
|
type: 'object',
|
|
22329
22438
|
},
|
|
22330
22439
|
{
|
|
22440
|
+
description:
|
|
22441
|
+
'ID of the access system for which you want to list unmanaged credentials.',
|
|
22331
22442
|
properties: {
|
|
22332
22443
|
acs_system_id: {
|
|
22333
22444
|
description:
|
|
22334
|
-
'ID of the access
|
|
22445
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
22335
22446
|
format: 'uuid',
|
|
22336
22447
|
type: 'string',
|
|
22337
22448
|
},
|
|
@@ -22340,16 +22451,18 @@ export default {
|
|
|
22340
22451
|
type: 'object',
|
|
22341
22452
|
},
|
|
22342
22453
|
{
|
|
22454
|
+
description:
|
|
22455
|
+
'ID of the access system and ID of the access system user for which you want to list unmanaged credentials.',
|
|
22343
22456
|
properties: {
|
|
22344
22457
|
acs_system_id: {
|
|
22345
22458
|
description:
|
|
22346
|
-
'ID of the access
|
|
22459
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
22347
22460
|
format: 'uuid',
|
|
22348
22461
|
type: 'string',
|
|
22349
22462
|
},
|
|
22350
22463
|
acs_user_id: {
|
|
22351
22464
|
description:
|
|
22352
|
-
'ID of the
|
|
22465
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
22353
22466
|
format: 'uuid',
|
|
22354
22467
|
type: 'string',
|
|
22355
22468
|
},
|
|
@@ -22358,6 +22471,8 @@ export default {
|
|
|
22358
22471
|
type: 'object',
|
|
22359
22472
|
},
|
|
22360
22473
|
{
|
|
22474
|
+
description:
|
|
22475
|
+
'ID of the user identity for which you want to list unmanaged credentials.',
|
|
22361
22476
|
properties: {
|
|
22362
22477
|
user_identity_id: {
|
|
22363
22478
|
description:
|
|
@@ -22424,12 +22539,13 @@ export default {
|
|
|
22424
22539
|
schema: {
|
|
22425
22540
|
properties: {
|
|
22426
22541
|
acs_credential_id: {
|
|
22427
|
-
description:
|
|
22542
|
+
description:
|
|
22543
|
+
'ID of the credential that you want to update.',
|
|
22428
22544
|
type: 'string',
|
|
22429
22545
|
},
|
|
22430
22546
|
code: {
|
|
22431
22547
|
description:
|
|
22432
|
-
'Replacement access (PIN) code for the credential.',
|
|
22548
|
+
'Replacement access (PIN) code for the credential that you want to update.',
|
|
22433
22549
|
pattern: '^\\d+$',
|
|
22434
22550
|
type: 'string',
|
|
22435
22551
|
},
|
|
@@ -22488,12 +22604,13 @@ export default {
|
|
|
22488
22604
|
schema: {
|
|
22489
22605
|
properties: {
|
|
22490
22606
|
acs_credential_id: {
|
|
22491
|
-
description:
|
|
22607
|
+
description:
|
|
22608
|
+
'ID of the credential that you want to update.',
|
|
22492
22609
|
type: 'string',
|
|
22493
22610
|
},
|
|
22494
22611
|
code: {
|
|
22495
22612
|
description:
|
|
22496
|
-
'Replacement access (PIN) code for the credential.',
|
|
22613
|
+
'Replacement access (PIN) code for the credential that you want to update.',
|
|
22497
22614
|
pattern: '^\\d+$',
|
|
22498
22615
|
type: 'string',
|
|
22499
22616
|
},
|
|
@@ -22685,7 +22802,7 @@ export default {
|
|
|
22685
22802
|
schema: {
|
|
22686
22803
|
properties: {
|
|
22687
22804
|
acs_encoder_id: {
|
|
22688
|
-
description: 'ID of the
|
|
22805
|
+
description: 'ID of the encoder that you want to get.',
|
|
22689
22806
|
format: 'uuid',
|
|
22690
22807
|
type: 'string',
|
|
22691
22808
|
},
|
|
@@ -22743,13 +22860,13 @@ export default {
|
|
|
22743
22860
|
properties: {
|
|
22744
22861
|
acs_system_id: {
|
|
22745
22862
|
description:
|
|
22746
|
-
'ID of the
|
|
22863
|
+
'ID of the access system for which you want to retrieve all encoders.',
|
|
22747
22864
|
format: 'uuid',
|
|
22748
22865
|
type: 'string',
|
|
22749
22866
|
},
|
|
22750
22867
|
limit: {
|
|
22751
22868
|
default: 500,
|
|
22752
|
-
description: 'Number of
|
|
22869
|
+
description: 'Number of encoders to return.',
|
|
22753
22870
|
format: 'float',
|
|
22754
22871
|
type: 'number',
|
|
22755
22872
|
},
|
|
@@ -22761,13 +22878,13 @@ export default {
|
|
|
22761
22878
|
properties: {
|
|
22762
22879
|
acs_system_ids: {
|
|
22763
22880
|
description:
|
|
22764
|
-
'IDs of the
|
|
22881
|
+
'IDs of the access systems for which you want to retrieve all encoders.',
|
|
22765
22882
|
items: { format: 'uuid', type: 'string' },
|
|
22766
22883
|
type: 'array',
|
|
22767
22884
|
},
|
|
22768
22885
|
limit: {
|
|
22769
22886
|
default: 500,
|
|
22770
|
-
description: 'Number of
|
|
22887
|
+
description: 'Number of encoders to return.',
|
|
22771
22888
|
format: 'float',
|
|
22772
22889
|
type: 'number',
|
|
22773
22890
|
},
|
|
@@ -22779,13 +22896,13 @@ export default {
|
|
|
22779
22896
|
properties: {
|
|
22780
22897
|
acs_encoder_ids: {
|
|
22781
22898
|
description:
|
|
22782
|
-
'IDs of the
|
|
22899
|
+
'IDs of the encoders that you want to retrieve.',
|
|
22783
22900
|
items: { format: 'uuid', type: 'string' },
|
|
22784
22901
|
type: 'array',
|
|
22785
22902
|
},
|
|
22786
22903
|
limit: {
|
|
22787
22904
|
default: 500,
|
|
22788
|
-
description: 'Number of
|
|
22905
|
+
description: 'Number of encoders to return.',
|
|
22789
22906
|
format: 'float',
|
|
22790
22907
|
type: 'number',
|
|
22791
22908
|
},
|
|
@@ -22845,7 +22962,7 @@ export default {
|
|
|
22845
22962
|
schema: {
|
|
22846
22963
|
properties: {
|
|
22847
22964
|
acs_encoder_id: {
|
|
22848
|
-
description: 'ID of the
|
|
22965
|
+
description: 'ID of the encoder to use for the scan.',
|
|
22849
22966
|
format: 'uuid',
|
|
22850
22967
|
type: 'string',
|
|
22851
22968
|
},
|
|
@@ -23232,14 +23349,18 @@ export default {
|
|
|
23232
23349
|
'/acs/entrances/get': {
|
|
23233
23350
|
post: {
|
|
23234
23351
|
description:
|
|
23235
|
-
'Returns a specified [
|
|
23352
|
+
'Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
23236
23353
|
operationId: 'acsEntrancesGetPost',
|
|
23237
23354
|
requestBody: {
|
|
23238
23355
|
content: {
|
|
23239
23356
|
'application/json': {
|
|
23240
23357
|
schema: {
|
|
23241
23358
|
properties: {
|
|
23242
|
-
acs_entrance_id: {
|
|
23359
|
+
acs_entrance_id: {
|
|
23360
|
+
description: 'ID of the entrance that you want to get.',
|
|
23361
|
+
format: 'uuid',
|
|
23362
|
+
type: 'string',
|
|
23363
|
+
},
|
|
23243
23364
|
},
|
|
23244
23365
|
required: ['acs_entrance_id'],
|
|
23245
23366
|
type: 'object',
|
|
@@ -23283,14 +23404,26 @@ export default {
|
|
|
23283
23404
|
},
|
|
23284
23405
|
'/acs/entrances/grant_access': {
|
|
23285
23406
|
post: {
|
|
23407
|
+
description:
|
|
23408
|
+
'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).',
|
|
23286
23409
|
operationId: 'acsEntrancesGrantAccessPost',
|
|
23287
23410
|
requestBody: {
|
|
23288
23411
|
content: {
|
|
23289
23412
|
'application/json': {
|
|
23290
23413
|
schema: {
|
|
23291
23414
|
properties: {
|
|
23292
|
-
acs_entrance_id: {
|
|
23293
|
-
|
|
23415
|
+
acs_entrance_id: {
|
|
23416
|
+
description:
|
|
23417
|
+
'ID of the entrance to which you want to grant an access system user access.',
|
|
23418
|
+
format: 'uuid',
|
|
23419
|
+
type: 'string',
|
|
23420
|
+
},
|
|
23421
|
+
acs_user_id: {
|
|
23422
|
+
description:
|
|
23423
|
+
'ID of the access system user to whom you want to grant access to an entrance.',
|
|
23424
|
+
format: 'uuid',
|
|
23425
|
+
type: 'string',
|
|
23426
|
+
},
|
|
23294
23427
|
},
|
|
23295
23428
|
required: ['acs_entrance_id', 'acs_user_id'],
|
|
23296
23429
|
type: 'object',
|
|
@@ -23330,16 +23463,28 @@ export default {
|
|
|
23330
23463
|
'/acs/entrances/list': {
|
|
23331
23464
|
post: {
|
|
23332
23465
|
description:
|
|
23333
|
-
'Returns a list of all [
|
|
23466
|
+
'Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
23334
23467
|
operationId: 'acsEntrancesListPost',
|
|
23335
23468
|
requestBody: {
|
|
23336
23469
|
content: {
|
|
23337
23470
|
'application/json': {
|
|
23338
23471
|
schema: {
|
|
23339
23472
|
properties: {
|
|
23340
|
-
acs_credential_id: {
|
|
23341
|
-
|
|
23473
|
+
acs_credential_id: {
|
|
23474
|
+
description:
|
|
23475
|
+
'ID of the credential for which you want to retrieve all entrances.',
|
|
23476
|
+
format: 'uuid',
|
|
23477
|
+
type: 'string',
|
|
23478
|
+
},
|
|
23479
|
+
acs_system_id: {
|
|
23480
|
+
description:
|
|
23481
|
+
'ID of the access system for which you want to retrieve all entrances.',
|
|
23482
|
+
format: 'uuid',
|
|
23483
|
+
type: 'string',
|
|
23484
|
+
},
|
|
23342
23485
|
location_id: {
|
|
23486
|
+
description:
|
|
23487
|
+
'ID of the location for which you want to retrieve all entrances.',
|
|
23343
23488
|
format: 'uuid',
|
|
23344
23489
|
nullable: true,
|
|
23345
23490
|
type: 'string',
|
|
@@ -23398,8 +23543,15 @@ export default {
|
|
|
23398
23543
|
'application/json': {
|
|
23399
23544
|
schema: {
|
|
23400
23545
|
properties: {
|
|
23401
|
-
acs_entrance_id: {
|
|
23546
|
+
acs_entrance_id: {
|
|
23547
|
+
description:
|
|
23548
|
+
'ID of the entrance for which you want to list all credentials that grant access.',
|
|
23549
|
+
format: 'uuid',
|
|
23550
|
+
type: 'string',
|
|
23551
|
+
},
|
|
23402
23552
|
include_if: {
|
|
23553
|
+
description:
|
|
23554
|
+
'Conditions that credentials must meet to be included in the returned list.',
|
|
23403
23555
|
items: {
|
|
23404
23556
|
enum: ['visionline_metadata.is_valid'],
|
|
23405
23557
|
type: 'string',
|
|
@@ -23453,7 +23605,7 @@ export default {
|
|
|
23453
23605
|
'/acs/systems/get': {
|
|
23454
23606
|
post: {
|
|
23455
23607
|
description:
|
|
23456
|
-
'Returns a specified [access
|
|
23608
|
+
'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
23457
23609
|
operationId: 'acsSystemsGetPost',
|
|
23458
23610
|
requestBody: {
|
|
23459
23611
|
content: {
|
|
@@ -23461,7 +23613,8 @@ export default {
|
|
|
23461
23613
|
schema: {
|
|
23462
23614
|
properties: {
|
|
23463
23615
|
acs_system_id: {
|
|
23464
|
-
description:
|
|
23616
|
+
description:
|
|
23617
|
+
'ID of the access system that you want to get.',
|
|
23465
23618
|
format: 'uuid',
|
|
23466
23619
|
type: 'string',
|
|
23467
23620
|
},
|
|
@@ -23508,7 +23661,7 @@ export default {
|
|
|
23508
23661
|
'/acs/systems/list': {
|
|
23509
23662
|
post: {
|
|
23510
23663
|
description:
|
|
23511
|
-
'Returns a list of all [access
|
|
23664
|
+
'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.',
|
|
23512
23665
|
operationId: 'acsSystemsListPost',
|
|
23513
23666
|
requestBody: {
|
|
23514
23667
|
content: {
|
|
@@ -23517,7 +23670,7 @@ export default {
|
|
|
23517
23670
|
properties: {
|
|
23518
23671
|
connected_account_id: {
|
|
23519
23672
|
description:
|
|
23520
|
-
'ID of the connected account by which to filter the list of
|
|
23673
|
+
'ID of the connected account by which you want to filter the list of access systems.',
|
|
23521
23674
|
format: 'uuid',
|
|
23522
23675
|
type: 'string',
|
|
23523
23676
|
},
|
|
@@ -23567,7 +23720,7 @@ export default {
|
|
|
23567
23720
|
'/acs/systems/list_compatible_credential_manager_acs_systems': {
|
|
23568
23721
|
post: {
|
|
23569
23722
|
description:
|
|
23570
|
-
'Returns a list of all credential manager
|
|
23723
|
+
'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.',
|
|
23571
23724
|
operationId: 'acsSystemsListCompatibleCredentialManagerAcsSystemsPost',
|
|
23572
23725
|
requestBody: {
|
|
23573
23726
|
content: {
|
|
@@ -23576,7 +23729,7 @@ export default {
|
|
|
23576
23729
|
properties: {
|
|
23577
23730
|
acs_system_id: {
|
|
23578
23731
|
description:
|
|
23579
|
-
'ID of the
|
|
23732
|
+
'ID of the access system for which you want to retrieve all compatible credential manager systems.',
|
|
23580
23733
|
format: 'uuid',
|
|
23581
23734
|
type: 'string',
|
|
23582
23735
|
},
|
|
@@ -23627,7 +23780,7 @@ export default {
|
|
|
23627
23780
|
'/acs/users/add_to_access_group': {
|
|
23628
23781
|
post: {
|
|
23629
23782
|
description:
|
|
23630
|
-
'Adds a specified [
|
|
23783
|
+
'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
23784
|
operationId: 'acsUsersAddToAccessGroupPost',
|
|
23632
23785
|
requestBody: {
|
|
23633
23786
|
content: {
|
|
@@ -23635,12 +23788,14 @@ export default {
|
|
|
23635
23788
|
schema: {
|
|
23636
23789
|
properties: {
|
|
23637
23790
|
acs_access_group_id: {
|
|
23638
|
-
description:
|
|
23791
|
+
description:
|
|
23792
|
+
'ID of the access group to which you want to add an access system user.',
|
|
23639
23793
|
format: 'uuid',
|
|
23640
23794
|
type: 'string',
|
|
23641
23795
|
},
|
|
23642
23796
|
acs_user_id: {
|
|
23643
|
-
description:
|
|
23797
|
+
description:
|
|
23798
|
+
'ID of the access system user that you want to add to an access group.',
|
|
23644
23799
|
format: 'uuid',
|
|
23645
23800
|
type: 'string',
|
|
23646
23801
|
},
|
|
@@ -23681,7 +23836,7 @@ export default {
|
|
|
23681
23836
|
},
|
|
23682
23837
|
put: {
|
|
23683
23838
|
description:
|
|
23684
|
-
'Adds a specified [
|
|
23839
|
+
'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).',
|
|
23685
23840
|
operationId: 'acsUsersAddToAccessGroupPut',
|
|
23686
23841
|
requestBody: {
|
|
23687
23842
|
content: {
|
|
@@ -23689,12 +23844,14 @@ export default {
|
|
|
23689
23844
|
schema: {
|
|
23690
23845
|
properties: {
|
|
23691
23846
|
acs_access_group_id: {
|
|
23692
|
-
description:
|
|
23847
|
+
description:
|
|
23848
|
+
'ID of the access group to which you want to add an access system user.',
|
|
23693
23849
|
format: 'uuid',
|
|
23694
23850
|
type: 'string',
|
|
23695
23851
|
},
|
|
23696
23852
|
acs_user_id: {
|
|
23697
|
-
description:
|
|
23853
|
+
description:
|
|
23854
|
+
'ID of the access system user that you want to add to an access group.',
|
|
23698
23855
|
format: 'uuid',
|
|
23699
23856
|
type: 'string',
|
|
23700
23857
|
},
|
|
@@ -23736,7 +23893,7 @@ export default {
|
|
|
23736
23893
|
'/acs/users/create': {
|
|
23737
23894
|
post: {
|
|
23738
23895
|
description:
|
|
23739
|
-
'Creates a new [
|
|
23896
|
+
'Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
23740
23897
|
operationId: 'acsUsersCreatePost',
|
|
23741
23898
|
requestBody: {
|
|
23742
23899
|
content: {
|
|
@@ -23745,27 +23902,34 @@ export default {
|
|
|
23745
23902
|
properties: {
|
|
23746
23903
|
access_schedule: {
|
|
23747
23904
|
description:
|
|
23748
|
-
"`starts_at` and `ends_at` timestamps for the new
|
|
23905
|
+
"`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`.",
|
|
23749
23906
|
properties: {
|
|
23750
23907
|
ends_at: {
|
|
23908
|
+
description:
|
|
23909
|
+
"Ending timestamp for the new access system user's access.",
|
|
23751
23910
|
format: 'date-time',
|
|
23752
23911
|
nullable: true,
|
|
23753
23912
|
type: 'string',
|
|
23754
23913
|
},
|
|
23755
|
-
starts_at: {
|
|
23914
|
+
starts_at: {
|
|
23915
|
+
description:
|
|
23916
|
+
"Starting timestamp for the new access system user's access.",
|
|
23917
|
+
format: 'date-time',
|
|
23918
|
+
type: 'string',
|
|
23919
|
+
},
|
|
23756
23920
|
},
|
|
23757
23921
|
type: 'object',
|
|
23758
23922
|
},
|
|
23759
23923
|
acs_access_group_ids: {
|
|
23760
23924
|
default: [],
|
|
23761
23925
|
description:
|
|
23762
|
-
'Array of
|
|
23926
|
+
'Array of access group IDs to indicate the access groups to which you want to add the new access system user.',
|
|
23763
23927
|
items: { format: 'uuid', type: 'string' },
|
|
23764
23928
|
type: 'array',
|
|
23765
23929
|
},
|
|
23766
23930
|
acs_system_id: {
|
|
23767
23931
|
description:
|
|
23768
|
-
'ID of the
|
|
23932
|
+
'ID of the access system to which you want to add the new access system user.',
|
|
23769
23933
|
format: 'uuid',
|
|
23770
23934
|
type: 'string',
|
|
23771
23935
|
},
|
|
@@ -23782,7 +23946,7 @@ export default {
|
|
|
23782
23946
|
type: 'string',
|
|
23783
23947
|
},
|
|
23784
23948
|
full_name: {
|
|
23785
|
-
description: 'Full name of the new
|
|
23949
|
+
description: 'Full name of the new access system user.',
|
|
23786
23950
|
type: 'string',
|
|
23787
23951
|
},
|
|
23788
23952
|
phone_number: {
|
|
@@ -23792,7 +23956,7 @@ export default {
|
|
|
23792
23956
|
},
|
|
23793
23957
|
user_identity_id: {
|
|
23794
23958
|
description:
|
|
23795
|
-
'ID of the user identity with which to associate the new
|
|
23959
|
+
'ID of the user identity with which you want to associate the new access system user.',
|
|
23796
23960
|
format: 'uuid',
|
|
23797
23961
|
type: 'string',
|
|
23798
23962
|
},
|
|
@@ -23839,7 +24003,7 @@ export default {
|
|
|
23839
24003
|
'/acs/users/delete': {
|
|
23840
24004
|
post: {
|
|
23841
24005
|
description:
|
|
23842
|
-
"Deletes a specified [
|
|
24006
|
+
"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).",
|
|
23843
24007
|
operationId: 'acsUsersDeletePost',
|
|
23844
24008
|
requestBody: {
|
|
23845
24009
|
content: {
|
|
@@ -23847,7 +24011,8 @@ export default {
|
|
|
23847
24011
|
schema: {
|
|
23848
24012
|
properties: {
|
|
23849
24013
|
acs_user_id: {
|
|
23850
|
-
description:
|
|
24014
|
+
description:
|
|
24015
|
+
'ID of the access system user that you want to delete.',
|
|
23851
24016
|
format: 'uuid',
|
|
23852
24017
|
type: 'string',
|
|
23853
24018
|
},
|
|
@@ -23890,7 +24055,7 @@ export default {
|
|
|
23890
24055
|
'/acs/users/get': {
|
|
23891
24056
|
post: {
|
|
23892
24057
|
description:
|
|
23893
|
-
'Returns a specified [
|
|
24058
|
+
'Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
23894
24059
|
operationId: 'acsUsersGetPost',
|
|
23895
24060
|
requestBody: {
|
|
23896
24061
|
content: {
|
|
@@ -23898,7 +24063,8 @@ export default {
|
|
|
23898
24063
|
schema: {
|
|
23899
24064
|
properties: {
|
|
23900
24065
|
acs_user_id: {
|
|
23901
|
-
description:
|
|
24066
|
+
description:
|
|
24067
|
+
'ID of the access system user that you want to get.',
|
|
23902
24068
|
format: 'uuid',
|
|
23903
24069
|
type: 'string',
|
|
23904
24070
|
},
|
|
@@ -23945,7 +24111,7 @@ export default {
|
|
|
23945
24111
|
'/acs/users/list': {
|
|
23946
24112
|
post: {
|
|
23947
24113
|
description:
|
|
23948
|
-
'Returns a list of all [
|
|
24114
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
23949
24115
|
operationId: 'acsUsersListPost',
|
|
23950
24116
|
requestBody: {
|
|
23951
24117
|
content: {
|
|
@@ -23954,11 +24120,16 @@ export default {
|
|
|
23954
24120
|
properties: {
|
|
23955
24121
|
acs_system_id: {
|
|
23956
24122
|
description:
|
|
23957
|
-
'ID of the `acs_system` for which you want to retrieve all
|
|
24123
|
+
'ID of the `acs_system` for which you want to retrieve all access system users.',
|
|
23958
24124
|
format: 'uuid',
|
|
23959
24125
|
type: 'string',
|
|
23960
24126
|
},
|
|
23961
|
-
created_before: {
|
|
24127
|
+
created_before: {
|
|
24128
|
+
description:
|
|
24129
|
+
'Timestamp by which to limit returned access system users. Returns users created before this timestamp.',
|
|
24130
|
+
format: 'date-time',
|
|
24131
|
+
type: 'string',
|
|
24132
|
+
},
|
|
23962
24133
|
limit: {
|
|
23963
24134
|
default: 500,
|
|
23964
24135
|
description:
|
|
@@ -23975,24 +24146,24 @@ export default {
|
|
|
23975
24146
|
},
|
|
23976
24147
|
search: {
|
|
23977
24148
|
description:
|
|
23978
|
-
'String for which to search. Filters returned
|
|
24149
|
+
'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`.',
|
|
23979
24150
|
minLength: 1,
|
|
23980
24151
|
type: 'string',
|
|
23981
24152
|
},
|
|
23982
24153
|
user_identity_email_address: {
|
|
23983
24154
|
description:
|
|
23984
|
-
'Email address of the user identity for which you want to retrieve all
|
|
24155
|
+
'Email address of the user identity for which you want to retrieve all access system users.',
|
|
23985
24156
|
type: 'string',
|
|
23986
24157
|
},
|
|
23987
24158
|
user_identity_id: {
|
|
23988
24159
|
description:
|
|
23989
|
-
'ID of the user identity for which you want to retrieve all
|
|
24160
|
+
'ID of the user identity for which you want to retrieve all access system users.',
|
|
23990
24161
|
format: 'uuid',
|
|
23991
24162
|
type: 'string',
|
|
23992
24163
|
},
|
|
23993
24164
|
user_identity_phone_number: {
|
|
23994
24165
|
description:
|
|
23995
|
-
'Phone number of the user identity for which you want to retrieve all
|
|
24166
|
+
'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`).',
|
|
23996
24167
|
type: 'string',
|
|
23997
24168
|
},
|
|
23998
24169
|
},
|
|
@@ -24042,7 +24213,7 @@ export default {
|
|
|
24042
24213
|
'/acs/users/list_accessible_entrances': {
|
|
24043
24214
|
post: {
|
|
24044
24215
|
description:
|
|
24045
|
-
'Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [
|
|
24216
|
+
'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.',
|
|
24046
24217
|
operationId: 'acsUsersListAccessibleEntrancesPost',
|
|
24047
24218
|
requestBody: {
|
|
24048
24219
|
content: {
|
|
@@ -24050,7 +24221,8 @@ export default {
|
|
|
24050
24221
|
schema: {
|
|
24051
24222
|
properties: {
|
|
24052
24223
|
acs_user_id: {
|
|
24053
|
-
description:
|
|
24224
|
+
description:
|
|
24225
|
+
'ID of the access system user for whom you want to list accessible entrances.',
|
|
24054
24226
|
format: 'uuid',
|
|
24055
24227
|
type: 'string',
|
|
24056
24228
|
},
|
|
@@ -24101,7 +24273,7 @@ export default {
|
|
|
24101
24273
|
'/acs/users/remove_from_access_group': {
|
|
24102
24274
|
post: {
|
|
24103
24275
|
description:
|
|
24104
|
-
'Removes a specified [
|
|
24276
|
+
'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).',
|
|
24105
24277
|
operationId: 'acsUsersRemoveFromAccessGroupPost',
|
|
24106
24278
|
requestBody: {
|
|
24107
24279
|
content: {
|
|
@@ -24109,12 +24281,14 @@ export default {
|
|
|
24109
24281
|
schema: {
|
|
24110
24282
|
properties: {
|
|
24111
24283
|
acs_access_group_id: {
|
|
24112
|
-
description:
|
|
24284
|
+
description:
|
|
24285
|
+
'ID of the access group from which you want to remove an access system user.',
|
|
24113
24286
|
format: 'uuid',
|
|
24114
24287
|
type: 'string',
|
|
24115
24288
|
},
|
|
24116
24289
|
acs_user_id: {
|
|
24117
|
-
description:
|
|
24290
|
+
description:
|
|
24291
|
+
'ID of the access system user that you want to remove from an access group.',
|
|
24118
24292
|
format: 'uuid',
|
|
24119
24293
|
type: 'string',
|
|
24120
24294
|
},
|
|
@@ -24157,7 +24331,7 @@ export default {
|
|
|
24157
24331
|
'/acs/users/revoke_access_to_all_entrances': {
|
|
24158
24332
|
post: {
|
|
24159
24333
|
description:
|
|
24160
|
-
'Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [
|
|
24334
|
+
'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).',
|
|
24161
24335
|
operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
|
|
24162
24336
|
requestBody: {
|
|
24163
24337
|
content: {
|
|
@@ -24165,7 +24339,8 @@ export default {
|
|
|
24165
24339
|
schema: {
|
|
24166
24340
|
properties: {
|
|
24167
24341
|
acs_user_id: {
|
|
24168
|
-
description:
|
|
24342
|
+
description:
|
|
24343
|
+
'ID of the access system user for whom you want to revoke access.',
|
|
24169
24344
|
format: 'uuid',
|
|
24170
24345
|
type: 'string',
|
|
24171
24346
|
},
|
|
@@ -24208,7 +24383,7 @@ export default {
|
|
|
24208
24383
|
'/acs/users/suspend': {
|
|
24209
24384
|
post: {
|
|
24210
24385
|
description:
|
|
24211
|
-
"[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [
|
|
24386
|
+
"[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.",
|
|
24212
24387
|
operationId: 'acsUsersSuspendPost',
|
|
24213
24388
|
requestBody: {
|
|
24214
24389
|
content: {
|
|
@@ -24216,7 +24391,8 @@ export default {
|
|
|
24216
24391
|
schema: {
|
|
24217
24392
|
properties: {
|
|
24218
24393
|
acs_user_id: {
|
|
24219
|
-
description:
|
|
24394
|
+
description:
|
|
24395
|
+
'ID of the access system user that you want to suspend.',
|
|
24220
24396
|
format: 'uuid',
|
|
24221
24397
|
type: 'string',
|
|
24222
24398
|
},
|
|
@@ -24258,12 +24434,21 @@ export default {
|
|
|
24258
24434
|
},
|
|
24259
24435
|
'/acs/users/unmanaged/get': {
|
|
24260
24436
|
post: {
|
|
24437
|
+
description:
|
|
24438
|
+
'Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24261
24439
|
operationId: 'acsUsersUnmanagedGetPost',
|
|
24262
24440
|
requestBody: {
|
|
24263
24441
|
content: {
|
|
24264
24442
|
'application/json': {
|
|
24265
24443
|
schema: {
|
|
24266
|
-
properties: {
|
|
24444
|
+
properties: {
|
|
24445
|
+
acs_user_id: {
|
|
24446
|
+
description:
|
|
24447
|
+
'ID of the unmanaged access system user that you want to get.',
|
|
24448
|
+
format: 'uuid',
|
|
24449
|
+
type: 'string',
|
|
24450
|
+
},
|
|
24451
|
+
},
|
|
24267
24452
|
required: ['acs_user_id'],
|
|
24268
24453
|
type: 'object',
|
|
24269
24454
|
},
|
|
@@ -24302,22 +24487,49 @@ export default {
|
|
|
24302
24487
|
'x-fern-sdk-method-name': 'get',
|
|
24303
24488
|
'x-fern-sdk-return-value': 'acs_user',
|
|
24304
24489
|
'x-response-key': 'acs_user',
|
|
24490
|
+
'x-title': 'Get an Unmanaged ACS User',
|
|
24305
24491
|
'x-undocumented': 'No unmanaged users are currently implemented.',
|
|
24306
24492
|
},
|
|
24307
24493
|
},
|
|
24308
24494
|
'/acs/users/unmanaged/list': {
|
|
24309
24495
|
post: {
|
|
24496
|
+
description:
|
|
24497
|
+
'Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24310
24498
|
operationId: 'acsUsersUnmanagedListPost',
|
|
24311
24499
|
requestBody: {
|
|
24312
24500
|
content: {
|
|
24313
24501
|
'application/json': {
|
|
24314
24502
|
schema: {
|
|
24315
24503
|
properties: {
|
|
24316
|
-
acs_system_id: {
|
|
24317
|
-
|
|
24318
|
-
|
|
24319
|
-
|
|
24320
|
-
|
|
24504
|
+
acs_system_id: {
|
|
24505
|
+
description:
|
|
24506
|
+
'ID of the access system for which you want to retrieve all unmanaged access system users.',
|
|
24507
|
+
format: 'uuid',
|
|
24508
|
+
type: 'string',
|
|
24509
|
+
},
|
|
24510
|
+
limit: {
|
|
24511
|
+
default: 500,
|
|
24512
|
+
description:
|
|
24513
|
+
'Number of unmanaged access system users to return.',
|
|
24514
|
+
format: 'float',
|
|
24515
|
+
type: 'number',
|
|
24516
|
+
},
|
|
24517
|
+
user_identity_email_address: {
|
|
24518
|
+
description:
|
|
24519
|
+
'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
|
|
24520
|
+
type: 'string',
|
|
24521
|
+
},
|
|
24522
|
+
user_identity_id: {
|
|
24523
|
+
description:
|
|
24524
|
+
'ID of the user identity for which you want to retrieve all unmanaged access system users.',
|
|
24525
|
+
format: 'uuid',
|
|
24526
|
+
type: 'string',
|
|
24527
|
+
},
|
|
24528
|
+
user_identity_phone_number: {
|
|
24529
|
+
description:
|
|
24530
|
+
'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
|
|
24531
|
+
type: 'string',
|
|
24532
|
+
},
|
|
24321
24533
|
},
|
|
24322
24534
|
type: 'object',
|
|
24323
24535
|
},
|
|
@@ -24359,13 +24571,14 @@ export default {
|
|
|
24359
24571
|
'x-fern-sdk-method-name': 'list',
|
|
24360
24572
|
'x-fern-sdk-return-value': 'acs_users',
|
|
24361
24573
|
'x-response-key': 'acs_users',
|
|
24574
|
+
'x-title': 'List Unmanaged ACS Users',
|
|
24362
24575
|
'x-undocumented': 'No unmanaged users are currently implemented.',
|
|
24363
24576
|
},
|
|
24364
24577
|
},
|
|
24365
24578
|
'/acs/users/unsuspend': {
|
|
24366
24579
|
post: {
|
|
24367
24580
|
description:
|
|
24368
|
-
'[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [
|
|
24581
|
+
'[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.',
|
|
24369
24582
|
operationId: 'acsUsersUnsuspendPost',
|
|
24370
24583
|
requestBody: {
|
|
24371
24584
|
content: {
|
|
@@ -24373,7 +24586,8 @@ export default {
|
|
|
24373
24586
|
schema: {
|
|
24374
24587
|
properties: {
|
|
24375
24588
|
acs_user_id: {
|
|
24376
|
-
description:
|
|
24589
|
+
description:
|
|
24590
|
+
'ID of the access system user that you want to unsuspend.',
|
|
24377
24591
|
format: 'uuid',
|
|
24378
24592
|
type: 'string',
|
|
24379
24593
|
},
|
|
@@ -24416,7 +24630,7 @@ export default {
|
|
|
24416
24630
|
'/acs/users/update': {
|
|
24417
24631
|
patch: {
|
|
24418
24632
|
description:
|
|
24419
|
-
'Updates the properties of a specified [
|
|
24633
|
+
'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24420
24634
|
operationId: 'acsUsersUpdatePatch',
|
|
24421
24635
|
requestBody: {
|
|
24422
24636
|
content: {
|
|
@@ -24425,11 +24639,21 @@ export default {
|
|
|
24425
24639
|
properties: {
|
|
24426
24640
|
access_schedule: {
|
|
24427
24641
|
description:
|
|
24428
|
-
"`starts_at` and `ends_at` timestamps for the
|
|
24642
|
+
"`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`.",
|
|
24429
24643
|
nullable: true,
|
|
24430
24644
|
properties: {
|
|
24431
|
-
ends_at: {
|
|
24432
|
-
|
|
24645
|
+
ends_at: {
|
|
24646
|
+
description:
|
|
24647
|
+
"Ending timestamp for the access system user's access.",
|
|
24648
|
+
format: 'date-time',
|
|
24649
|
+
type: 'string',
|
|
24650
|
+
},
|
|
24651
|
+
starts_at: {
|
|
24652
|
+
description:
|
|
24653
|
+
"Starting timestamp for the access system user's access.",
|
|
24654
|
+
format: 'date-time',
|
|
24655
|
+
type: 'string',
|
|
24656
|
+
},
|
|
24433
24657
|
},
|
|
24434
24658
|
required: ['starts_at', 'ends_at'],
|
|
24435
24659
|
type: 'object',
|
|
@@ -24500,7 +24724,7 @@ export default {
|
|
|
24500
24724
|
},
|
|
24501
24725
|
post: {
|
|
24502
24726
|
description:
|
|
24503
|
-
'Updates the properties of a specified [
|
|
24727
|
+
'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24504
24728
|
operationId: 'acsUsersUpdatePost',
|
|
24505
24729
|
requestBody: {
|
|
24506
24730
|
content: {
|
|
@@ -24509,11 +24733,21 @@ export default {
|
|
|
24509
24733
|
properties: {
|
|
24510
24734
|
access_schedule: {
|
|
24511
24735
|
description:
|
|
24512
|
-
"`starts_at` and `ends_at` timestamps for the
|
|
24736
|
+
"`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`.",
|
|
24513
24737
|
nullable: true,
|
|
24514
24738
|
properties: {
|
|
24515
|
-
ends_at: {
|
|
24516
|
-
|
|
24739
|
+
ends_at: {
|
|
24740
|
+
description:
|
|
24741
|
+
"Ending timestamp for the access system user's access.",
|
|
24742
|
+
format: 'date-time',
|
|
24743
|
+
type: 'string',
|
|
24744
|
+
},
|
|
24745
|
+
starts_at: {
|
|
24746
|
+
description:
|
|
24747
|
+
"Starting timestamp for the access system user's access.",
|
|
24748
|
+
format: 'date-time',
|
|
24749
|
+
type: 'string',
|
|
24750
|
+
},
|
|
24517
24751
|
},
|
|
24518
24752
|
required: ['starts_at', 'ends_at'],
|
|
24519
24753
|
type: 'object',
|
|
@@ -24586,13 +24820,20 @@ export default {
|
|
|
24586
24820
|
},
|
|
24587
24821
|
'/action_attempts/get': {
|
|
24588
24822
|
post: {
|
|
24823
|
+
description:
|
|
24824
|
+
'Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
|
|
24589
24825
|
operationId: 'actionAttemptsGetPost',
|
|
24590
24826
|
requestBody: {
|
|
24591
24827
|
content: {
|
|
24592
24828
|
'application/json': {
|
|
24593
24829
|
schema: {
|
|
24594
24830
|
properties: {
|
|
24595
|
-
action_attempt_id: {
|
|
24831
|
+
action_attempt_id: {
|
|
24832
|
+
description:
|
|
24833
|
+
'ID of the action attempt that you want to get.',
|
|
24834
|
+
format: 'uuid',
|
|
24835
|
+
type: 'string',
|
|
24836
|
+
},
|
|
24596
24837
|
},
|
|
24597
24838
|
required: ['action_attempt_id'],
|
|
24598
24839
|
type: 'object',
|
|
@@ -24633,10 +24874,13 @@ export default {
|
|
|
24633
24874
|
'x-fern-sdk-method-name': 'get',
|
|
24634
24875
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
24635
24876
|
'x-response-key': 'action_attempt',
|
|
24877
|
+
'x-title': 'Get an Action Attempt',
|
|
24636
24878
|
},
|
|
24637
24879
|
},
|
|
24638
24880
|
'/action_attempts/list': {
|
|
24639
24881
|
post: {
|
|
24882
|
+
description:
|
|
24883
|
+
'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.',
|
|
24640
24884
|
operationId: 'actionAttemptsListPost',
|
|
24641
24885
|
requestBody: {
|
|
24642
24886
|
content: {
|
|
@@ -24644,6 +24888,8 @@ export default {
|
|
|
24644
24888
|
schema: {
|
|
24645
24889
|
properties: {
|
|
24646
24890
|
action_attempt_ids: {
|
|
24891
|
+
description:
|
|
24892
|
+
'IDs of the action attempts that you want to retrieve.',
|
|
24647
24893
|
items: { format: 'uuid', type: 'string' },
|
|
24648
24894
|
type: 'array',
|
|
24649
24895
|
},
|
|
@@ -24687,16 +24933,25 @@ export default {
|
|
|
24687
24933
|
'x-fern-sdk-method-name': 'list',
|
|
24688
24934
|
'x-fern-sdk-return-value': 'action_attempts',
|
|
24689
24935
|
'x-response-key': 'action_attempts',
|
|
24936
|
+
'x-title': 'List Action Attempts',
|
|
24690
24937
|
},
|
|
24691
24938
|
},
|
|
24692
24939
|
'/bridges/get': {
|
|
24693
24940
|
post: {
|
|
24941
|
+
description:
|
|
24942
|
+
'Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
|
|
24694
24943
|
operationId: 'bridgesGetPost',
|
|
24695
24944
|
requestBody: {
|
|
24696
24945
|
content: {
|
|
24697
24946
|
'application/json': {
|
|
24698
24947
|
schema: {
|
|
24699
|
-
properties: {
|
|
24948
|
+
properties: {
|
|
24949
|
+
bridge_id: {
|
|
24950
|
+
description: 'ID of the Seam Bridge that you want to get.',
|
|
24951
|
+
format: 'uuid',
|
|
24952
|
+
type: 'string',
|
|
24953
|
+
},
|
|
24954
|
+
},
|
|
24700
24955
|
required: ['bridge_id'],
|
|
24701
24956
|
type: 'object',
|
|
24702
24957
|
},
|
|
@@ -24743,10 +24998,14 @@ export default {
|
|
|
24743
24998
|
'x-fern-sdk-method-name': 'get',
|
|
24744
24999
|
'x-fern-sdk-return-value': 'bridge',
|
|
24745
25000
|
'x-response-key': 'bridge',
|
|
25001
|
+
'x-title': 'Get a Seam Bridge',
|
|
25002
|
+
'x-undocumented': 'Not yet for customer use.',
|
|
24746
25003
|
},
|
|
24747
25004
|
},
|
|
24748
25005
|
'/bridges/list': {
|
|
24749
25006
|
post: {
|
|
25007
|
+
description:
|
|
25008
|
+
'Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).',
|
|
24750
25009
|
operationId: 'bridgesListPost',
|
|
24751
25010
|
requestBody: {
|
|
24752
25011
|
content: {
|
|
@@ -24796,10 +25055,14 @@ export default {
|
|
|
24796
25055
|
'x-fern-sdk-method-name': 'list',
|
|
24797
25056
|
'x-fern-sdk-return-value': 'bridges',
|
|
24798
25057
|
'x-response-key': 'bridges',
|
|
25058
|
+
'x-title': 'List Seam Bridges',
|
|
25059
|
+
'x-undocumented': 'Not yet for customer use.',
|
|
24799
25060
|
},
|
|
24800
25061
|
},
|
|
24801
25062
|
'/client_sessions/create': {
|
|
24802
25063
|
post: {
|
|
25064
|
+
description:
|
|
25065
|
+
'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24803
25066
|
operationId: 'clientSessionsCreatePost',
|
|
24804
25067
|
requestBody: {
|
|
24805
25068
|
content: {
|
|
@@ -24807,16 +25070,32 @@ export default {
|
|
|
24807
25070
|
schema: {
|
|
24808
25071
|
properties: {
|
|
24809
25072
|
connect_webview_ids: {
|
|
25073
|
+
description:
|
|
25074
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
|
|
24810
25075
|
items: { type: 'string' },
|
|
24811
25076
|
type: 'array',
|
|
24812
25077
|
},
|
|
24813
25078
|
connected_account_ids: {
|
|
25079
|
+
description:
|
|
25080
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
|
|
24814
25081
|
items: { type: 'string' },
|
|
24815
25082
|
type: 'array',
|
|
24816
25083
|
},
|
|
24817
|
-
expires_at: {
|
|
24818
|
-
|
|
25084
|
+
expires_at: {
|
|
25085
|
+
description:
|
|
25086
|
+
'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.',
|
|
25087
|
+
format: 'date-time',
|
|
25088
|
+
type: 'string',
|
|
25089
|
+
},
|
|
25090
|
+
user_identifier_key: {
|
|
25091
|
+
description:
|
|
25092
|
+
'Your user ID for the user for whom you want to create a client session.',
|
|
25093
|
+
minLength: 1,
|
|
25094
|
+
type: 'string',
|
|
25095
|
+
},
|
|
24819
25096
|
user_identity_ids: {
|
|
25097
|
+
description:
|
|
25098
|
+
'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.',
|
|
24820
25099
|
items: { type: 'string' },
|
|
24821
25100
|
type: 'array',
|
|
24822
25101
|
},
|
|
@@ -24859,8 +25138,11 @@ export default {
|
|
|
24859
25138
|
'x-fern-sdk-method-name': 'create',
|
|
24860
25139
|
'x-fern-sdk-return-value': 'client_session',
|
|
24861
25140
|
'x-response-key': 'client_session',
|
|
25141
|
+
'x-title': 'Create a Client Session',
|
|
24862
25142
|
},
|
|
24863
25143
|
put: {
|
|
25144
|
+
description:
|
|
25145
|
+
'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24864
25146
|
operationId: 'clientSessionsCreatePut',
|
|
24865
25147
|
requestBody: {
|
|
24866
25148
|
content: {
|
|
@@ -24868,16 +25150,32 @@ export default {
|
|
|
24868
25150
|
schema: {
|
|
24869
25151
|
properties: {
|
|
24870
25152
|
connect_webview_ids: {
|
|
25153
|
+
description:
|
|
25154
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
|
|
24871
25155
|
items: { type: 'string' },
|
|
24872
25156
|
type: 'array',
|
|
24873
25157
|
},
|
|
24874
25158
|
connected_account_ids: {
|
|
25159
|
+
description:
|
|
25160
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
|
|
24875
25161
|
items: { type: 'string' },
|
|
24876
25162
|
type: 'array',
|
|
24877
25163
|
},
|
|
24878
|
-
expires_at: {
|
|
24879
|
-
|
|
25164
|
+
expires_at: {
|
|
25165
|
+
description:
|
|
25166
|
+
'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.',
|
|
25167
|
+
format: 'date-time',
|
|
25168
|
+
type: 'string',
|
|
25169
|
+
},
|
|
25170
|
+
user_identifier_key: {
|
|
25171
|
+
description:
|
|
25172
|
+
'Your user ID for the user for whom you want to create a client session.',
|
|
25173
|
+
minLength: 1,
|
|
25174
|
+
type: 'string',
|
|
25175
|
+
},
|
|
24880
25176
|
user_identity_ids: {
|
|
25177
|
+
description:
|
|
25178
|
+
'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.',
|
|
24881
25179
|
items: { type: 'string' },
|
|
24882
25180
|
type: 'array',
|
|
24883
25181
|
},
|
|
@@ -24918,17 +25216,25 @@ export default {
|
|
|
24918
25216
|
tags: ['/client_sessions'],
|
|
24919
25217
|
'x-fern-ignore': true,
|
|
24920
25218
|
'x-response-key': 'client_session',
|
|
25219
|
+
'x-title': 'Create a Client Session',
|
|
24921
25220
|
},
|
|
24922
25221
|
},
|
|
24923
25222
|
'/client_sessions/delete': {
|
|
24924
25223
|
post: {
|
|
25224
|
+
description:
|
|
25225
|
+
'Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24925
25226
|
operationId: 'clientSessionsDeletePost',
|
|
24926
25227
|
requestBody: {
|
|
24927
25228
|
content: {
|
|
24928
25229
|
'application/json': {
|
|
24929
25230
|
schema: {
|
|
24930
25231
|
properties: {
|
|
24931
|
-
client_session_id: {
|
|
25232
|
+
client_session_id: {
|
|
25233
|
+
description:
|
|
25234
|
+
'ID of the client session that you want to delete.',
|
|
25235
|
+
format: 'uuid',
|
|
25236
|
+
type: 'string',
|
|
25237
|
+
},
|
|
24932
25238
|
},
|
|
24933
25239
|
required: ['client_session_id'],
|
|
24934
25240
|
type: 'object',
|
|
@@ -24962,18 +25268,29 @@ export default {
|
|
|
24962
25268
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
24963
25269
|
'x-fern-sdk-method-name': 'delete',
|
|
24964
25270
|
'x-response-key': null,
|
|
25271
|
+
'x-title': 'Delete a Client Session',
|
|
24965
25272
|
},
|
|
24966
25273
|
},
|
|
24967
25274
|
'/client_sessions/get': {
|
|
24968
25275
|
post: {
|
|
25276
|
+
description:
|
|
25277
|
+
'Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24969
25278
|
operationId: 'clientSessionsGetPost',
|
|
24970
25279
|
requestBody: {
|
|
24971
25280
|
content: {
|
|
24972
25281
|
'application/json': {
|
|
24973
25282
|
schema: {
|
|
24974
25283
|
properties: {
|
|
24975
|
-
client_session_id: {
|
|
24976
|
-
|
|
25284
|
+
client_session_id: {
|
|
25285
|
+
description:
|
|
25286
|
+
'ID of the client session that you want to get.',
|
|
25287
|
+
type: 'string',
|
|
25288
|
+
},
|
|
25289
|
+
user_identifier_key: {
|
|
25290
|
+
description:
|
|
25291
|
+
'User identifier key associated with the client session that you want to get.',
|
|
25292
|
+
type: 'string',
|
|
25293
|
+
},
|
|
24977
25294
|
},
|
|
24978
25295
|
type: 'object',
|
|
24979
25296
|
},
|
|
@@ -25013,10 +25330,13 @@ export default {
|
|
|
25013
25330
|
'x-fern-sdk-method-name': 'get',
|
|
25014
25331
|
'x-fern-sdk-return-value': 'client_session',
|
|
25015
25332
|
'x-response-key': 'client_session',
|
|
25333
|
+
'x-title': 'Get a Client Session',
|
|
25016
25334
|
},
|
|
25017
25335
|
},
|
|
25018
25336
|
'/client_sessions/get_or_create': {
|
|
25019
25337
|
post: {
|
|
25338
|
+
description:
|
|
25339
|
+
'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.',
|
|
25020
25340
|
operationId: 'clientSessionsGetOrCreatePost',
|
|
25021
25341
|
requestBody: {
|
|
25022
25342
|
content: {
|
|
@@ -25024,16 +25344,32 @@ export default {
|
|
|
25024
25344
|
schema: {
|
|
25025
25345
|
properties: {
|
|
25026
25346
|
connect_webview_ids: {
|
|
25347
|
+
description:
|
|
25348
|
+
'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).',
|
|
25027
25349
|
items: { type: 'string' },
|
|
25028
25350
|
type: 'array',
|
|
25029
25351
|
},
|
|
25030
25352
|
connected_account_ids: {
|
|
25353
|
+
description:
|
|
25354
|
+
'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).',
|
|
25031
25355
|
items: { type: 'string' },
|
|
25032
25356
|
type: 'array',
|
|
25033
25357
|
},
|
|
25034
|
-
expires_at: {
|
|
25035
|
-
|
|
25358
|
+
expires_at: {
|
|
25359
|
+
description:
|
|
25360
|
+
'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.',
|
|
25361
|
+
format: 'date-time',
|
|
25362
|
+
type: 'string',
|
|
25363
|
+
},
|
|
25364
|
+
user_identifier_key: {
|
|
25365
|
+
description:
|
|
25366
|
+
'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).',
|
|
25367
|
+
minLength: 1,
|
|
25368
|
+
type: 'string',
|
|
25369
|
+
},
|
|
25036
25370
|
user_identity_ids: {
|
|
25371
|
+
description:
|
|
25372
|
+
'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).',
|
|
25037
25373
|
items: { type: 'string' },
|
|
25038
25374
|
type: 'array',
|
|
25039
25375
|
},
|
|
@@ -25076,27 +25412,44 @@ export default {
|
|
|
25076
25412
|
'x-fern-sdk-method-name': 'get_or_create',
|
|
25077
25413
|
'x-fern-sdk-return-value': 'client_session',
|
|
25078
25414
|
'x-response-key': 'client_session',
|
|
25415
|
+
'x-title': 'Get or Create a Client Session',
|
|
25079
25416
|
},
|
|
25080
25417
|
},
|
|
25081
25418
|
'/client_sessions/grant_access': {
|
|
25082
25419
|
patch: {
|
|
25420
|
+
description:
|
|
25421
|
+
'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.',
|
|
25083
25422
|
operationId: 'clientSessionsGrantAccessPatch',
|
|
25084
25423
|
requestBody: {
|
|
25085
25424
|
content: {
|
|
25086
25425
|
'application/json': {
|
|
25087
25426
|
schema: {
|
|
25088
25427
|
properties: {
|
|
25089
|
-
client_session_id: {
|
|
25428
|
+
client_session_id: {
|
|
25429
|
+
description:
|
|
25430
|
+
'ID of the client session to which you want to grant access to resources.',
|
|
25431
|
+
type: 'string',
|
|
25432
|
+
},
|
|
25090
25433
|
connect_webview_ids: {
|
|
25434
|
+
description:
|
|
25435
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
|
|
25091
25436
|
items: { type: 'string' },
|
|
25092
25437
|
type: 'array',
|
|
25093
25438
|
},
|
|
25094
25439
|
connected_account_ids: {
|
|
25440
|
+
description:
|
|
25441
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
|
|
25095
25442
|
items: { type: 'string' },
|
|
25096
25443
|
type: 'array',
|
|
25097
25444
|
},
|
|
25098
|
-
user_identifier_key: {
|
|
25445
|
+
user_identifier_key: {
|
|
25446
|
+
description:
|
|
25447
|
+
'Your user ID for the user that you want to associate with the client session.',
|
|
25448
|
+
type: 'string',
|
|
25449
|
+
},
|
|
25099
25450
|
user_identity_ids: {
|
|
25451
|
+
description:
|
|
25452
|
+
'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.',
|
|
25100
25453
|
items: { type: 'string' },
|
|
25101
25454
|
type: 'array',
|
|
25102
25455
|
},
|
|
@@ -25136,25 +25489,42 @@ export default {
|
|
|
25136
25489
|
tags: ['/client_sessions'],
|
|
25137
25490
|
'x-fern-ignore': true,
|
|
25138
25491
|
'x-response-key': null,
|
|
25492
|
+
'x-title': 'Grant Access to a Client Session',
|
|
25139
25493
|
},
|
|
25140
25494
|
post: {
|
|
25495
|
+
description:
|
|
25496
|
+
'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.',
|
|
25141
25497
|
operationId: 'clientSessionsGrantAccessPost',
|
|
25142
25498
|
requestBody: {
|
|
25143
25499
|
content: {
|
|
25144
25500
|
'application/json': {
|
|
25145
25501
|
schema: {
|
|
25146
25502
|
properties: {
|
|
25147
|
-
client_session_id: {
|
|
25503
|
+
client_session_id: {
|
|
25504
|
+
description:
|
|
25505
|
+
'ID of the client session to which you want to grant access to resources.',
|
|
25506
|
+
type: 'string',
|
|
25507
|
+
},
|
|
25148
25508
|
connect_webview_ids: {
|
|
25509
|
+
description:
|
|
25510
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
|
|
25149
25511
|
items: { type: 'string' },
|
|
25150
25512
|
type: 'array',
|
|
25151
25513
|
},
|
|
25152
25514
|
connected_account_ids: {
|
|
25515
|
+
description:
|
|
25516
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
|
|
25153
25517
|
items: { type: 'string' },
|
|
25154
25518
|
type: 'array',
|
|
25155
25519
|
},
|
|
25156
|
-
user_identifier_key: {
|
|
25520
|
+
user_identifier_key: {
|
|
25521
|
+
description:
|
|
25522
|
+
'Your user ID for the user that you want to associate with the client session.',
|
|
25523
|
+
type: 'string',
|
|
25524
|
+
},
|
|
25157
25525
|
user_identity_ids: {
|
|
25526
|
+
description:
|
|
25527
|
+
'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.',
|
|
25158
25528
|
items: { type: 'string' },
|
|
25159
25529
|
type: 'array',
|
|
25160
25530
|
},
|
|
@@ -25195,21 +25565,44 @@ export default {
|
|
|
25195
25565
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
25196
25566
|
'x-fern-sdk-method-name': 'grant_access',
|
|
25197
25567
|
'x-response-key': null,
|
|
25568
|
+
'x-title': 'Grant Access to a Client Session',
|
|
25198
25569
|
},
|
|
25199
25570
|
},
|
|
25200
25571
|
'/client_sessions/list': {
|
|
25201
25572
|
post: {
|
|
25573
|
+
description:
|
|
25574
|
+
'Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
25202
25575
|
operationId: 'clientSessionsListPost',
|
|
25203
25576
|
requestBody: {
|
|
25204
25577
|
content: {
|
|
25205
25578
|
'application/json': {
|
|
25206
25579
|
schema: {
|
|
25207
25580
|
properties: {
|
|
25208
|
-
client_session_id: {
|
|
25209
|
-
|
|
25210
|
-
|
|
25211
|
-
|
|
25212
|
-
|
|
25581
|
+
client_session_id: {
|
|
25582
|
+
description:
|
|
25583
|
+
'ID of the client session that you want to retrieve.',
|
|
25584
|
+
type: 'string',
|
|
25585
|
+
},
|
|
25586
|
+
connect_webview_id: {
|
|
25587
|
+
description:
|
|
25588
|
+
'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
|
|
25589
|
+
type: 'string',
|
|
25590
|
+
},
|
|
25591
|
+
user_identifier_key: {
|
|
25592
|
+
description:
|
|
25593
|
+
'Your user ID for the user by which you want to filter client sessions.',
|
|
25594
|
+
type: 'string',
|
|
25595
|
+
},
|
|
25596
|
+
user_identity_id: {
|
|
25597
|
+
description:
|
|
25598
|
+
'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.',
|
|
25599
|
+
type: 'string',
|
|
25600
|
+
},
|
|
25601
|
+
without_user_identifier_key: {
|
|
25602
|
+
description:
|
|
25603
|
+
'Indicates whether to retrieve only client sessions without associated user identifier keys.',
|
|
25604
|
+
type: 'boolean',
|
|
25605
|
+
},
|
|
25213
25606
|
},
|
|
25214
25607
|
type: 'object',
|
|
25215
25608
|
},
|
|
@@ -25249,17 +25642,25 @@ export default {
|
|
|
25249
25642
|
'x-fern-sdk-method-name': 'list',
|
|
25250
25643
|
'x-fern-sdk-return-value': 'client_sessions',
|
|
25251
25644
|
'x-response-key': 'client_sessions',
|
|
25645
|
+
'x-title': 'List Client Sessions',
|
|
25252
25646
|
},
|
|
25253
25647
|
},
|
|
25254
25648
|
'/client_sessions/revoke': {
|
|
25255
25649
|
post: {
|
|
25650
|
+
description:
|
|
25651
|
+
'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.',
|
|
25256
25652
|
operationId: 'clientSessionsRevokePost',
|
|
25257
25653
|
requestBody: {
|
|
25258
25654
|
content: {
|
|
25259
25655
|
'application/json': {
|
|
25260
25656
|
schema: {
|
|
25261
25657
|
properties: {
|
|
25262
|
-
client_session_id: {
|
|
25658
|
+
client_session_id: {
|
|
25659
|
+
description:
|
|
25660
|
+
'ID of the client session that you want to revoke.',
|
|
25661
|
+
format: 'uuid',
|
|
25662
|
+
type: 'string',
|
|
25663
|
+
},
|
|
25263
25664
|
},
|
|
25264
25665
|
required: ['client_session_id'],
|
|
25265
25666
|
type: 'object',
|
|
@@ -25293,10 +25694,13 @@ export default {
|
|
|
25293
25694
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
25294
25695
|
'x-fern-sdk-method-name': 'revoke',
|
|
25295
25696
|
'x-response-key': null,
|
|
25697
|
+
'x-title': 'Revoke a Client Session',
|
|
25296
25698
|
},
|
|
25297
25699
|
},
|
|
25298
25700
|
'/connect_webviews/create': {
|
|
25299
25701
|
post: {
|
|
25702
|
+
description:
|
|
25703
|
+
'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).',
|
|
25300
25704
|
operationId: 'connectWebviewsCreatePost',
|
|
25301
25705
|
requestBody: {
|
|
25302
25706
|
content: {
|
|
@@ -25304,6 +25708,8 @@ export default {
|
|
|
25304
25708
|
schema: {
|
|
25305
25709
|
properties: {
|
|
25306
25710
|
accepted_providers: {
|
|
25711
|
+
description:
|
|
25712
|
+
'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.',
|
|
25307
25713
|
items: {
|
|
25308
25714
|
enum: [
|
|
25309
25715
|
'dormakaba_community',
|
|
@@ -25363,6 +25769,8 @@ export default {
|
|
|
25363
25769
|
},
|
|
25364
25770
|
automatically_manage_new_devices: {
|
|
25365
25771
|
default: true,
|
|
25772
|
+
description:
|
|
25773
|
+
'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).',
|
|
25366
25774
|
type: 'boolean',
|
|
25367
25775
|
},
|
|
25368
25776
|
custom_metadata: {
|
|
@@ -25373,15 +25781,28 @@ export default {
|
|
|
25373
25781
|
{ type: 'boolean' },
|
|
25374
25782
|
],
|
|
25375
25783
|
},
|
|
25784
|
+
description:
|
|
25785
|
+
'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).',
|
|
25376
25786
|
type: 'object',
|
|
25377
25787
|
},
|
|
25378
|
-
custom_redirect_failure_url: {
|
|
25379
|
-
|
|
25788
|
+
custom_redirect_failure_url: {
|
|
25789
|
+
description:
|
|
25790
|
+
'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`.',
|
|
25791
|
+
type: 'string',
|
|
25792
|
+
},
|
|
25793
|
+
custom_redirect_url: {
|
|
25794
|
+
description:
|
|
25795
|
+
'URL that you want to redirect the user to after the provider login is complete.',
|
|
25796
|
+
type: 'string',
|
|
25797
|
+
},
|
|
25380
25798
|
device_selection_mode: {
|
|
25381
25799
|
enum: ['none', 'single', 'multiple'],
|
|
25382
25800
|
type: 'string',
|
|
25801
|
+
'x-undocumented': 'Not supported.',
|
|
25383
25802
|
},
|
|
25384
25803
|
provider_category: {
|
|
25804
|
+
description:
|
|
25805
|
+
'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.',
|
|
25385
25806
|
enum: [
|
|
25386
25807
|
'stable',
|
|
25387
25808
|
'consumer_smartlocks',
|
|
@@ -25392,7 +25813,12 @@ export default {
|
|
|
25392
25813
|
],
|
|
25393
25814
|
type: 'string',
|
|
25394
25815
|
},
|
|
25395
|
-
wait_for_device_creation: {
|
|
25816
|
+
wait_for_device_creation: {
|
|
25817
|
+
default: false,
|
|
25818
|
+
description:
|
|
25819
|
+
'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).',
|
|
25820
|
+
type: 'boolean',
|
|
25821
|
+
},
|
|
25396
25822
|
},
|
|
25397
25823
|
type: 'object',
|
|
25398
25824
|
},
|
|
@@ -25432,17 +25858,25 @@ export default {
|
|
|
25432
25858
|
'x-fern-sdk-method-name': 'create',
|
|
25433
25859
|
'x-fern-sdk-return-value': 'connect_webview',
|
|
25434
25860
|
'x-response-key': 'connect_webview',
|
|
25861
|
+
'x-title': 'Create a Connect Webview',
|
|
25435
25862
|
},
|
|
25436
25863
|
},
|
|
25437
25864
|
'/connect_webviews/delete': {
|
|
25438
25865
|
post: {
|
|
25866
|
+
description:
|
|
25867
|
+
'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.',
|
|
25439
25868
|
operationId: 'connectWebviewsDeletePost',
|
|
25440
25869
|
requestBody: {
|
|
25441
25870
|
content: {
|
|
25442
25871
|
'application/json': {
|
|
25443
25872
|
schema: {
|
|
25444
25873
|
properties: {
|
|
25445
|
-
connect_webview_id: {
|
|
25874
|
+
connect_webview_id: {
|
|
25875
|
+
description:
|
|
25876
|
+
'ID of the Connect Webview that you want to delete.',
|
|
25877
|
+
format: 'uuid',
|
|
25878
|
+
type: 'string',
|
|
25879
|
+
},
|
|
25446
25880
|
},
|
|
25447
25881
|
required: ['connect_webview_id'],
|
|
25448
25882
|
type: 'object',
|
|
@@ -25476,17 +25910,25 @@ export default {
|
|
|
25476
25910
|
'x-fern-sdk-group-name': ['connect_webviews'],
|
|
25477
25911
|
'x-fern-sdk-method-name': 'delete',
|
|
25478
25912
|
'x-response-key': null,
|
|
25913
|
+
'x-title': 'Delete a Connect Webview',
|
|
25479
25914
|
},
|
|
25480
25915
|
},
|
|
25481
25916
|
'/connect_webviews/get': {
|
|
25482
25917
|
post: {
|
|
25918
|
+
description:
|
|
25919
|
+
"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.",
|
|
25483
25920
|
operationId: 'connectWebviewsGetPost',
|
|
25484
25921
|
requestBody: {
|
|
25485
25922
|
content: {
|
|
25486
25923
|
'application/json': {
|
|
25487
25924
|
schema: {
|
|
25488
25925
|
properties: {
|
|
25489
|
-
connect_webview_id: {
|
|
25926
|
+
connect_webview_id: {
|
|
25927
|
+
description:
|
|
25928
|
+
'ID of the Connect Webview that you want to get.',
|
|
25929
|
+
format: 'uuid',
|
|
25930
|
+
type: 'string',
|
|
25931
|
+
},
|
|
25490
25932
|
},
|
|
25491
25933
|
required: ['connect_webview_id'],
|
|
25492
25934
|
type: 'object',
|
|
@@ -25527,10 +25969,13 @@ export default {
|
|
|
25527
25969
|
'x-fern-sdk-method-name': 'get',
|
|
25528
25970
|
'x-fern-sdk-return-value': 'connect_webview',
|
|
25529
25971
|
'x-response-key': 'connect_webview',
|
|
25972
|
+
'x-title': 'Get a Connect Webview',
|
|
25530
25973
|
},
|
|
25531
25974
|
},
|
|
25532
25975
|
'/connect_webviews/list': {
|
|
25533
25976
|
post: {
|
|
25977
|
+
description:
|
|
25978
|
+
'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
|
|
25534
25979
|
operationId: 'connectWebviewsListPost',
|
|
25535
25980
|
requestBody: {
|
|
25536
25981
|
content: {
|
|
@@ -25542,13 +25987,19 @@ export default {
|
|
|
25542
25987
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
25543
25988
|
},
|
|
25544
25989
|
description:
|
|
25545
|
-
'
|
|
25990
|
+
'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.',
|
|
25546
25991
|
type: 'object',
|
|
25547
25992
|
},
|
|
25548
|
-
limit: {
|
|
25993
|
+
limit: {
|
|
25994
|
+
default: 500,
|
|
25995
|
+
description:
|
|
25996
|
+
'Maximum number of records to return per page.',
|
|
25997
|
+
format: 'float',
|
|
25998
|
+
type: 'number',
|
|
25999
|
+
},
|
|
25549
26000
|
user_identifier_key: {
|
|
25550
26001
|
description:
|
|
25551
|
-
'
|
|
26002
|
+
'Your user ID for the user by which you want to filter Connect Webviews.',
|
|
25552
26003
|
type: 'string',
|
|
25553
26004
|
},
|
|
25554
26005
|
},
|
|
@@ -25591,18 +26042,30 @@ export default {
|
|
|
25591
26042
|
'x-fern-sdk-method-name': 'list',
|
|
25592
26043
|
'x-fern-sdk-return-value': 'connect_webviews',
|
|
25593
26044
|
'x-response-key': 'connect_webviews',
|
|
26045
|
+
'x-title': 'List Connect Webviews',
|
|
25594
26046
|
},
|
|
25595
26047
|
},
|
|
25596
26048
|
'/connected_accounts/delete': {
|
|
25597
26049
|
post: {
|
|
26050
|
+
description:
|
|
26051
|
+
'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.',
|
|
25598
26052
|
operationId: 'connectedAccountsDeletePost',
|
|
25599
26053
|
requestBody: {
|
|
25600
26054
|
content: {
|
|
25601
26055
|
'application/json': {
|
|
25602
26056
|
schema: {
|
|
25603
26057
|
properties: {
|
|
25604
|
-
connected_account_id: {
|
|
25605
|
-
|
|
26058
|
+
connected_account_id: {
|
|
26059
|
+
description:
|
|
26060
|
+
'ID of the connected account that you want to delete.',
|
|
26061
|
+
format: 'uuid',
|
|
26062
|
+
type: 'string',
|
|
26063
|
+
},
|
|
26064
|
+
sync: {
|
|
26065
|
+
default: false,
|
|
26066
|
+
type: 'boolean',
|
|
26067
|
+
'x-undocumented': 'Only used internally.',
|
|
26068
|
+
},
|
|
25606
26069
|
},
|
|
25607
26070
|
required: ['connected_account_id'],
|
|
25608
26071
|
type: 'object',
|
|
@@ -25641,6 +26104,8 @@ export default {
|
|
|
25641
26104
|
},
|
|
25642
26105
|
'/connected_accounts/get': {
|
|
25643
26106
|
post: {
|
|
26107
|
+
description:
|
|
26108
|
+
'Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
25644
26109
|
operationId: 'connectedAccountsGetPost',
|
|
25645
26110
|
requestBody: {
|
|
25646
26111
|
content: {
|
|
@@ -25649,13 +26114,25 @@ export default {
|
|
|
25649
26114
|
oneOf: [
|
|
25650
26115
|
{
|
|
25651
26116
|
properties: {
|
|
25652
|
-
connected_account_id: {
|
|
26117
|
+
connected_account_id: {
|
|
26118
|
+
description:
|
|
26119
|
+
'ID of the connected account that you want to get.',
|
|
26120
|
+
format: 'uuid',
|
|
26121
|
+
type: 'string',
|
|
26122
|
+
},
|
|
25653
26123
|
},
|
|
25654
26124
|
required: ['connected_account_id'],
|
|
25655
26125
|
type: 'object',
|
|
25656
26126
|
},
|
|
25657
26127
|
{
|
|
25658
|
-
properties: {
|
|
26128
|
+
properties: {
|
|
26129
|
+
email: {
|
|
26130
|
+
description:
|
|
26131
|
+
'Email address associated with the connected account that you want to get.',
|
|
26132
|
+
format: 'email',
|
|
26133
|
+
type: 'string',
|
|
26134
|
+
},
|
|
26135
|
+
},
|
|
25659
26136
|
required: ['email'],
|
|
25660
26137
|
type: 'object',
|
|
25661
26138
|
},
|
|
@@ -25702,6 +26179,8 @@ export default {
|
|
|
25702
26179
|
},
|
|
25703
26180
|
'/connected_accounts/list': {
|
|
25704
26181
|
post: {
|
|
26182
|
+
description:
|
|
26183
|
+
'Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
25705
26184
|
operationId: 'connectedAccountsListPost',
|
|
25706
26185
|
requestBody: {
|
|
25707
26186
|
content: {
|
|
@@ -25713,7 +26192,7 @@ export default {
|
|
|
25713
26192
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
25714
26193
|
},
|
|
25715
26194
|
description:
|
|
25716
|
-
'Returns accounts
|
|
26195
|
+
'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.',
|
|
25717
26196
|
type: 'object',
|
|
25718
26197
|
},
|
|
25719
26198
|
customer_ids: {
|
|
@@ -25736,7 +26215,7 @@ export default {
|
|
|
25736
26215
|
},
|
|
25737
26216
|
user_identifier_key: {
|
|
25738
26217
|
description:
|
|
25739
|
-
'
|
|
26218
|
+
'Your user ID for the user by which you want to filter connected accounts.',
|
|
25740
26219
|
type: 'string',
|
|
25741
26220
|
},
|
|
25742
26221
|
},
|
|
@@ -25784,14 +26263,25 @@ export default {
|
|
|
25784
26263
|
},
|
|
25785
26264
|
'/connected_accounts/update': {
|
|
25786
26265
|
post: {
|
|
26266
|
+
description:
|
|
26267
|
+
'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
25787
26268
|
operationId: 'connectedAccountsUpdatePost',
|
|
25788
26269
|
requestBody: {
|
|
25789
26270
|
content: {
|
|
25790
26271
|
'application/json': {
|
|
25791
26272
|
schema: {
|
|
25792
26273
|
properties: {
|
|
25793
|
-
automatically_manage_new_devices: {
|
|
25794
|
-
|
|
26274
|
+
automatically_manage_new_devices: {
|
|
26275
|
+
description:
|
|
26276
|
+
'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
|
|
26277
|
+
type: 'boolean',
|
|
26278
|
+
},
|
|
26279
|
+
connected_account_id: {
|
|
26280
|
+
description:
|
|
26281
|
+
'ID of the connected account that you want to update.',
|
|
26282
|
+
format: 'uuid',
|
|
26283
|
+
type: 'string',
|
|
26284
|
+
},
|
|
25795
26285
|
custom_metadata: {
|
|
25796
26286
|
additionalProperties: {
|
|
25797
26287
|
nullable: true,
|
|
@@ -25800,6 +26290,8 @@ export default {
|
|
|
25800
26290
|
{ type: 'boolean' },
|
|
25801
26291
|
],
|
|
25802
26292
|
},
|
|
26293
|
+
description:
|
|
26294
|
+
'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).',
|
|
25803
26295
|
type: 'object',
|
|
25804
26296
|
},
|
|
25805
26297
|
},
|
|
@@ -25845,12 +26337,20 @@ export default {
|
|
|
25845
26337
|
},
|
|
25846
26338
|
'/devices/delete': {
|
|
25847
26339
|
post: {
|
|
26340
|
+
description:
|
|
26341
|
+
'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
25848
26342
|
operationId: 'devicesDeletePost',
|
|
25849
26343
|
requestBody: {
|
|
25850
26344
|
content: {
|
|
25851
26345
|
'application/json': {
|
|
25852
26346
|
schema: {
|
|
25853
|
-
properties: {
|
|
26347
|
+
properties: {
|
|
26348
|
+
device_id: {
|
|
26349
|
+
description: 'ID of the device that you want to delete.',
|
|
26350
|
+
format: 'uuid',
|
|
26351
|
+
type: 'string',
|
|
26352
|
+
},
|
|
26353
|
+
},
|
|
25854
26354
|
required: ['device_id'],
|
|
25855
26355
|
type: 'object',
|
|
25856
26356
|
},
|
|
@@ -25885,20 +26385,30 @@ export default {
|
|
|
25885
26385
|
'x-fern-sdk-group-name': ['devices'],
|
|
25886
26386
|
'x-fern-sdk-method-name': 'delete',
|
|
25887
26387
|
'x-response-key': null,
|
|
26388
|
+
'x-title': 'Delete a Device',
|
|
25888
26389
|
'x-undocumented':
|
|
25889
26390
|
'Deleting a device is no longer supported and will be removed.',
|
|
25890
26391
|
},
|
|
25891
26392
|
},
|
|
25892
26393
|
'/devices/get': {
|
|
25893
26394
|
post: {
|
|
26395
|
+
description:
|
|
26396
|
+
'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
|
|
25894
26397
|
operationId: 'devicesGetPost',
|
|
25895
26398
|
requestBody: {
|
|
25896
26399
|
content: {
|
|
25897
26400
|
'application/json': {
|
|
25898
26401
|
schema: {
|
|
25899
26402
|
properties: {
|
|
25900
|
-
device_id: {
|
|
25901
|
-
|
|
26403
|
+
device_id: {
|
|
26404
|
+
description: 'ID of the device that you want to get.',
|
|
26405
|
+
format: 'uuid',
|
|
26406
|
+
type: 'string',
|
|
26407
|
+
},
|
|
26408
|
+
name: {
|
|
26409
|
+
description: 'Name of the device that you want to get.',
|
|
26410
|
+
type: 'string',
|
|
26411
|
+
},
|
|
25902
26412
|
},
|
|
25903
26413
|
type: 'object',
|
|
25904
26414
|
},
|
|
@@ -25936,6 +26446,7 @@ export default {
|
|
|
25936
26446
|
'x-fern-sdk-method-name': 'get',
|
|
25937
26447
|
'x-fern-sdk-return-value': 'device',
|
|
25938
26448
|
'x-response-key': 'device',
|
|
26449
|
+
'x-title': 'Get a Device',
|
|
25939
26450
|
},
|
|
25940
26451
|
},
|
|
25941
26452
|
'/devices/list': {
|
|
@@ -25950,25 +26461,25 @@ export default {
|
|
|
25950
26461
|
properties: {
|
|
25951
26462
|
connect_webview_id: {
|
|
25952
26463
|
description:
|
|
25953
|
-
'ID of the Connect Webview
|
|
26464
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
25954
26465
|
format: 'uuid',
|
|
25955
26466
|
type: 'string',
|
|
25956
26467
|
},
|
|
25957
26468
|
connected_account_id: {
|
|
25958
26469
|
description:
|
|
25959
|
-
'ID of the connected account
|
|
26470
|
+
'ID of the connected account for which you want to list devices.',
|
|
25960
26471
|
format: 'uuid',
|
|
25961
26472
|
type: 'string',
|
|
25962
26473
|
},
|
|
25963
26474
|
connected_account_ids: {
|
|
25964
26475
|
description:
|
|
25965
|
-
'Array of IDs of the connected accounts
|
|
26476
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
25966
26477
|
items: { format: 'uuid', type: 'string' },
|
|
25967
26478
|
type: 'array',
|
|
25968
26479
|
},
|
|
25969
26480
|
created_before: {
|
|
25970
26481
|
description:
|
|
25971
|
-
'
|
|
26482
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
25972
26483
|
format: 'date-time',
|
|
25973
26484
|
type: 'string',
|
|
25974
26485
|
},
|
|
@@ -25977,7 +26488,7 @@ export default {
|
|
|
25977
26488
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
25978
26489
|
},
|
|
25979
26490
|
description:
|
|
25980
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
26491
|
+
'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.',
|
|
25981
26492
|
type: 'object',
|
|
25982
26493
|
},
|
|
25983
26494
|
customer_ids: {
|
|
@@ -25986,12 +26497,13 @@ export default {
|
|
|
25986
26497
|
},
|
|
25987
26498
|
device_ids: {
|
|
25988
26499
|
description:
|
|
25989
|
-
'Array of device IDs
|
|
26500
|
+
'Array of device IDs for which you want to list devices.',
|
|
25990
26501
|
items: { format: 'uuid', type: 'string' },
|
|
25991
26502
|
type: 'array',
|
|
25992
26503
|
},
|
|
25993
26504
|
device_type: {
|
|
25994
|
-
description:
|
|
26505
|
+
description:
|
|
26506
|
+
'Device type for which you want to list devices.',
|
|
25995
26507
|
oneOf: [
|
|
25996
26508
|
{
|
|
25997
26509
|
enum: [
|
|
@@ -26049,7 +26561,7 @@ export default {
|
|
|
26049
26561
|
},
|
|
26050
26562
|
device_types: {
|
|
26051
26563
|
description:
|
|
26052
|
-
'Array of device types
|
|
26564
|
+
'Array of device types for which you want to list devices.',
|
|
26053
26565
|
items: {
|
|
26054
26566
|
oneOf: [
|
|
26055
26567
|
{
|
|
@@ -26156,7 +26668,8 @@ export default {
|
|
|
26156
26668
|
type: 'number',
|
|
26157
26669
|
},
|
|
26158
26670
|
manufacturer: {
|
|
26159
|
-
description:
|
|
26671
|
+
description:
|
|
26672
|
+
'Manufacturer for which you want to list devices.',
|
|
26160
26673
|
enum: [
|
|
26161
26674
|
'akuvox',
|
|
26162
26675
|
'august',
|
|
@@ -26206,6 +26719,8 @@ export default {
|
|
|
26206
26719
|
type: 'string',
|
|
26207
26720
|
},
|
|
26208
26721
|
unstable_location_id: {
|
|
26722
|
+
description:
|
|
26723
|
+
'ID of the location for which you want to list devices.',
|
|
26209
26724
|
format: 'uuid',
|
|
26210
26725
|
nullable: true,
|
|
26211
26726
|
type: 'string',
|
|
@@ -26213,7 +26728,7 @@ export default {
|
|
|
26213
26728
|
},
|
|
26214
26729
|
user_identifier_key: {
|
|
26215
26730
|
description:
|
|
26216
|
-
'Your own internal user ID for the user
|
|
26731
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
26217
26732
|
type: 'string',
|
|
26218
26733
|
},
|
|
26219
26734
|
},
|
|
@@ -26262,6 +26777,8 @@ export default {
|
|
|
26262
26777
|
},
|
|
26263
26778
|
'/devices/list_device_providers': {
|
|
26264
26779
|
post: {
|
|
26780
|
+
description:
|
|
26781
|
+
'Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
26265
26782
|
operationId: 'devicesListDeviceProvidersPost',
|
|
26266
26783
|
requestBody: {
|
|
26267
26784
|
content: {
|
|
@@ -26269,6 +26786,8 @@ export default {
|
|
|
26269
26786
|
schema: {
|
|
26270
26787
|
properties: {
|
|
26271
26788
|
provider_category: {
|
|
26789
|
+
description:
|
|
26790
|
+
'Category for which you want to list providers.',
|
|
26272
26791
|
enum: [
|
|
26273
26792
|
'stable',
|
|
26274
26793
|
'consumer_smartlocks',
|
|
@@ -26318,16 +26837,26 @@ export default {
|
|
|
26318
26837
|
'x-fern-sdk-method-name': 'list_device_providers',
|
|
26319
26838
|
'x-fern-sdk-return-value': 'device_providers',
|
|
26320
26839
|
'x-response-key': 'device_providers',
|
|
26840
|
+
'x-title': 'List Device Providers',
|
|
26321
26841
|
},
|
|
26322
26842
|
},
|
|
26323
26843
|
'/devices/simulate/connect': {
|
|
26324
26844
|
post: {
|
|
26845
|
+
description:
|
|
26846
|
+
'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).',
|
|
26325
26847
|
operationId: 'devicesSimulateConnectPost',
|
|
26326
26848
|
requestBody: {
|
|
26327
26849
|
content: {
|
|
26328
26850
|
'application/json': {
|
|
26329
26851
|
schema: {
|
|
26330
|
-
properties: {
|
|
26852
|
+
properties: {
|
|
26853
|
+
device_id: {
|
|
26854
|
+
description:
|
|
26855
|
+
'ID of the device that you want to simulate connecting to Seam.',
|
|
26856
|
+
format: 'uuid',
|
|
26857
|
+
type: 'string',
|
|
26858
|
+
},
|
|
26859
|
+
},
|
|
26331
26860
|
required: ['device_id'],
|
|
26332
26861
|
type: 'object',
|
|
26333
26862
|
},
|
|
@@ -26360,16 +26889,26 @@ export default {
|
|
|
26360
26889
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
26361
26890
|
'x-fern-sdk-method-name': 'connect',
|
|
26362
26891
|
'x-response-key': null,
|
|
26892
|
+
'x-title': 'Simulate Device Connection',
|
|
26363
26893
|
},
|
|
26364
26894
|
},
|
|
26365
26895
|
'/devices/simulate/disconnect': {
|
|
26366
26896
|
post: {
|
|
26897
|
+
description:
|
|
26898
|
+
'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).',
|
|
26367
26899
|
operationId: 'devicesSimulateDisconnectPost',
|
|
26368
26900
|
requestBody: {
|
|
26369
26901
|
content: {
|
|
26370
26902
|
'application/json': {
|
|
26371
26903
|
schema: {
|
|
26372
|
-
properties: {
|
|
26904
|
+
properties: {
|
|
26905
|
+
device_id: {
|
|
26906
|
+
description:
|
|
26907
|
+
'ID of the device that you want to simulate disconnecting from Seam.',
|
|
26908
|
+
format: 'uuid',
|
|
26909
|
+
type: 'string',
|
|
26910
|
+
},
|
|
26911
|
+
},
|
|
26373
26912
|
required: ['device_id'],
|
|
26374
26913
|
type: 'object',
|
|
26375
26914
|
},
|
|
@@ -26402,16 +26941,26 @@ export default {
|
|
|
26402
26941
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
26403
26942
|
'x-fern-sdk-method-name': 'disconnect',
|
|
26404
26943
|
'x-response-key': null,
|
|
26944
|
+
'x-title': 'Simulate Device Disconnection',
|
|
26405
26945
|
},
|
|
26406
26946
|
},
|
|
26407
26947
|
'/devices/simulate/remove': {
|
|
26408
26948
|
post: {
|
|
26949
|
+
description:
|
|
26950
|
+
'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).',
|
|
26409
26951
|
operationId: 'devicesSimulateRemovePost',
|
|
26410
26952
|
requestBody: {
|
|
26411
26953
|
content: {
|
|
26412
26954
|
'application/json': {
|
|
26413
26955
|
schema: {
|
|
26414
|
-
properties: {
|
|
26956
|
+
properties: {
|
|
26957
|
+
device_id: {
|
|
26958
|
+
description:
|
|
26959
|
+
'ID of the device that you want to simulate removing from Seam.',
|
|
26960
|
+
format: 'uuid',
|
|
26961
|
+
type: 'string',
|
|
26962
|
+
},
|
|
26963
|
+
},
|
|
26415
26964
|
required: ['device_id'],
|
|
26416
26965
|
type: 'object',
|
|
26417
26966
|
},
|
|
@@ -26444,18 +26993,30 @@ export default {
|
|
|
26444
26993
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
26445
26994
|
'x-fern-sdk-method-name': 'remove',
|
|
26446
26995
|
'x-response-key': null,
|
|
26996
|
+
'x-title': 'Simulate Device Removal',
|
|
26447
26997
|
},
|
|
26448
26998
|
},
|
|
26449
26999
|
'/devices/unmanaged/get': {
|
|
26450
27000
|
post: {
|
|
27001
|
+
description:
|
|
27002
|
+
'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`.',
|
|
26451
27003
|
operationId: 'devicesUnmanagedGetPost',
|
|
26452
27004
|
requestBody: {
|
|
26453
27005
|
content: {
|
|
26454
27006
|
'application/json': {
|
|
26455
27007
|
schema: {
|
|
26456
27008
|
properties: {
|
|
26457
|
-
device_id: {
|
|
26458
|
-
|
|
27009
|
+
device_id: {
|
|
27010
|
+
description:
|
|
27011
|
+
'ID of the unmanaged device that you want to get.',
|
|
27012
|
+
format: 'uuid',
|
|
27013
|
+
type: 'string',
|
|
27014
|
+
},
|
|
27015
|
+
name: {
|
|
27016
|
+
description:
|
|
27017
|
+
'Name of the unmanaged device that you want to get.',
|
|
27018
|
+
type: 'string',
|
|
27019
|
+
},
|
|
26459
27020
|
},
|
|
26460
27021
|
type: 'object',
|
|
26461
27022
|
},
|
|
@@ -26493,10 +27054,13 @@ export default {
|
|
|
26493
27054
|
'x-fern-sdk-method-name': 'get',
|
|
26494
27055
|
'x-fern-sdk-return-value': 'device',
|
|
26495
27056
|
'x-response-key': 'device',
|
|
27057
|
+
'x-title': 'Get an Unmanaged Device',
|
|
26496
27058
|
},
|
|
26497
27059
|
},
|
|
26498
27060
|
'/devices/unmanaged/list': {
|
|
26499
27061
|
post: {
|
|
27062
|
+
description:
|
|
27063
|
+
'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).',
|
|
26500
27064
|
operationId: 'devicesUnmanagedListPost',
|
|
26501
27065
|
requestBody: {
|
|
26502
27066
|
content: {
|
|
@@ -26505,25 +27069,25 @@ export default {
|
|
|
26505
27069
|
properties: {
|
|
26506
27070
|
connect_webview_id: {
|
|
26507
27071
|
description:
|
|
26508
|
-
'ID of the Connect Webview
|
|
27072
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
26509
27073
|
format: 'uuid',
|
|
26510
27074
|
type: 'string',
|
|
26511
27075
|
},
|
|
26512
27076
|
connected_account_id: {
|
|
26513
27077
|
description:
|
|
26514
|
-
'ID of the connected account
|
|
27078
|
+
'ID of the connected account for which you want to list devices.',
|
|
26515
27079
|
format: 'uuid',
|
|
26516
27080
|
type: 'string',
|
|
26517
27081
|
},
|
|
26518
27082
|
connected_account_ids: {
|
|
26519
27083
|
description:
|
|
26520
|
-
'Array of IDs of the connected accounts
|
|
27084
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
26521
27085
|
items: { format: 'uuid', type: 'string' },
|
|
26522
27086
|
type: 'array',
|
|
26523
27087
|
},
|
|
26524
27088
|
created_before: {
|
|
26525
27089
|
description:
|
|
26526
|
-
'
|
|
27090
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
26527
27091
|
format: 'date-time',
|
|
26528
27092
|
type: 'string',
|
|
26529
27093
|
},
|
|
@@ -26532,7 +27096,7 @@ export default {
|
|
|
26532
27096
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
26533
27097
|
},
|
|
26534
27098
|
description:
|
|
26535
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
27099
|
+
'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.',
|
|
26536
27100
|
type: 'object',
|
|
26537
27101
|
},
|
|
26538
27102
|
customer_ids: {
|
|
@@ -26541,12 +27105,13 @@ export default {
|
|
|
26541
27105
|
},
|
|
26542
27106
|
device_ids: {
|
|
26543
27107
|
description:
|
|
26544
|
-
'Array of device IDs
|
|
27108
|
+
'Array of device IDs for which you want to list devices.',
|
|
26545
27109
|
items: { format: 'uuid', type: 'string' },
|
|
26546
27110
|
type: 'array',
|
|
26547
27111
|
},
|
|
26548
27112
|
device_type: {
|
|
26549
|
-
description:
|
|
27113
|
+
description:
|
|
27114
|
+
'Device type for which you want to list devices.',
|
|
26550
27115
|
oneOf: [
|
|
26551
27116
|
{
|
|
26552
27117
|
enum: [
|
|
@@ -26604,7 +27169,7 @@ export default {
|
|
|
26604
27169
|
},
|
|
26605
27170
|
device_types: {
|
|
26606
27171
|
description:
|
|
26607
|
-
'Array of device types
|
|
27172
|
+
'Array of device types for which you want to list devices.',
|
|
26608
27173
|
items: {
|
|
26609
27174
|
oneOf: [
|
|
26610
27175
|
{
|
|
@@ -26711,7 +27276,8 @@ export default {
|
|
|
26711
27276
|
type: 'number',
|
|
26712
27277
|
},
|
|
26713
27278
|
manufacturer: {
|
|
26714
|
-
description:
|
|
27279
|
+
description:
|
|
27280
|
+
'Manufacturer for which you want to list devices.',
|
|
26715
27281
|
enum: [
|
|
26716
27282
|
'akuvox',
|
|
26717
27283
|
'august',
|
|
@@ -26761,6 +27327,8 @@ export default {
|
|
|
26761
27327
|
type: 'string',
|
|
26762
27328
|
},
|
|
26763
27329
|
unstable_location_id: {
|
|
27330
|
+
description:
|
|
27331
|
+
'ID of the location for which you want to list devices.',
|
|
26764
27332
|
format: 'uuid',
|
|
26765
27333
|
nullable: true,
|
|
26766
27334
|
type: 'string',
|
|
@@ -26768,7 +27336,7 @@ export default {
|
|
|
26768
27336
|
},
|
|
26769
27337
|
user_identifier_key: {
|
|
26770
27338
|
description:
|
|
26771
|
-
'Your own internal user ID for the user
|
|
27339
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
26772
27340
|
type: 'string',
|
|
26773
27341
|
},
|
|
26774
27342
|
},
|
|
@@ -26810,18 +27378,31 @@ export default {
|
|
|
26810
27378
|
'x-fern-sdk-method-name': 'list',
|
|
26811
27379
|
'x-fern-sdk-return-value': 'devices',
|
|
26812
27380
|
'x-response-key': 'devices',
|
|
27381
|
+
'x-title': 'List Unmanaged Devices',
|
|
26813
27382
|
},
|
|
26814
27383
|
},
|
|
26815
27384
|
'/devices/unmanaged/update': {
|
|
26816
27385
|
patch: {
|
|
27386
|
+
description:
|
|
27387
|
+
'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).',
|
|
26817
27388
|
operationId: 'devicesUnmanagedUpdatePatch',
|
|
26818
27389
|
requestBody: {
|
|
26819
27390
|
content: {
|
|
26820
27391
|
'application/json': {
|
|
26821
27392
|
schema: {
|
|
26822
27393
|
properties: {
|
|
26823
|
-
device_id: {
|
|
26824
|
-
|
|
27394
|
+
device_id: {
|
|
27395
|
+
description:
|
|
27396
|
+
'ID of the unmanaged device that you want to update.',
|
|
27397
|
+
format: 'uuid',
|
|
27398
|
+
type: 'string',
|
|
27399
|
+
},
|
|
27400
|
+
is_managed: {
|
|
27401
|
+
description:
|
|
27402
|
+
'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
|
|
27403
|
+
enum: [true],
|
|
27404
|
+
type: 'boolean',
|
|
27405
|
+
},
|
|
26825
27406
|
},
|
|
26826
27407
|
required: ['device_id', 'is_managed'],
|
|
26827
27408
|
type: 'object',
|
|
@@ -26854,16 +27435,29 @@ export default {
|
|
|
26854
27435
|
tags: ['/devices'],
|
|
26855
27436
|
'x-fern-ignore': true,
|
|
26856
27437
|
'x-response-key': null,
|
|
27438
|
+
'x-title': 'Update an Unmanaged Device',
|
|
26857
27439
|
},
|
|
26858
27440
|
post: {
|
|
27441
|
+
description:
|
|
27442
|
+
'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).',
|
|
26859
27443
|
operationId: 'devicesUnmanagedUpdatePost',
|
|
26860
27444
|
requestBody: {
|
|
26861
27445
|
content: {
|
|
26862
27446
|
'application/json': {
|
|
26863
27447
|
schema: {
|
|
26864
27448
|
properties: {
|
|
26865
|
-
device_id: {
|
|
26866
|
-
|
|
27449
|
+
device_id: {
|
|
27450
|
+
description:
|
|
27451
|
+
'ID of the unmanaged device that you want to update.',
|
|
27452
|
+
format: 'uuid',
|
|
27453
|
+
type: 'string',
|
|
27454
|
+
},
|
|
27455
|
+
is_managed: {
|
|
27456
|
+
description:
|
|
27457
|
+
'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
|
|
27458
|
+
enum: [true],
|
|
27459
|
+
type: 'boolean',
|
|
27460
|
+
},
|
|
26867
27461
|
},
|
|
26868
27462
|
required: ['device_id', 'is_managed'],
|
|
26869
27463
|
type: 'object',
|
|
@@ -26897,10 +27491,13 @@ export default {
|
|
|
26897
27491
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
26898
27492
|
'x-fern-sdk-method-name': 'update',
|
|
26899
27493
|
'x-response-key': null,
|
|
27494
|
+
'x-title': 'Update an Unmanaged Device',
|
|
26900
27495
|
},
|
|
26901
27496
|
},
|
|
26902
27497
|
'/devices/update': {
|
|
26903
27498
|
patch: {
|
|
27499
|
+
description:
|
|
27500
|
+
"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).",
|
|
26904
27501
|
operationId: 'devicesUpdatePatch',
|
|
26905
27502
|
requestBody: {
|
|
26906
27503
|
content: {
|
|
@@ -26915,13 +27512,34 @@ export default {
|
|
|
26915
27512
|
{ type: 'boolean' },
|
|
26916
27513
|
],
|
|
26917
27514
|
},
|
|
27515
|
+
description:
|
|
27516
|
+
'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).',
|
|
26918
27517
|
type: 'object',
|
|
26919
27518
|
},
|
|
26920
|
-
device_id: {
|
|
26921
|
-
|
|
26922
|
-
|
|
27519
|
+
device_id: {
|
|
27520
|
+
description: 'ID of the device that you want to update.',
|
|
27521
|
+
format: 'uuid',
|
|
27522
|
+
type: 'string',
|
|
27523
|
+
},
|
|
27524
|
+
is_managed: {
|
|
27525
|
+
default: true,
|
|
27526
|
+
description:
|
|
27527
|
+
'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
|
|
27528
|
+
type: 'boolean',
|
|
27529
|
+
},
|
|
27530
|
+
name: {
|
|
27531
|
+
description: 'Name for the device.',
|
|
27532
|
+
nullable: true,
|
|
27533
|
+
type: 'string',
|
|
27534
|
+
},
|
|
26923
27535
|
properties: {
|
|
26924
|
-
properties: {
|
|
27536
|
+
properties: {
|
|
27537
|
+
name: {
|
|
27538
|
+
description: 'Name for the device.',
|
|
27539
|
+
nullable: true,
|
|
27540
|
+
type: 'string',
|
|
27541
|
+
},
|
|
27542
|
+
},
|
|
26925
27543
|
type: 'object',
|
|
26926
27544
|
},
|
|
26927
27545
|
},
|
|
@@ -26957,8 +27575,11 @@ export default {
|
|
|
26957
27575
|
tags: ['/devices'],
|
|
26958
27576
|
'x-fern-ignore': true,
|
|
26959
27577
|
'x-response-key': null,
|
|
27578
|
+
'x-title': 'Update a Device',
|
|
26960
27579
|
},
|
|
26961
27580
|
post: {
|
|
27581
|
+
description:
|
|
27582
|
+
"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).",
|
|
26962
27583
|
operationId: 'devicesUpdatePost',
|
|
26963
27584
|
requestBody: {
|
|
26964
27585
|
content: {
|
|
@@ -26973,13 +27594,34 @@ export default {
|
|
|
26973
27594
|
{ type: 'boolean' },
|
|
26974
27595
|
],
|
|
26975
27596
|
},
|
|
27597
|
+
description:
|
|
27598
|
+
'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).',
|
|
26976
27599
|
type: 'object',
|
|
26977
27600
|
},
|
|
26978
|
-
device_id: {
|
|
26979
|
-
|
|
26980
|
-
|
|
27601
|
+
device_id: {
|
|
27602
|
+
description: 'ID of the device that you want to update.',
|
|
27603
|
+
format: 'uuid',
|
|
27604
|
+
type: 'string',
|
|
27605
|
+
},
|
|
27606
|
+
is_managed: {
|
|
27607
|
+
default: true,
|
|
27608
|
+
description:
|
|
27609
|
+
'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
|
|
27610
|
+
type: 'boolean',
|
|
27611
|
+
},
|
|
27612
|
+
name: {
|
|
27613
|
+
description: 'Name for the device.',
|
|
27614
|
+
nullable: true,
|
|
27615
|
+
type: 'string',
|
|
27616
|
+
},
|
|
26981
27617
|
properties: {
|
|
26982
|
-
properties: {
|
|
27618
|
+
properties: {
|
|
27619
|
+
name: {
|
|
27620
|
+
description: 'Name for the device.',
|
|
27621
|
+
nullable: true,
|
|
27622
|
+
type: 'string',
|
|
27623
|
+
},
|
|
27624
|
+
},
|
|
26983
27625
|
type: 'object',
|
|
26984
27626
|
},
|
|
26985
27627
|
},
|
|
@@ -27016,10 +27658,13 @@ export default {
|
|
|
27016
27658
|
'x-fern-sdk-group-name': ['devices'],
|
|
27017
27659
|
'x-fern-sdk-method-name': 'update',
|
|
27018
27660
|
'x-response-key': null,
|
|
27661
|
+
'x-title': 'Update a Device',
|
|
27019
27662
|
},
|
|
27020
27663
|
},
|
|
27021
27664
|
'/events/get': {
|
|
27022
27665
|
post: {
|
|
27666
|
+
description:
|
|
27667
|
+
'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.',
|
|
27023
27668
|
operationId: 'eventsGetPost',
|
|
27024
27669
|
requestBody: {
|
|
27025
27670
|
content: {
|
|
@@ -27067,10 +27712,13 @@ export default {
|
|
|
27067
27712
|
'x-fern-sdk-method-name': 'get',
|
|
27068
27713
|
'x-fern-sdk-return-value': 'event',
|
|
27069
27714
|
'x-response-key': 'event',
|
|
27715
|
+
'x-title': 'Get an Event',
|
|
27070
27716
|
},
|
|
27071
27717
|
},
|
|
27072
27718
|
'/events/list': {
|
|
27073
27719
|
post: {
|
|
27720
|
+
description:
|
|
27721
|
+
'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.',
|
|
27074
27722
|
operationId: 'eventsListPost',
|
|
27075
27723
|
requestBody: {
|
|
27076
27724
|
content: {
|
|
@@ -27345,6 +27993,7 @@ export default {
|
|
|
27345
27993
|
'x-fern-sdk-method-name': 'list',
|
|
27346
27994
|
'x-fern-sdk-return-value': 'events',
|
|
27347
27995
|
'x-response-key': 'events',
|
|
27996
|
+
'x-title': 'List Events',
|
|
27348
27997
|
},
|
|
27349
27998
|
},
|
|
27350
27999
|
'/locks/get': {
|
|
@@ -27408,25 +28057,25 @@ export default {
|
|
|
27408
28057
|
properties: {
|
|
27409
28058
|
connect_webview_id: {
|
|
27410
28059
|
description:
|
|
27411
|
-
'ID of the Connect Webview
|
|
28060
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
27412
28061
|
format: 'uuid',
|
|
27413
28062
|
type: 'string',
|
|
27414
28063
|
},
|
|
27415
28064
|
connected_account_id: {
|
|
27416
28065
|
description:
|
|
27417
|
-
'ID of the connected account
|
|
28066
|
+
'ID of the connected account for which you want to list devices.',
|
|
27418
28067
|
format: 'uuid',
|
|
27419
28068
|
type: 'string',
|
|
27420
28069
|
},
|
|
27421
28070
|
connected_account_ids: {
|
|
27422
28071
|
description:
|
|
27423
|
-
'Array of IDs of the connected accounts
|
|
28072
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
27424
28073
|
items: { format: 'uuid', type: 'string' },
|
|
27425
28074
|
type: 'array',
|
|
27426
28075
|
},
|
|
27427
28076
|
created_before: {
|
|
27428
28077
|
description:
|
|
27429
|
-
'
|
|
28078
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
27430
28079
|
format: 'date-time',
|
|
27431
28080
|
type: 'string',
|
|
27432
28081
|
},
|
|
@@ -27435,7 +28084,7 @@ export default {
|
|
|
27435
28084
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27436
28085
|
},
|
|
27437
28086
|
description:
|
|
27438
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
28087
|
+
'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.',
|
|
27439
28088
|
type: 'object',
|
|
27440
28089
|
},
|
|
27441
28090
|
customer_ids: {
|
|
@@ -27444,7 +28093,7 @@ export default {
|
|
|
27444
28093
|
},
|
|
27445
28094
|
device_ids: {
|
|
27446
28095
|
description:
|
|
27447
|
-
'Array of device IDs
|
|
28096
|
+
'Array of device IDs for which you want to list devices.',
|
|
27448
28097
|
items: { format: 'uuid', type: 'string' },
|
|
27449
28098
|
type: 'array',
|
|
27450
28099
|
},
|
|
@@ -27605,6 +28254,8 @@ export default {
|
|
|
27605
28254
|
type: 'string',
|
|
27606
28255
|
},
|
|
27607
28256
|
unstable_location_id: {
|
|
28257
|
+
description:
|
|
28258
|
+
'ID of the location for which you want to list devices.',
|
|
27608
28259
|
format: 'uuid',
|
|
27609
28260
|
nullable: true,
|
|
27610
28261
|
type: 'string',
|
|
@@ -27612,7 +28263,7 @@ export default {
|
|
|
27612
28263
|
},
|
|
27613
28264
|
user_identifier_key: {
|
|
27614
28265
|
description:
|
|
27615
|
-
'Your own internal user ID for the user
|
|
28266
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
27616
28267
|
type: 'string',
|
|
27617
28268
|
},
|
|
27618
28269
|
},
|
|
@@ -27969,25 +28620,25 @@ export default {
|
|
|
27969
28620
|
properties: {
|
|
27970
28621
|
connect_webview_id: {
|
|
27971
28622
|
description:
|
|
27972
|
-
'ID of the Connect Webview
|
|
28623
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
27973
28624
|
format: 'uuid',
|
|
27974
28625
|
type: 'string',
|
|
27975
28626
|
},
|
|
27976
28627
|
connected_account_id: {
|
|
27977
28628
|
description:
|
|
27978
|
-
'ID of the connected account
|
|
28629
|
+
'ID of the connected account for which you want to list devices.',
|
|
27979
28630
|
format: 'uuid',
|
|
27980
28631
|
type: 'string',
|
|
27981
28632
|
},
|
|
27982
28633
|
connected_account_ids: {
|
|
27983
28634
|
description:
|
|
27984
|
-
'Array of IDs of the connected accounts
|
|
28635
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
27985
28636
|
items: { format: 'uuid', type: 'string' },
|
|
27986
28637
|
type: 'array',
|
|
27987
28638
|
},
|
|
27988
28639
|
created_before: {
|
|
27989
28640
|
description:
|
|
27990
|
-
'
|
|
28641
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
27991
28642
|
format: 'date-time',
|
|
27992
28643
|
type: 'string',
|
|
27993
28644
|
},
|
|
@@ -27996,7 +28647,7 @@ export default {
|
|
|
27996
28647
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27997
28648
|
},
|
|
27998
28649
|
description:
|
|
27999
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
28650
|
+
'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.',
|
|
28000
28651
|
type: 'object',
|
|
28001
28652
|
},
|
|
28002
28653
|
customer_ids: {
|
|
@@ -28005,7 +28656,7 @@ export default {
|
|
|
28005
28656
|
},
|
|
28006
28657
|
device_ids: {
|
|
28007
28658
|
description:
|
|
28008
|
-
'Array of device IDs
|
|
28659
|
+
'Array of device IDs for which you want to list devices.',
|
|
28009
28660
|
items: { format: 'uuid', type: 'string' },
|
|
28010
28661
|
type: 'array',
|
|
28011
28662
|
},
|
|
@@ -28082,6 +28733,8 @@ export default {
|
|
|
28082
28733
|
type: 'string',
|
|
28083
28734
|
},
|
|
28084
28735
|
unstable_location_id: {
|
|
28736
|
+
description:
|
|
28737
|
+
'ID of the location for which you want to list devices.',
|
|
28085
28738
|
format: 'uuid',
|
|
28086
28739
|
nullable: true,
|
|
28087
28740
|
type: 'string',
|
|
@@ -28089,7 +28742,7 @@ export default {
|
|
|
28089
28742
|
},
|
|
28090
28743
|
user_identifier_key: {
|
|
28091
28744
|
description:
|
|
28092
|
-
'Your own internal user ID for the user
|
|
28745
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
28093
28746
|
type: 'string',
|
|
28094
28747
|
},
|
|
28095
28748
|
},
|
|
@@ -31023,25 +31676,25 @@ export default {
|
|
|
31023
31676
|
properties: {
|
|
31024
31677
|
connect_webview_id: {
|
|
31025
31678
|
description:
|
|
31026
|
-
'ID of the Connect Webview
|
|
31679
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
31027
31680
|
format: 'uuid',
|
|
31028
31681
|
type: 'string',
|
|
31029
31682
|
},
|
|
31030
31683
|
connected_account_id: {
|
|
31031
31684
|
description:
|
|
31032
|
-
'ID of the connected account
|
|
31685
|
+
'ID of the connected account for which you want to list devices.',
|
|
31033
31686
|
format: 'uuid',
|
|
31034
31687
|
type: 'string',
|
|
31035
31688
|
},
|
|
31036
31689
|
connected_account_ids: {
|
|
31037
31690
|
description:
|
|
31038
|
-
'Array of IDs of the connected accounts
|
|
31691
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
31039
31692
|
items: { format: 'uuid', type: 'string' },
|
|
31040
31693
|
type: 'array',
|
|
31041
31694
|
},
|
|
31042
31695
|
created_before: {
|
|
31043
31696
|
description:
|
|
31044
|
-
'
|
|
31697
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
31045
31698
|
format: 'date-time',
|
|
31046
31699
|
type: 'string',
|
|
31047
31700
|
},
|
|
@@ -31050,7 +31703,7 @@ export default {
|
|
|
31050
31703
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
31051
31704
|
},
|
|
31052
31705
|
description:
|
|
31053
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
31706
|
+
'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.',
|
|
31054
31707
|
type: 'object',
|
|
31055
31708
|
},
|
|
31056
31709
|
customer_ids: {
|
|
@@ -31059,7 +31712,7 @@ export default {
|
|
|
31059
31712
|
},
|
|
31060
31713
|
device_ids: {
|
|
31061
31714
|
description:
|
|
31062
|
-
'Array of device IDs
|
|
31715
|
+
'Array of device IDs for which you want to list devices.',
|
|
31063
31716
|
items: { format: 'uuid', type: 'string' },
|
|
31064
31717
|
type: 'array',
|
|
31065
31718
|
},
|
|
@@ -31158,6 +31811,8 @@ export default {
|
|
|
31158
31811
|
type: 'string',
|
|
31159
31812
|
},
|
|
31160
31813
|
unstable_location_id: {
|
|
31814
|
+
description:
|
|
31815
|
+
'ID of the location for which you want to list devices.',
|
|
31161
31816
|
format: 'uuid',
|
|
31162
31817
|
nullable: true,
|
|
31163
31818
|
type: 'string',
|
|
@@ -31165,7 +31820,7 @@ export default {
|
|
|
31165
31820
|
},
|
|
31166
31821
|
user_identifier_key: {
|
|
31167
31822
|
description:
|
|
31168
|
-
'Your own internal user ID for the user
|
|
31823
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
31169
31824
|
type: 'string',
|
|
31170
31825
|
},
|
|
31171
31826
|
},
|
|
@@ -34484,6 +35139,101 @@ export default {
|
|
|
34484
35139
|
'x-undocumented': 'Experimental locations.',
|
|
34485
35140
|
},
|
|
34486
35141
|
},
|
|
35142
|
+
'/unstable_partner/resources/push': {
|
|
35143
|
+
post: {
|
|
35144
|
+
description: 'Send Seam some of your resources.',
|
|
35145
|
+
operationId: 'unstablePartnerResourcesPushPost',
|
|
35146
|
+
requestBody: {
|
|
35147
|
+
content: {
|
|
35148
|
+
'application/json': {
|
|
35149
|
+
schema: {
|
|
35150
|
+
oneOf: [
|
|
35151
|
+
{
|
|
35152
|
+
items: {
|
|
35153
|
+
properties: {
|
|
35154
|
+
custom_metadata: {
|
|
35155
|
+
additionalProperties: { type: 'string' },
|
|
35156
|
+
type: 'object',
|
|
35157
|
+
},
|
|
35158
|
+
customer_key: { type: 'string' },
|
|
35159
|
+
description: { type: 'string' },
|
|
35160
|
+
email_address: { type: 'string' },
|
|
35161
|
+
ends_at: { type: 'string' },
|
|
35162
|
+
icon_url: { type: 'string' },
|
|
35163
|
+
location_keys: {
|
|
35164
|
+
items: { type: 'string' },
|
|
35165
|
+
type: 'array',
|
|
35166
|
+
},
|
|
35167
|
+
name: { type: 'string' },
|
|
35168
|
+
partner_resource_key: { type: 'string' },
|
|
35169
|
+
partner_resource_type: { type: 'string' },
|
|
35170
|
+
phone_number: { type: 'string' },
|
|
35171
|
+
starts_at: { type: 'string' },
|
|
35172
|
+
user_identity_key: { type: 'string' },
|
|
35173
|
+
},
|
|
35174
|
+
type: 'object',
|
|
35175
|
+
},
|
|
35176
|
+
type: 'array',
|
|
35177
|
+
},
|
|
35178
|
+
{
|
|
35179
|
+
properties: {
|
|
35180
|
+
custom_metadata: {
|
|
35181
|
+
additionalProperties: { type: 'string' },
|
|
35182
|
+
type: 'object',
|
|
35183
|
+
},
|
|
35184
|
+
customer_key: { type: 'string' },
|
|
35185
|
+
description: { type: 'string' },
|
|
35186
|
+
email_address: { type: 'string' },
|
|
35187
|
+
ends_at: { type: 'string' },
|
|
35188
|
+
icon_url: { type: 'string' },
|
|
35189
|
+
location_keys: {
|
|
35190
|
+
items: { type: 'string' },
|
|
35191
|
+
type: 'array',
|
|
35192
|
+
},
|
|
35193
|
+
name: { type: 'string' },
|
|
35194
|
+
partner_resource_key: { type: 'string' },
|
|
35195
|
+
partner_resource_type: { type: 'string' },
|
|
35196
|
+
phone_number: { type: 'string' },
|
|
35197
|
+
starts_at: { type: 'string' },
|
|
35198
|
+
user_identity_key: { type: 'string' },
|
|
35199
|
+
},
|
|
35200
|
+
type: 'object',
|
|
35201
|
+
},
|
|
35202
|
+
],
|
|
35203
|
+
},
|
|
35204
|
+
},
|
|
35205
|
+
},
|
|
35206
|
+
},
|
|
35207
|
+
responses: {
|
|
35208
|
+
200: {
|
|
35209
|
+
content: {
|
|
35210
|
+
'application/json': {
|
|
35211
|
+
schema: {
|
|
35212
|
+
properties: { ok: { type: 'boolean' } },
|
|
35213
|
+
required: ['ok'],
|
|
35214
|
+
type: 'object',
|
|
35215
|
+
},
|
|
35216
|
+
},
|
|
35217
|
+
},
|
|
35218
|
+
description: 'OK',
|
|
35219
|
+
},
|
|
35220
|
+
400: { description: 'Bad Request' },
|
|
35221
|
+
401: { description: 'Unauthorized' },
|
|
35222
|
+
},
|
|
35223
|
+
security: [
|
|
35224
|
+
{ pat_with_workspace: [] },
|
|
35225
|
+
{ console_session_with_workspace: [] },
|
|
35226
|
+
{ api_key: [] },
|
|
35227
|
+
],
|
|
35228
|
+
summary: '/unstable_partner/resources/push',
|
|
35229
|
+
tags: [],
|
|
35230
|
+
'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
|
|
35231
|
+
'x-fern-sdk-method-name': 'push',
|
|
35232
|
+
'x-response-key': null,
|
|
35233
|
+
'x-title': 'Push partner resources at Seam',
|
|
35234
|
+
'x-undocumented': 'Experimental partner resources.',
|
|
35235
|
+
},
|
|
35236
|
+
},
|
|
34487
35237
|
'/user_identities/add_acs_user': {
|
|
34488
35238
|
post: {
|
|
34489
35239
|
description:
|
|
@@ -34678,7 +35428,7 @@ export default {
|
|
|
34678
35428
|
'/user_identities/delete': {
|
|
34679
35429
|
post: {
|
|
34680
35430
|
description:
|
|
34681
|
-
'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 [
|
|
35431
|
+
'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.',
|
|
34682
35432
|
operationId: 'userIdentitiesDeletePost',
|
|
34683
35433
|
requestBody: {
|
|
34684
35434
|
content: {
|
|
@@ -36274,6 +37024,8 @@ export default {
|
|
|
36274
37024
|
},
|
|
36275
37025
|
'/workspaces/reset_sandbox': {
|
|
36276
37026
|
post: {
|
|
37027
|
+
description:
|
|
37028
|
+
'Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.',
|
|
36277
37029
|
operationId: 'workspacesResetSandboxPost',
|
|
36278
37030
|
responses: {
|
|
36279
37031
|
200: {
|