@seamapi/types 1.399.0 → 1.399.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +877 -295
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +835 -178
- 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 +371 -0
- package/lib/seam/connect/openapi.js +795 -256
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +464 -178
- 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 +996 -256
- package/src/lib/seam/connect/route-types.ts +466 -178
|
@@ -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,12 +20842,14 @@ 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.',
|
|
20811
20853
|
format: 'uuid',
|
|
20812
20854
|
type: 'string',
|
|
20813
20855
|
},
|
|
@@ -20848,7 +20890,7 @@ export default {
|
|
|
20848
20890
|
},
|
|
20849
20891
|
put: {
|
|
20850
20892
|
description:
|
|
20851
|
-
'Adds a specified [
|
|
20893
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
20852
20894
|
operationId: 'acsAccessGroupsAddUserPut',
|
|
20853
20895
|
requestBody: {
|
|
20854
20896
|
content: {
|
|
@@ -20856,12 +20898,14 @@ export default {
|
|
|
20856
20898
|
schema: {
|
|
20857
20899
|
properties: {
|
|
20858
20900
|
acs_access_group_id: {
|
|
20859
|
-
description:
|
|
20901
|
+
description:
|
|
20902
|
+
'ID of the access group to which you want to add an access system user.',
|
|
20860
20903
|
format: 'uuid',
|
|
20861
20904
|
type: 'string',
|
|
20862
20905
|
},
|
|
20863
20906
|
acs_user_id: {
|
|
20864
|
-
description:
|
|
20907
|
+
description:
|
|
20908
|
+
'ID of the access system user that you want to add to an access group.',
|
|
20865
20909
|
format: 'uuid',
|
|
20866
20910
|
type: 'string',
|
|
20867
20911
|
},
|
|
@@ -20911,7 +20955,7 @@ export default {
|
|
|
20911
20955
|
schema: {
|
|
20912
20956
|
properties: {
|
|
20913
20957
|
acs_access_group_id: {
|
|
20914
|
-
description: 'ID of the
|
|
20958
|
+
description: 'ID of the access group that you want to get.',
|
|
20915
20959
|
format: 'uuid',
|
|
20916
20960
|
type: 'string',
|
|
20917
20961
|
},
|
|
@@ -20969,13 +21013,13 @@ export default {
|
|
|
20969
21013
|
properties: {
|
|
20970
21014
|
acs_system_id: {
|
|
20971
21015
|
description:
|
|
20972
|
-
'ID of the access
|
|
21016
|
+
'ID of the access system for which you want to retrieve all access groups.',
|
|
20973
21017
|
format: 'uuid',
|
|
20974
21018
|
type: 'string',
|
|
20975
21019
|
},
|
|
20976
21020
|
acs_user_id: {
|
|
20977
21021
|
description:
|
|
20978
|
-
'ID of the user for which you want to retrieve all access groups.',
|
|
21022
|
+
'ID of the access system user for which you want to retrieve all access groups.',
|
|
20979
21023
|
format: 'uuid',
|
|
20980
21024
|
type: 'string',
|
|
20981
21025
|
},
|
|
@@ -21089,7 +21133,7 @@ export default {
|
|
|
21089
21133
|
'/acs/access_groups/list_users': {
|
|
21090
21134
|
post: {
|
|
21091
21135
|
description:
|
|
21092
|
-
'Returns a list of all [
|
|
21136
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
21093
21137
|
operationId: 'acsAccessGroupsListUsersPost',
|
|
21094
21138
|
requestBody: {
|
|
21095
21139
|
content: {
|
|
@@ -21098,7 +21142,7 @@ export default {
|
|
|
21098
21142
|
properties: {
|
|
21099
21143
|
acs_access_group_id: {
|
|
21100
21144
|
description:
|
|
21101
|
-
'ID of the access group for which you want to retrieve all users.',
|
|
21145
|
+
'ID of the access group for which you want to retrieve all access system users.',
|
|
21102
21146
|
format: 'uuid',
|
|
21103
21147
|
type: 'string',
|
|
21104
21148
|
},
|
|
@@ -21148,7 +21192,7 @@ export default {
|
|
|
21148
21192
|
'/acs/access_groups/remove_user': {
|
|
21149
21193
|
post: {
|
|
21150
21194
|
description:
|
|
21151
|
-
'Removes a specified [
|
|
21195
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
21152
21196
|
operationId: 'acsAccessGroupsRemoveUserPost',
|
|
21153
21197
|
requestBody: {
|
|
21154
21198
|
content: {
|
|
@@ -21156,17 +21200,20 @@ export default {
|
|
|
21156
21200
|
schema: {
|
|
21157
21201
|
properties: {
|
|
21158
21202
|
acs_access_group_id: {
|
|
21159
|
-
description:
|
|
21203
|
+
description:
|
|
21204
|
+
'ID of the access group from which you want to remove an access system user.',
|
|
21160
21205
|
format: 'uuid',
|
|
21161
21206
|
type: 'string',
|
|
21162
21207
|
},
|
|
21163
21208
|
acs_user_id: {
|
|
21164
|
-
description:
|
|
21209
|
+
description:
|
|
21210
|
+
'ID of the access system user that you want to remove from an access group.',
|
|
21165
21211
|
format: 'uuid',
|
|
21166
21212
|
type: 'string',
|
|
21167
21213
|
},
|
|
21168
21214
|
user_identity_id: {
|
|
21169
|
-
description:
|
|
21215
|
+
description:
|
|
21216
|
+
'ID of the user identity associated with the user that you want to remove from an access group.',
|
|
21170
21217
|
format: 'uuid',
|
|
21171
21218
|
type: 'string',
|
|
21172
21219
|
},
|
|
@@ -21217,7 +21264,8 @@ export default {
|
|
|
21217
21264
|
schema: {
|
|
21218
21265
|
properties: {
|
|
21219
21266
|
acs_access_group_id: {
|
|
21220
|
-
description:
|
|
21267
|
+
description:
|
|
21268
|
+
'ID of the unmanaged access group that you want to get.',
|
|
21221
21269
|
format: 'uuid',
|
|
21222
21270
|
type: 'string',
|
|
21223
21271
|
},
|
|
@@ -21260,6 +21308,7 @@ export default {
|
|
|
21260
21308
|
'x-fern-sdk-method-name': 'get',
|
|
21261
21309
|
'x-fern-sdk-return-value': 'acs_access_group',
|
|
21262
21310
|
'x-response-key': 'acs_access_group',
|
|
21311
|
+
'x-title': 'Get an Unmanaged Access Group',
|
|
21263
21312
|
'x-undocumented':
|
|
21264
21313
|
'No unmanaged access groups are currently implemented.',
|
|
21265
21314
|
},
|
|
@@ -21276,13 +21325,13 @@ export default {
|
|
|
21276
21325
|
properties: {
|
|
21277
21326
|
acs_system_id: {
|
|
21278
21327
|
description:
|
|
21279
|
-
'ID of the access
|
|
21328
|
+
'ID of the access system for which you want to retrieve all unmanaged access groups.',
|
|
21280
21329
|
format: 'uuid',
|
|
21281
21330
|
type: 'string',
|
|
21282
21331
|
},
|
|
21283
21332
|
acs_user_id: {
|
|
21284
21333
|
description:
|
|
21285
|
-
'ID of the user for which you want to retrieve all unmanaged access groups.',
|
|
21334
|
+
'ID of the access system user for which you want to retrieve all unmanaged access groups.',
|
|
21286
21335
|
format: 'uuid',
|
|
21287
21336
|
type: 'string',
|
|
21288
21337
|
},
|
|
@@ -21327,19 +21376,26 @@ export default {
|
|
|
21327
21376
|
'x-fern-sdk-method-name': 'list',
|
|
21328
21377
|
'x-fern-sdk-return-value': 'acs_access_groups',
|
|
21329
21378
|
'x-response-key': 'acs_access_groups',
|
|
21379
|
+
'x-title': 'List Unmanaged Access Groups',
|
|
21330
21380
|
'x-undocumented':
|
|
21331
21381
|
'No unmanaged access groups are currently implemented.',
|
|
21332
21382
|
},
|
|
21333
21383
|
},
|
|
21334
21384
|
'/acs/credential_pools/list': {
|
|
21335
21385
|
post: {
|
|
21386
|
+
description: 'Returns a list of all credential pools.',
|
|
21336
21387
|
operationId: 'acsCredentialPoolsListPost',
|
|
21337
21388
|
requestBody: {
|
|
21338
21389
|
content: {
|
|
21339
21390
|
'application/json': {
|
|
21340
21391
|
schema: {
|
|
21341
21392
|
properties: {
|
|
21342
|
-
acs_system_id: {
|
|
21393
|
+
acs_system_id: {
|
|
21394
|
+
description:
|
|
21395
|
+
'ID of the access system for which you want to list credential pools.',
|
|
21396
|
+
format: 'uuid',
|
|
21397
|
+
type: 'string',
|
|
21398
|
+
},
|
|
21343
21399
|
},
|
|
21344
21400
|
required: ['acs_system_id'],
|
|
21345
21401
|
type: 'object',
|
|
@@ -21384,28 +21440,48 @@ export default {
|
|
|
21384
21440
|
'x-fern-sdk-method-name': 'list',
|
|
21385
21441
|
'x-fern-sdk-return-value': 'acs_credential_pools',
|
|
21386
21442
|
'x-response-key': 'acs_credential_pools',
|
|
21443
|
+
'x-title': 'List Credential Pools',
|
|
21387
21444
|
'x-undocumented': 'Replaced by enrollment automations.',
|
|
21388
21445
|
},
|
|
21389
21446
|
},
|
|
21390
21447
|
'/acs/credential_provisioning_automations/launch': {
|
|
21391
21448
|
post: {
|
|
21449
|
+
description: 'Launches a credential provisioning automation.',
|
|
21392
21450
|
operationId: 'acsCredentialProvisioningAutomationsLaunchPost',
|
|
21393
21451
|
requestBody: {
|
|
21394
21452
|
content: {
|
|
21395
21453
|
'application/json': {
|
|
21396
21454
|
schema: {
|
|
21397
21455
|
properties: {
|
|
21398
|
-
acs_credential_pool_id: {
|
|
21399
|
-
|
|
21456
|
+
acs_credential_pool_id: {
|
|
21457
|
+
description:
|
|
21458
|
+
'ID of the credential pool for which you want to launch a credential provisioning automation.',
|
|
21459
|
+
format: 'uuid',
|
|
21460
|
+
type: 'string',
|
|
21461
|
+
},
|
|
21462
|
+
create_credential_manager_user: {
|
|
21463
|
+
description:
|
|
21464
|
+
'Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`.',
|
|
21465
|
+
type: 'boolean',
|
|
21466
|
+
},
|
|
21400
21467
|
credential_manager_acs_system_id: {
|
|
21468
|
+
description:
|
|
21469
|
+
'Access system ID of the credential manager for which you want to launch a credential provisioning automation.',
|
|
21401
21470
|
format: 'uuid',
|
|
21402
21471
|
type: 'string',
|
|
21403
21472
|
},
|
|
21404
21473
|
credential_manager_acs_user_id: {
|
|
21474
|
+
description:
|
|
21475
|
+
'ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`.',
|
|
21476
|
+
format: 'uuid',
|
|
21477
|
+
type: 'string',
|
|
21478
|
+
},
|
|
21479
|
+
user_identity_id: {
|
|
21480
|
+
description:
|
|
21481
|
+
'ID of the user identity for which you want to launch a credential provisioning automation.',
|
|
21405
21482
|
format: 'uuid',
|
|
21406
21483
|
type: 'string',
|
|
21407
21484
|
},
|
|
21408
|
-
user_identity_id: { format: 'uuid', type: 'string' },
|
|
21409
21485
|
},
|
|
21410
21486
|
required: [
|
|
21411
21487
|
'user_identity_id',
|
|
@@ -21450,13 +21526,14 @@ export default {
|
|
|
21450
21526
|
'x-fern-sdk-method-name': 'launch',
|
|
21451
21527
|
'x-fern-sdk-return-value': 'acs_credential_provisioning_automation',
|
|
21452
21528
|
'x-response-key': 'acs_credential_provisioning_automation',
|
|
21529
|
+
'x-title': 'Launch a Credential Provisioning Automation',
|
|
21453
21530
|
'x-undocumented': 'Replaced by enrollment automations.',
|
|
21454
21531
|
},
|
|
21455
21532
|
},
|
|
21456
21533
|
'/acs/credentials/assign': {
|
|
21457
21534
|
patch: {
|
|
21458
21535
|
description:
|
|
21459
|
-
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [
|
|
21536
|
+
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
21460
21537
|
operationId: 'acsCredentialsAssignPatch',
|
|
21461
21538
|
requestBody: {
|
|
21462
21539
|
content: {
|
|
@@ -21464,12 +21541,14 @@ export default {
|
|
|
21464
21541
|
schema: {
|
|
21465
21542
|
properties: {
|
|
21466
21543
|
acs_credential_id: {
|
|
21467
|
-
description:
|
|
21544
|
+
description:
|
|
21545
|
+
'ID of the credential that you want to assign to an access system user.',
|
|
21468
21546
|
format: 'uuid',
|
|
21469
21547
|
type: 'string',
|
|
21470
21548
|
},
|
|
21471
21549
|
acs_user_id: {
|
|
21472
|
-
description:
|
|
21550
|
+
description:
|
|
21551
|
+
'ID of the access system user to whom you want to assign a credential.',
|
|
21473
21552
|
format: 'uuid',
|
|
21474
21553
|
type: 'string',
|
|
21475
21554
|
},
|
|
@@ -21514,7 +21593,7 @@ export default {
|
|
|
21514
21593
|
},
|
|
21515
21594
|
post: {
|
|
21516
21595
|
description:
|
|
21517
|
-
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [
|
|
21596
|
+
'Assigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) to a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
21518
21597
|
operationId: 'acsCredentialsAssignPost',
|
|
21519
21598
|
requestBody: {
|
|
21520
21599
|
content: {
|
|
@@ -21522,12 +21601,14 @@ export default {
|
|
|
21522
21601
|
schema: {
|
|
21523
21602
|
properties: {
|
|
21524
21603
|
acs_credential_id: {
|
|
21525
|
-
description:
|
|
21604
|
+
description:
|
|
21605
|
+
'ID of the credential that you want to assign to an access system user.',
|
|
21526
21606
|
format: 'uuid',
|
|
21527
21607
|
type: 'string',
|
|
21528
21608
|
},
|
|
21529
21609
|
acs_user_id: {
|
|
21530
|
-
description:
|
|
21610
|
+
description:
|
|
21611
|
+
'ID of the access system user to whom you want to assign a credential.',
|
|
21531
21612
|
format: 'uuid',
|
|
21532
21613
|
type: 'string',
|
|
21533
21614
|
},
|
|
@@ -21590,13 +21671,13 @@ export default {
|
|
|
21590
21671
|
},
|
|
21591
21672
|
acs_system_id: {
|
|
21592
21673
|
description:
|
|
21593
|
-
'ID of the
|
|
21674
|
+
'ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.',
|
|
21594
21675
|
format: 'uuid',
|
|
21595
21676
|
type: 'string',
|
|
21596
21677
|
},
|
|
21597
21678
|
acs_user_id: {
|
|
21598
21679
|
description:
|
|
21599
|
-
'ID of the
|
|
21680
|
+
'ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`.',
|
|
21600
21681
|
format: 'uuid',
|
|
21601
21682
|
type: 'string',
|
|
21602
21683
|
},
|
|
@@ -21649,8 +21730,16 @@ export default {
|
|
|
21649
21730
|
description:
|
|
21650
21731
|
'Salto Space-specific metadata for the new credential.',
|
|
21651
21732
|
properties: {
|
|
21652
|
-
assign_new_key: {
|
|
21653
|
-
|
|
21733
|
+
assign_new_key: {
|
|
21734
|
+
description:
|
|
21735
|
+
'Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).',
|
|
21736
|
+
type: 'boolean',
|
|
21737
|
+
},
|
|
21738
|
+
update_current_key: {
|
|
21739
|
+
description:
|
|
21740
|
+
"Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials).",
|
|
21741
|
+
type: 'boolean',
|
|
21742
|
+
},
|
|
21654
21743
|
},
|
|
21655
21744
|
type: 'object',
|
|
21656
21745
|
},
|
|
@@ -21662,7 +21751,7 @@ export default {
|
|
|
21662
21751
|
},
|
|
21663
21752
|
user_identity_id: {
|
|
21664
21753
|
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
|
|
21754
|
+
'ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created.',
|
|
21666
21755
|
format: 'uuid',
|
|
21667
21756
|
type: 'string',
|
|
21668
21757
|
},
|
|
@@ -21748,7 +21837,7 @@ export default {
|
|
|
21748
21837
|
'/acs/credentials/create_offline_code': {
|
|
21749
21838
|
post: {
|
|
21750
21839
|
description:
|
|
21751
|
-
'Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [
|
|
21840
|
+
'Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
21752
21841
|
operationId: 'acsCredentialsCreateOfflineCodePost',
|
|
21753
21842
|
requestBody: {
|
|
21754
21843
|
content: {
|
|
@@ -21757,7 +21846,7 @@ export default {
|
|
|
21757
21846
|
properties: {
|
|
21758
21847
|
acs_user_id: {
|
|
21759
21848
|
description:
|
|
21760
|
-
'ID of the
|
|
21849
|
+
'ID of the access system user to whom the new credential belongs.',
|
|
21761
21850
|
format: 'uuid',
|
|
21762
21851
|
type: 'string',
|
|
21763
21852
|
},
|
|
@@ -21839,7 +21928,8 @@ export default {
|
|
|
21839
21928
|
schema: {
|
|
21840
21929
|
properties: {
|
|
21841
21930
|
acs_credential_id: {
|
|
21842
|
-
description:
|
|
21931
|
+
description:
|
|
21932
|
+
'ID of the credential that you want to delete.',
|
|
21843
21933
|
format: 'uuid',
|
|
21844
21934
|
type: 'string',
|
|
21845
21935
|
},
|
|
@@ -21890,7 +21980,7 @@ export default {
|
|
|
21890
21980
|
schema: {
|
|
21891
21981
|
properties: {
|
|
21892
21982
|
acs_credential_id: {
|
|
21893
|
-
description: 'ID of the
|
|
21983
|
+
description: 'ID of the credential that you want to get.',
|
|
21894
21984
|
format: 'uuid',
|
|
21895
21985
|
type: 'string',
|
|
21896
21986
|
},
|
|
@@ -21952,7 +22042,7 @@ export default {
|
|
|
21952
22042
|
properties: {
|
|
21953
22043
|
acs_user_id: {
|
|
21954
22044
|
description:
|
|
21955
|
-
'ID of the
|
|
22045
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
21956
22046
|
format: 'uuid',
|
|
21957
22047
|
type: 'string',
|
|
21958
22048
|
},
|
|
@@ -21964,7 +22054,7 @@ export default {
|
|
|
21964
22054
|
properties: {
|
|
21965
22055
|
acs_system_id: {
|
|
21966
22056
|
description:
|
|
21967
|
-
'ID of the access
|
|
22057
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
21968
22058
|
format: 'uuid',
|
|
21969
22059
|
type: 'string',
|
|
21970
22060
|
},
|
|
@@ -21976,13 +22066,13 @@ export default {
|
|
|
21976
22066
|
properties: {
|
|
21977
22067
|
acs_system_id: {
|
|
21978
22068
|
description:
|
|
21979
|
-
'ID of the access
|
|
22069
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
21980
22070
|
format: 'uuid',
|
|
21981
22071
|
type: 'string',
|
|
21982
22072
|
},
|
|
21983
22073
|
acs_user_id: {
|
|
21984
22074
|
description:
|
|
21985
|
-
'ID of the
|
|
22075
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
21986
22076
|
format: 'uuid',
|
|
21987
22077
|
type: 'string',
|
|
21988
22078
|
},
|
|
@@ -22081,7 +22171,7 @@ export default {
|
|
|
22081
22171
|
properties: {
|
|
22082
22172
|
acs_credential_id: {
|
|
22083
22173
|
description:
|
|
22084
|
-
'ID of the credential for which you want to retrieve all entrances to which
|
|
22174
|
+
'ID of the credential for which you want to retrieve all entrances to which the credential grants access.',
|
|
22085
22175
|
format: 'uuid',
|
|
22086
22176
|
type: 'string',
|
|
22087
22177
|
},
|
|
@@ -22131,7 +22221,7 @@ export default {
|
|
|
22131
22221
|
'/acs/credentials/unassign': {
|
|
22132
22222
|
patch: {
|
|
22133
22223
|
description:
|
|
22134
|
-
'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [
|
|
22224
|
+
'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
22135
22225
|
operationId: 'acsCredentialsUnassignPatch',
|
|
22136
22226
|
requestBody: {
|
|
22137
22227
|
content: {
|
|
@@ -22139,12 +22229,14 @@ export default {
|
|
|
22139
22229
|
schema: {
|
|
22140
22230
|
properties: {
|
|
22141
22231
|
acs_credential_id: {
|
|
22142
|
-
description:
|
|
22232
|
+
description:
|
|
22233
|
+
'ID of the credential that you want to unassign from an access system user.',
|
|
22143
22234
|
format: 'uuid',
|
|
22144
22235
|
type: 'string',
|
|
22145
22236
|
},
|
|
22146
22237
|
acs_user_id: {
|
|
22147
|
-
description:
|
|
22238
|
+
description:
|
|
22239
|
+
'ID of the access system user from which you want to unassign a credential.',
|
|
22148
22240
|
format: 'uuid',
|
|
22149
22241
|
type: 'string',
|
|
22150
22242
|
},
|
|
@@ -22189,7 +22281,7 @@ export default {
|
|
|
22189
22281
|
},
|
|
22190
22282
|
post: {
|
|
22191
22283
|
description:
|
|
22192
|
-
'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [
|
|
22284
|
+
'Unassigns a specified [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) from a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
22193
22285
|
operationId: 'acsCredentialsUnassignPost',
|
|
22194
22286
|
requestBody: {
|
|
22195
22287
|
content: {
|
|
@@ -22197,12 +22289,14 @@ export default {
|
|
|
22197
22289
|
schema: {
|
|
22198
22290
|
properties: {
|
|
22199
22291
|
acs_credential_id: {
|
|
22200
|
-
description:
|
|
22292
|
+
description:
|
|
22293
|
+
'ID of the credential that you want to unassign from an access system user.',
|
|
22201
22294
|
format: 'uuid',
|
|
22202
22295
|
type: 'string',
|
|
22203
22296
|
},
|
|
22204
22297
|
acs_user_id: {
|
|
22205
|
-
description:
|
|
22298
|
+
description:
|
|
22299
|
+
'ID of the access system user from which you want to unassign a credential.',
|
|
22206
22300
|
format: 'uuid',
|
|
22207
22301
|
type: 'string',
|
|
22208
22302
|
},
|
|
@@ -22258,7 +22352,8 @@ export default {
|
|
|
22258
22352
|
schema: {
|
|
22259
22353
|
properties: {
|
|
22260
22354
|
acs_credential_id: {
|
|
22261
|
-
description:
|
|
22355
|
+
description:
|
|
22356
|
+
'ID of the unmanaged credential that you want to get.',
|
|
22262
22357
|
format: 'uuid',
|
|
22263
22358
|
type: 'string',
|
|
22264
22359
|
},
|
|
@@ -22316,10 +22411,12 @@ export default {
|
|
|
22316
22411
|
schema: {
|
|
22317
22412
|
oneOf: [
|
|
22318
22413
|
{
|
|
22414
|
+
description:
|
|
22415
|
+
'ID of the access system user for which you want to list unmanaged credentials.',
|
|
22319
22416
|
properties: {
|
|
22320
22417
|
acs_user_id: {
|
|
22321
22418
|
description:
|
|
22322
|
-
'ID of the
|
|
22419
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
22323
22420
|
format: 'uuid',
|
|
22324
22421
|
type: 'string',
|
|
22325
22422
|
},
|
|
@@ -22328,10 +22425,12 @@ export default {
|
|
|
22328
22425
|
type: 'object',
|
|
22329
22426
|
},
|
|
22330
22427
|
{
|
|
22428
|
+
description:
|
|
22429
|
+
'ID of the access system for which you want to list unmanaged credentials.',
|
|
22331
22430
|
properties: {
|
|
22332
22431
|
acs_system_id: {
|
|
22333
22432
|
description:
|
|
22334
|
-
'ID of the access
|
|
22433
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
22335
22434
|
format: 'uuid',
|
|
22336
22435
|
type: 'string',
|
|
22337
22436
|
},
|
|
@@ -22340,16 +22439,18 @@ export default {
|
|
|
22340
22439
|
type: 'object',
|
|
22341
22440
|
},
|
|
22342
22441
|
{
|
|
22442
|
+
description:
|
|
22443
|
+
'ID of the access system and ID of the access system user for which you want to list unmanaged credentials.',
|
|
22343
22444
|
properties: {
|
|
22344
22445
|
acs_system_id: {
|
|
22345
22446
|
description:
|
|
22346
|
-
'ID of the access
|
|
22447
|
+
'ID of the access system for which you want to retrieve all credentials.',
|
|
22347
22448
|
format: 'uuid',
|
|
22348
22449
|
type: 'string',
|
|
22349
22450
|
},
|
|
22350
22451
|
acs_user_id: {
|
|
22351
22452
|
description:
|
|
22352
|
-
'ID of the
|
|
22453
|
+
'ID of the access system user for which you want to retrieve all credentials.',
|
|
22353
22454
|
format: 'uuid',
|
|
22354
22455
|
type: 'string',
|
|
22355
22456
|
},
|
|
@@ -22358,6 +22459,8 @@ export default {
|
|
|
22358
22459
|
type: 'object',
|
|
22359
22460
|
},
|
|
22360
22461
|
{
|
|
22462
|
+
description:
|
|
22463
|
+
'ID of the user identity for which you want to list unmanaged credentials.',
|
|
22361
22464
|
properties: {
|
|
22362
22465
|
user_identity_id: {
|
|
22363
22466
|
description:
|
|
@@ -22424,12 +22527,13 @@ export default {
|
|
|
22424
22527
|
schema: {
|
|
22425
22528
|
properties: {
|
|
22426
22529
|
acs_credential_id: {
|
|
22427
|
-
description:
|
|
22530
|
+
description:
|
|
22531
|
+
'ID of the credential that you want to update.',
|
|
22428
22532
|
type: 'string',
|
|
22429
22533
|
},
|
|
22430
22534
|
code: {
|
|
22431
22535
|
description:
|
|
22432
|
-
'Replacement access (PIN) code for the credential.',
|
|
22536
|
+
'Replacement access (PIN) code for the credential that you want to update.',
|
|
22433
22537
|
pattern: '^\\d+$',
|
|
22434
22538
|
type: 'string',
|
|
22435
22539
|
},
|
|
@@ -22488,12 +22592,13 @@ export default {
|
|
|
22488
22592
|
schema: {
|
|
22489
22593
|
properties: {
|
|
22490
22594
|
acs_credential_id: {
|
|
22491
|
-
description:
|
|
22595
|
+
description:
|
|
22596
|
+
'ID of the credential that you want to update.',
|
|
22492
22597
|
type: 'string',
|
|
22493
22598
|
},
|
|
22494
22599
|
code: {
|
|
22495
22600
|
description:
|
|
22496
|
-
'Replacement access (PIN) code for the credential.',
|
|
22601
|
+
'Replacement access (PIN) code for the credential that you want to update.',
|
|
22497
22602
|
pattern: '^\\d+$',
|
|
22498
22603
|
type: 'string',
|
|
22499
22604
|
},
|
|
@@ -22685,7 +22790,7 @@ export default {
|
|
|
22685
22790
|
schema: {
|
|
22686
22791
|
properties: {
|
|
22687
22792
|
acs_encoder_id: {
|
|
22688
|
-
description: 'ID of the
|
|
22793
|
+
description: 'ID of the encoder that you want to get.',
|
|
22689
22794
|
format: 'uuid',
|
|
22690
22795
|
type: 'string',
|
|
22691
22796
|
},
|
|
@@ -22743,13 +22848,13 @@ export default {
|
|
|
22743
22848
|
properties: {
|
|
22744
22849
|
acs_system_id: {
|
|
22745
22850
|
description:
|
|
22746
|
-
'ID of the
|
|
22851
|
+
'ID of the access system for which you want to retrieve all encoders.',
|
|
22747
22852
|
format: 'uuid',
|
|
22748
22853
|
type: 'string',
|
|
22749
22854
|
},
|
|
22750
22855
|
limit: {
|
|
22751
22856
|
default: 500,
|
|
22752
|
-
description: 'Number of
|
|
22857
|
+
description: 'Number of encoders to return.',
|
|
22753
22858
|
format: 'float',
|
|
22754
22859
|
type: 'number',
|
|
22755
22860
|
},
|
|
@@ -22761,13 +22866,13 @@ export default {
|
|
|
22761
22866
|
properties: {
|
|
22762
22867
|
acs_system_ids: {
|
|
22763
22868
|
description:
|
|
22764
|
-
'IDs of the
|
|
22869
|
+
'IDs of the access systems for which you want to retrieve all encoders.',
|
|
22765
22870
|
items: { format: 'uuid', type: 'string' },
|
|
22766
22871
|
type: 'array',
|
|
22767
22872
|
},
|
|
22768
22873
|
limit: {
|
|
22769
22874
|
default: 500,
|
|
22770
|
-
description: 'Number of
|
|
22875
|
+
description: 'Number of encoders to return.',
|
|
22771
22876
|
format: 'float',
|
|
22772
22877
|
type: 'number',
|
|
22773
22878
|
},
|
|
@@ -22779,13 +22884,13 @@ export default {
|
|
|
22779
22884
|
properties: {
|
|
22780
22885
|
acs_encoder_ids: {
|
|
22781
22886
|
description:
|
|
22782
|
-
'IDs of the
|
|
22887
|
+
'IDs of the encoders that you want to retrieve.',
|
|
22783
22888
|
items: { format: 'uuid', type: 'string' },
|
|
22784
22889
|
type: 'array',
|
|
22785
22890
|
},
|
|
22786
22891
|
limit: {
|
|
22787
22892
|
default: 500,
|
|
22788
|
-
description: 'Number of
|
|
22893
|
+
description: 'Number of encoders to return.',
|
|
22789
22894
|
format: 'float',
|
|
22790
22895
|
type: 'number',
|
|
22791
22896
|
},
|
|
@@ -22845,7 +22950,7 @@ export default {
|
|
|
22845
22950
|
schema: {
|
|
22846
22951
|
properties: {
|
|
22847
22952
|
acs_encoder_id: {
|
|
22848
|
-
description: 'ID of the
|
|
22953
|
+
description: 'ID of the encoder to use for the scan.',
|
|
22849
22954
|
format: 'uuid',
|
|
22850
22955
|
type: 'string',
|
|
22851
22956
|
},
|
|
@@ -23232,14 +23337,18 @@ export default {
|
|
|
23232
23337
|
'/acs/entrances/get': {
|
|
23233
23338
|
post: {
|
|
23234
23339
|
description:
|
|
23235
|
-
'Returns a specified [
|
|
23340
|
+
'Returns a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
23236
23341
|
operationId: 'acsEntrancesGetPost',
|
|
23237
23342
|
requestBody: {
|
|
23238
23343
|
content: {
|
|
23239
23344
|
'application/json': {
|
|
23240
23345
|
schema: {
|
|
23241
23346
|
properties: {
|
|
23242
|
-
acs_entrance_id: {
|
|
23347
|
+
acs_entrance_id: {
|
|
23348
|
+
description: 'ID of the entrance that you want to get.',
|
|
23349
|
+
format: 'uuid',
|
|
23350
|
+
type: 'string',
|
|
23351
|
+
},
|
|
23243
23352
|
},
|
|
23244
23353
|
required: ['acs_entrance_id'],
|
|
23245
23354
|
type: 'object',
|
|
@@ -23283,14 +23392,26 @@ export default {
|
|
|
23283
23392
|
},
|
|
23284
23393
|
'/acs/entrances/grant_access': {
|
|
23285
23394
|
post: {
|
|
23395
|
+
description:
|
|
23396
|
+
'Grants a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
23286
23397
|
operationId: 'acsEntrancesGrantAccessPost',
|
|
23287
23398
|
requestBody: {
|
|
23288
23399
|
content: {
|
|
23289
23400
|
'application/json': {
|
|
23290
23401
|
schema: {
|
|
23291
23402
|
properties: {
|
|
23292
|
-
acs_entrance_id: {
|
|
23293
|
-
|
|
23403
|
+
acs_entrance_id: {
|
|
23404
|
+
description:
|
|
23405
|
+
'ID of the entrance to which you want to grant an access system user access.',
|
|
23406
|
+
format: 'uuid',
|
|
23407
|
+
type: 'string',
|
|
23408
|
+
},
|
|
23409
|
+
acs_user_id: {
|
|
23410
|
+
description:
|
|
23411
|
+
'ID of the access system user to whom you want to grant access to an entrance.',
|
|
23412
|
+
format: 'uuid',
|
|
23413
|
+
type: 'string',
|
|
23414
|
+
},
|
|
23294
23415
|
},
|
|
23295
23416
|
required: ['acs_entrance_id', 'acs_user_id'],
|
|
23296
23417
|
type: 'object',
|
|
@@ -23330,16 +23451,28 @@ export default {
|
|
|
23330
23451
|
'/acs/entrances/list': {
|
|
23331
23452
|
post: {
|
|
23332
23453
|
description:
|
|
23333
|
-
'Returns a list of all [
|
|
23454
|
+
'Returns a list of all [access system entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
23334
23455
|
operationId: 'acsEntrancesListPost',
|
|
23335
23456
|
requestBody: {
|
|
23336
23457
|
content: {
|
|
23337
23458
|
'application/json': {
|
|
23338
23459
|
schema: {
|
|
23339
23460
|
properties: {
|
|
23340
|
-
acs_credential_id: {
|
|
23341
|
-
|
|
23461
|
+
acs_credential_id: {
|
|
23462
|
+
description:
|
|
23463
|
+
'ID of the credential for which you want to retrieve all entrances.',
|
|
23464
|
+
format: 'uuid',
|
|
23465
|
+
type: 'string',
|
|
23466
|
+
},
|
|
23467
|
+
acs_system_id: {
|
|
23468
|
+
description:
|
|
23469
|
+
'ID of the access system for which you want to retrieve all entrances.',
|
|
23470
|
+
format: 'uuid',
|
|
23471
|
+
type: 'string',
|
|
23472
|
+
},
|
|
23342
23473
|
location_id: {
|
|
23474
|
+
description:
|
|
23475
|
+
'ID of the location for which you want to retrieve all entrances.',
|
|
23343
23476
|
format: 'uuid',
|
|
23344
23477
|
nullable: true,
|
|
23345
23478
|
type: 'string',
|
|
@@ -23398,8 +23531,15 @@ export default {
|
|
|
23398
23531
|
'application/json': {
|
|
23399
23532
|
schema: {
|
|
23400
23533
|
properties: {
|
|
23401
|
-
acs_entrance_id: {
|
|
23534
|
+
acs_entrance_id: {
|
|
23535
|
+
description:
|
|
23536
|
+
'ID of the entrance for which you want to list all credentials that grant access.',
|
|
23537
|
+
format: 'uuid',
|
|
23538
|
+
type: 'string',
|
|
23539
|
+
},
|
|
23402
23540
|
include_if: {
|
|
23541
|
+
description:
|
|
23542
|
+
'Conditions that credentials must meet to be included in the returned list.',
|
|
23403
23543
|
items: {
|
|
23404
23544
|
enum: ['visionline_metadata.is_valid'],
|
|
23405
23545
|
type: 'string',
|
|
@@ -23453,7 +23593,7 @@ export default {
|
|
|
23453
23593
|
'/acs/systems/get': {
|
|
23454
23594
|
post: {
|
|
23455
23595
|
description:
|
|
23456
|
-
'Returns a specified [access
|
|
23596
|
+
'Returns a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).',
|
|
23457
23597
|
operationId: 'acsSystemsGetPost',
|
|
23458
23598
|
requestBody: {
|
|
23459
23599
|
content: {
|
|
@@ -23461,7 +23601,8 @@ export default {
|
|
|
23461
23601
|
schema: {
|
|
23462
23602
|
properties: {
|
|
23463
23603
|
acs_system_id: {
|
|
23464
|
-
description:
|
|
23604
|
+
description:
|
|
23605
|
+
'ID of the access system that you want to get.',
|
|
23465
23606
|
format: 'uuid',
|
|
23466
23607
|
type: 'string',
|
|
23467
23608
|
},
|
|
@@ -23508,7 +23649,7 @@ export default {
|
|
|
23508
23649
|
'/acs/systems/list': {
|
|
23509
23650
|
post: {
|
|
23510
23651
|
description:
|
|
23511
|
-
'Returns a list of all [access
|
|
23652
|
+
'Returns a list of all [access systems](https://docs.seam.co/latest/capability-guides/access-systems).\n\nTo filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.',
|
|
23512
23653
|
operationId: 'acsSystemsListPost',
|
|
23513
23654
|
requestBody: {
|
|
23514
23655
|
content: {
|
|
@@ -23517,7 +23658,7 @@ export default {
|
|
|
23517
23658
|
properties: {
|
|
23518
23659
|
connected_account_id: {
|
|
23519
23660
|
description:
|
|
23520
|
-
'ID of the connected account by which to filter the list of
|
|
23661
|
+
'ID of the connected account by which you want to filter the list of access systems.',
|
|
23521
23662
|
format: 'uuid',
|
|
23522
23663
|
type: 'string',
|
|
23523
23664
|
},
|
|
@@ -23567,7 +23708,7 @@ export default {
|
|
|
23567
23708
|
'/acs/systems/list_compatible_credential_manager_acs_systems': {
|
|
23568
23709
|
post: {
|
|
23569
23710
|
description:
|
|
23570
|
-
'Returns a list of all credential manager
|
|
23711
|
+
'Returns a list of all credential manager systems that are compatible with a specified [access system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nSpecify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.',
|
|
23571
23712
|
operationId: 'acsSystemsListCompatibleCredentialManagerAcsSystemsPost',
|
|
23572
23713
|
requestBody: {
|
|
23573
23714
|
content: {
|
|
@@ -23576,7 +23717,7 @@ export default {
|
|
|
23576
23717
|
properties: {
|
|
23577
23718
|
acs_system_id: {
|
|
23578
23719
|
description:
|
|
23579
|
-
'ID of the
|
|
23720
|
+
'ID of the access system for which you want to retrieve all compatible credential manager systems.',
|
|
23580
23721
|
format: 'uuid',
|
|
23581
23722
|
type: 'string',
|
|
23582
23723
|
},
|
|
@@ -23627,7 +23768,7 @@ export default {
|
|
|
23627
23768
|
'/acs/users/add_to_access_group': {
|
|
23628
23769
|
post: {
|
|
23629
23770
|
description:
|
|
23630
|
-
'Adds a specified [
|
|
23771
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
23631
23772
|
operationId: 'acsUsersAddToAccessGroupPost',
|
|
23632
23773
|
requestBody: {
|
|
23633
23774
|
content: {
|
|
@@ -23635,12 +23776,14 @@ export default {
|
|
|
23635
23776
|
schema: {
|
|
23636
23777
|
properties: {
|
|
23637
23778
|
acs_access_group_id: {
|
|
23638
|
-
description:
|
|
23779
|
+
description:
|
|
23780
|
+
'ID of the access group to which you want to add an access system user.',
|
|
23639
23781
|
format: 'uuid',
|
|
23640
23782
|
type: 'string',
|
|
23641
23783
|
},
|
|
23642
23784
|
acs_user_id: {
|
|
23643
|
-
description:
|
|
23785
|
+
description:
|
|
23786
|
+
'ID of the access system user that you want to add to an access group.',
|
|
23644
23787
|
format: 'uuid',
|
|
23645
23788
|
type: 'string',
|
|
23646
23789
|
},
|
|
@@ -23681,7 +23824,7 @@ export default {
|
|
|
23681
23824
|
},
|
|
23682
23825
|
put: {
|
|
23683
23826
|
description:
|
|
23684
|
-
'Adds a specified [
|
|
23827
|
+
'Adds a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
23685
23828
|
operationId: 'acsUsersAddToAccessGroupPut',
|
|
23686
23829
|
requestBody: {
|
|
23687
23830
|
content: {
|
|
@@ -23689,12 +23832,14 @@ export default {
|
|
|
23689
23832
|
schema: {
|
|
23690
23833
|
properties: {
|
|
23691
23834
|
acs_access_group_id: {
|
|
23692
|
-
description:
|
|
23835
|
+
description:
|
|
23836
|
+
'ID of the access group to which you want to add an access system user.',
|
|
23693
23837
|
format: 'uuid',
|
|
23694
23838
|
type: 'string',
|
|
23695
23839
|
},
|
|
23696
23840
|
acs_user_id: {
|
|
23697
|
-
description:
|
|
23841
|
+
description:
|
|
23842
|
+
'ID of the access system user that you want to add to an access group.',
|
|
23698
23843
|
format: 'uuid',
|
|
23699
23844
|
type: 'string',
|
|
23700
23845
|
},
|
|
@@ -23736,7 +23881,7 @@ export default {
|
|
|
23736
23881
|
'/acs/users/create': {
|
|
23737
23882
|
post: {
|
|
23738
23883
|
description:
|
|
23739
|
-
'Creates a new [
|
|
23884
|
+
'Creates a new [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
23740
23885
|
operationId: 'acsUsersCreatePost',
|
|
23741
23886
|
requestBody: {
|
|
23742
23887
|
content: {
|
|
@@ -23745,27 +23890,34 @@ export default {
|
|
|
23745
23890
|
properties: {
|
|
23746
23891
|
access_schedule: {
|
|
23747
23892
|
description:
|
|
23748
|
-
"`starts_at` and `ends_at` timestamps for the new
|
|
23893
|
+
"`starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
|
|
23749
23894
|
properties: {
|
|
23750
23895
|
ends_at: {
|
|
23896
|
+
description:
|
|
23897
|
+
"Ending timestamp for the new access system user's access.",
|
|
23751
23898
|
format: 'date-time',
|
|
23752
23899
|
nullable: true,
|
|
23753
23900
|
type: 'string',
|
|
23754
23901
|
},
|
|
23755
|
-
starts_at: {
|
|
23902
|
+
starts_at: {
|
|
23903
|
+
description:
|
|
23904
|
+
"Starting timestamp for the new access system user's access.",
|
|
23905
|
+
format: 'date-time',
|
|
23906
|
+
type: 'string',
|
|
23907
|
+
},
|
|
23756
23908
|
},
|
|
23757
23909
|
type: 'object',
|
|
23758
23910
|
},
|
|
23759
23911
|
acs_access_group_ids: {
|
|
23760
23912
|
default: [],
|
|
23761
23913
|
description:
|
|
23762
|
-
'Array of
|
|
23914
|
+
'Array of access group IDs to indicate the access groups to which you want to add the new access system user.',
|
|
23763
23915
|
items: { format: 'uuid', type: 'string' },
|
|
23764
23916
|
type: 'array',
|
|
23765
23917
|
},
|
|
23766
23918
|
acs_system_id: {
|
|
23767
23919
|
description:
|
|
23768
|
-
'ID of the
|
|
23920
|
+
'ID of the access system to which you want to add the new access system user.',
|
|
23769
23921
|
format: 'uuid',
|
|
23770
23922
|
type: 'string',
|
|
23771
23923
|
},
|
|
@@ -23782,7 +23934,7 @@ export default {
|
|
|
23782
23934
|
type: 'string',
|
|
23783
23935
|
},
|
|
23784
23936
|
full_name: {
|
|
23785
|
-
description: 'Full name of the new
|
|
23937
|
+
description: 'Full name of the new access system user.',
|
|
23786
23938
|
type: 'string',
|
|
23787
23939
|
},
|
|
23788
23940
|
phone_number: {
|
|
@@ -23792,7 +23944,7 @@ export default {
|
|
|
23792
23944
|
},
|
|
23793
23945
|
user_identity_id: {
|
|
23794
23946
|
description:
|
|
23795
|
-
'ID of the user identity with which to associate the new
|
|
23947
|
+
'ID of the user identity with which you want to associate the new access system user.',
|
|
23796
23948
|
format: 'uuid',
|
|
23797
23949
|
type: 'string',
|
|
23798
23950
|
},
|
|
@@ -23839,7 +23991,7 @@ export default {
|
|
|
23839
23991
|
'/acs/users/delete': {
|
|
23840
23992
|
post: {
|
|
23841
23993
|
description:
|
|
23842
|
-
"Deletes a specified [
|
|
23994
|
+
"Deletes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) and invalidates the access system user's [credentials](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
|
|
23843
23995
|
operationId: 'acsUsersDeletePost',
|
|
23844
23996
|
requestBody: {
|
|
23845
23997
|
content: {
|
|
@@ -23847,7 +23999,8 @@ export default {
|
|
|
23847
23999
|
schema: {
|
|
23848
24000
|
properties: {
|
|
23849
24001
|
acs_user_id: {
|
|
23850
|
-
description:
|
|
24002
|
+
description:
|
|
24003
|
+
'ID of the access system user that you want to delete.',
|
|
23851
24004
|
format: 'uuid',
|
|
23852
24005
|
type: 'string',
|
|
23853
24006
|
},
|
|
@@ -23890,7 +24043,7 @@ export default {
|
|
|
23890
24043
|
'/acs/users/get': {
|
|
23891
24044
|
post: {
|
|
23892
24045
|
description:
|
|
23893
|
-
'Returns a specified [
|
|
24046
|
+
'Returns a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
23894
24047
|
operationId: 'acsUsersGetPost',
|
|
23895
24048
|
requestBody: {
|
|
23896
24049
|
content: {
|
|
@@ -23898,7 +24051,8 @@ export default {
|
|
|
23898
24051
|
schema: {
|
|
23899
24052
|
properties: {
|
|
23900
24053
|
acs_user_id: {
|
|
23901
|
-
description:
|
|
24054
|
+
description:
|
|
24055
|
+
'ID of the access system user that you want to get.',
|
|
23902
24056
|
format: 'uuid',
|
|
23903
24057
|
type: 'string',
|
|
23904
24058
|
},
|
|
@@ -23945,7 +24099,7 @@ export default {
|
|
|
23945
24099
|
'/acs/users/list': {
|
|
23946
24100
|
post: {
|
|
23947
24101
|
description:
|
|
23948
|
-
'Returns a list of all [
|
|
24102
|
+
'Returns a list of all [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
23949
24103
|
operationId: 'acsUsersListPost',
|
|
23950
24104
|
requestBody: {
|
|
23951
24105
|
content: {
|
|
@@ -23954,11 +24108,16 @@ export default {
|
|
|
23954
24108
|
properties: {
|
|
23955
24109
|
acs_system_id: {
|
|
23956
24110
|
description:
|
|
23957
|
-
'ID of the `acs_system` for which you want to retrieve all
|
|
24111
|
+
'ID of the `acs_system` for which you want to retrieve all access system users.',
|
|
23958
24112
|
format: 'uuid',
|
|
23959
24113
|
type: 'string',
|
|
23960
24114
|
},
|
|
23961
|
-
created_before: {
|
|
24115
|
+
created_before: {
|
|
24116
|
+
description:
|
|
24117
|
+
'Timestamp by which to limit returned access system users. Returns users created before this timestamp.',
|
|
24118
|
+
format: 'date-time',
|
|
24119
|
+
type: 'string',
|
|
24120
|
+
},
|
|
23962
24121
|
limit: {
|
|
23963
24122
|
default: 500,
|
|
23964
24123
|
description:
|
|
@@ -23975,24 +24134,24 @@ export default {
|
|
|
23975
24134
|
},
|
|
23976
24135
|
search: {
|
|
23977
24136
|
description:
|
|
23978
|
-
'String for which to search. Filters returned
|
|
24137
|
+
'String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`.',
|
|
23979
24138
|
minLength: 1,
|
|
23980
24139
|
type: 'string',
|
|
23981
24140
|
},
|
|
23982
24141
|
user_identity_email_address: {
|
|
23983
24142
|
description:
|
|
23984
|
-
'Email address of the user identity for which you want to retrieve all
|
|
24143
|
+
'Email address of the user identity for which you want to retrieve all access system users.',
|
|
23985
24144
|
type: 'string',
|
|
23986
24145
|
},
|
|
23987
24146
|
user_identity_id: {
|
|
23988
24147
|
description:
|
|
23989
|
-
'ID of the user identity for which you want to retrieve all
|
|
24148
|
+
'ID of the user identity for which you want to retrieve all access system users.',
|
|
23990
24149
|
format: 'uuid',
|
|
23991
24150
|
type: 'string',
|
|
23992
24151
|
},
|
|
23993
24152
|
user_identity_phone_number: {
|
|
23994
24153
|
description:
|
|
23995
|
-
'Phone number of the user identity for which you want to retrieve all
|
|
24154
|
+
'Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`).',
|
|
23996
24155
|
type: 'string',
|
|
23997
24156
|
},
|
|
23998
24157
|
},
|
|
@@ -24042,7 +24201,7 @@ export default {
|
|
|
24042
24201
|
'/acs/users/list_accessible_entrances': {
|
|
24043
24202
|
post: {
|
|
24044
24203
|
description:
|
|
24045
|
-
'Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [
|
|
24204
|
+
'Lists the [entrances](https://docs.seam.co/latest/api/acs/entrances) to which a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) has access.',
|
|
24046
24205
|
operationId: 'acsUsersListAccessibleEntrancesPost',
|
|
24047
24206
|
requestBody: {
|
|
24048
24207
|
content: {
|
|
@@ -24050,7 +24209,8 @@ export default {
|
|
|
24050
24209
|
schema: {
|
|
24051
24210
|
properties: {
|
|
24052
24211
|
acs_user_id: {
|
|
24053
|
-
description:
|
|
24212
|
+
description:
|
|
24213
|
+
'ID of the access system user for whom you want to list accessible entrances.',
|
|
24054
24214
|
format: 'uuid',
|
|
24055
24215
|
type: 'string',
|
|
24056
24216
|
},
|
|
@@ -24101,7 +24261,7 @@ export default {
|
|
|
24101
24261
|
'/acs/users/remove_from_access_group': {
|
|
24102
24262
|
post: {
|
|
24103
24263
|
description:
|
|
24104
|
-
'Removes a specified [
|
|
24264
|
+
'Removes a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) from a specified [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups).',
|
|
24105
24265
|
operationId: 'acsUsersRemoveFromAccessGroupPost',
|
|
24106
24266
|
requestBody: {
|
|
24107
24267
|
content: {
|
|
@@ -24109,12 +24269,14 @@ export default {
|
|
|
24109
24269
|
schema: {
|
|
24110
24270
|
properties: {
|
|
24111
24271
|
acs_access_group_id: {
|
|
24112
|
-
description:
|
|
24272
|
+
description:
|
|
24273
|
+
'ID of the access group from which you want to remove an access system user.',
|
|
24113
24274
|
format: 'uuid',
|
|
24114
24275
|
type: 'string',
|
|
24115
24276
|
},
|
|
24116
24277
|
acs_user_id: {
|
|
24117
|
-
description:
|
|
24278
|
+
description:
|
|
24279
|
+
'ID of the access system user that you want to remove from an access group.',
|
|
24118
24280
|
format: 'uuid',
|
|
24119
24281
|
type: 'string',
|
|
24120
24282
|
},
|
|
@@ -24157,7 +24319,7 @@ export default {
|
|
|
24157
24319
|
'/acs/users/revoke_access_to_all_entrances': {
|
|
24158
24320
|
post: {
|
|
24159
24321
|
description:
|
|
24160
|
-
'Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [
|
|
24322
|
+
'Revokes access to all [entrances](https://docs.seam.co/latest/api/acs/entrances) for a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24161
24323
|
operationId: 'acsUsersRevokeAccessToAllEntrancesPost',
|
|
24162
24324
|
requestBody: {
|
|
24163
24325
|
content: {
|
|
@@ -24165,7 +24327,8 @@ export default {
|
|
|
24165
24327
|
schema: {
|
|
24166
24328
|
properties: {
|
|
24167
24329
|
acs_user_id: {
|
|
24168
|
-
description:
|
|
24330
|
+
description:
|
|
24331
|
+
'ID of the access system user for whom you want to revoke access.',
|
|
24169
24332
|
format: 'uuid',
|
|
24170
24333
|
type: 'string',
|
|
24171
24334
|
},
|
|
@@ -24208,7 +24371,7 @@ export default {
|
|
|
24208
24371
|
'/acs/users/suspend': {
|
|
24209
24372
|
post: {
|
|
24210
24373
|
description:
|
|
24211
|
-
"[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [
|
|
24374
|
+
"[Suspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://docs.seam.co/latest/api/acs/users/unsuspend) them.",
|
|
24212
24375
|
operationId: 'acsUsersSuspendPost',
|
|
24213
24376
|
requestBody: {
|
|
24214
24377
|
content: {
|
|
@@ -24216,7 +24379,8 @@ export default {
|
|
|
24216
24379
|
schema: {
|
|
24217
24380
|
properties: {
|
|
24218
24381
|
acs_user_id: {
|
|
24219
|
-
description:
|
|
24382
|
+
description:
|
|
24383
|
+
'ID of the access system user that you want to suspend.',
|
|
24220
24384
|
format: 'uuid',
|
|
24221
24385
|
type: 'string',
|
|
24222
24386
|
},
|
|
@@ -24258,12 +24422,21 @@ export default {
|
|
|
24258
24422
|
},
|
|
24259
24423
|
'/acs/users/unmanaged/get': {
|
|
24260
24424
|
post: {
|
|
24425
|
+
description:
|
|
24426
|
+
'Returns a specified unmanaged [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24261
24427
|
operationId: 'acsUsersUnmanagedGetPost',
|
|
24262
24428
|
requestBody: {
|
|
24263
24429
|
content: {
|
|
24264
24430
|
'application/json': {
|
|
24265
24431
|
schema: {
|
|
24266
|
-
properties: {
|
|
24432
|
+
properties: {
|
|
24433
|
+
acs_user_id: {
|
|
24434
|
+
description:
|
|
24435
|
+
'ID of the unmanaged access system user that you want to get.',
|
|
24436
|
+
format: 'uuid',
|
|
24437
|
+
type: 'string',
|
|
24438
|
+
},
|
|
24439
|
+
},
|
|
24267
24440
|
required: ['acs_user_id'],
|
|
24268
24441
|
type: 'object',
|
|
24269
24442
|
},
|
|
@@ -24302,22 +24475,49 @@ export default {
|
|
|
24302
24475
|
'x-fern-sdk-method-name': 'get',
|
|
24303
24476
|
'x-fern-sdk-return-value': 'acs_user',
|
|
24304
24477
|
'x-response-key': 'acs_user',
|
|
24478
|
+
'x-title': 'Get an Unmanaged ACS User',
|
|
24305
24479
|
'x-undocumented': 'No unmanaged users are currently implemented.',
|
|
24306
24480
|
},
|
|
24307
24481
|
},
|
|
24308
24482
|
'/acs/users/unmanaged/list': {
|
|
24309
24483
|
post: {
|
|
24484
|
+
description:
|
|
24485
|
+
'Returns a list of all unmanaged [access system users](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24310
24486
|
operationId: 'acsUsersUnmanagedListPost',
|
|
24311
24487
|
requestBody: {
|
|
24312
24488
|
content: {
|
|
24313
24489
|
'application/json': {
|
|
24314
24490
|
schema: {
|
|
24315
24491
|
properties: {
|
|
24316
|
-
acs_system_id: {
|
|
24317
|
-
|
|
24318
|
-
|
|
24319
|
-
|
|
24320
|
-
|
|
24492
|
+
acs_system_id: {
|
|
24493
|
+
description:
|
|
24494
|
+
'ID of the access system for which you want to retrieve all unmanaged access system users.',
|
|
24495
|
+
format: 'uuid',
|
|
24496
|
+
type: 'string',
|
|
24497
|
+
},
|
|
24498
|
+
limit: {
|
|
24499
|
+
default: 500,
|
|
24500
|
+
description:
|
|
24501
|
+
'Number of unmanaged access system users to return.',
|
|
24502
|
+
format: 'float',
|
|
24503
|
+
type: 'number',
|
|
24504
|
+
},
|
|
24505
|
+
user_identity_email_address: {
|
|
24506
|
+
description:
|
|
24507
|
+
'Email address of the user identity for which you want to retrieve all unmanaged access system users.',
|
|
24508
|
+
type: 'string',
|
|
24509
|
+
},
|
|
24510
|
+
user_identity_id: {
|
|
24511
|
+
description:
|
|
24512
|
+
'ID of the user identity for which you want to retrieve all unmanaged access system users.',
|
|
24513
|
+
format: 'uuid',
|
|
24514
|
+
type: 'string',
|
|
24515
|
+
},
|
|
24516
|
+
user_identity_phone_number: {
|
|
24517
|
+
description:
|
|
24518
|
+
'Phone number of the user identity for which you want to retrieve all unmanaged access system users.',
|
|
24519
|
+
type: 'string',
|
|
24520
|
+
},
|
|
24321
24521
|
},
|
|
24322
24522
|
type: 'object',
|
|
24323
24523
|
},
|
|
@@ -24359,13 +24559,14 @@ export default {
|
|
|
24359
24559
|
'x-fern-sdk-method-name': 'list',
|
|
24360
24560
|
'x-fern-sdk-return-value': 'acs_users',
|
|
24361
24561
|
'x-response-key': 'acs_users',
|
|
24562
|
+
'x-title': 'List Unmanaged ACS Users',
|
|
24362
24563
|
'x-undocumented': 'No unmanaged users are currently implemented.',
|
|
24363
24564
|
},
|
|
24364
24565
|
},
|
|
24365
24566
|
'/acs/users/unsuspend': {
|
|
24366
24567
|
post: {
|
|
24367
24568
|
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 [
|
|
24569
|
+
'[Unsuspends](https://docs.seam.co/latest/capability-guides/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). While [suspending an access system user](https://docs.seam.co/latest/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.',
|
|
24369
24570
|
operationId: 'acsUsersUnsuspendPost',
|
|
24370
24571
|
requestBody: {
|
|
24371
24572
|
content: {
|
|
@@ -24373,7 +24574,8 @@ export default {
|
|
|
24373
24574
|
schema: {
|
|
24374
24575
|
properties: {
|
|
24375
24576
|
acs_user_id: {
|
|
24376
|
-
description:
|
|
24577
|
+
description:
|
|
24578
|
+
'ID of the access system user that you want to unsuspend.',
|
|
24377
24579
|
format: 'uuid',
|
|
24378
24580
|
type: 'string',
|
|
24379
24581
|
},
|
|
@@ -24416,7 +24618,7 @@ export default {
|
|
|
24416
24618
|
'/acs/users/update': {
|
|
24417
24619
|
patch: {
|
|
24418
24620
|
description:
|
|
24419
|
-
'Updates the properties of a specified [
|
|
24621
|
+
'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24420
24622
|
operationId: 'acsUsersUpdatePatch',
|
|
24421
24623
|
requestBody: {
|
|
24422
24624
|
content: {
|
|
@@ -24425,11 +24627,21 @@ export default {
|
|
|
24425
24627
|
properties: {
|
|
24426
24628
|
access_schedule: {
|
|
24427
24629
|
description:
|
|
24428
|
-
"`starts_at` and `ends_at` timestamps for the
|
|
24630
|
+
"`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
|
|
24429
24631
|
nullable: true,
|
|
24430
24632
|
properties: {
|
|
24431
|
-
ends_at: {
|
|
24432
|
-
|
|
24633
|
+
ends_at: {
|
|
24634
|
+
description:
|
|
24635
|
+
"Ending timestamp for the access system user's access.",
|
|
24636
|
+
format: 'date-time',
|
|
24637
|
+
type: 'string',
|
|
24638
|
+
},
|
|
24639
|
+
starts_at: {
|
|
24640
|
+
description:
|
|
24641
|
+
"Starting timestamp for the access system user's access.",
|
|
24642
|
+
format: 'date-time',
|
|
24643
|
+
type: 'string',
|
|
24644
|
+
},
|
|
24433
24645
|
},
|
|
24434
24646
|
required: ['starts_at', 'ends_at'],
|
|
24435
24647
|
type: 'object',
|
|
@@ -24500,7 +24712,7 @@ export default {
|
|
|
24500
24712
|
},
|
|
24501
24713
|
post: {
|
|
24502
24714
|
description:
|
|
24503
|
-
'Updates the properties of a specified [
|
|
24715
|
+
'Updates the properties of a specified [access system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
24504
24716
|
operationId: 'acsUsersUpdatePost',
|
|
24505
24717
|
requestBody: {
|
|
24506
24718
|
content: {
|
|
@@ -24509,11 +24721,21 @@ export default {
|
|
|
24509
24721
|
properties: {
|
|
24510
24722
|
access_schedule: {
|
|
24511
24723
|
description:
|
|
24512
|
-
"`starts_at` and `ends_at` timestamps for the
|
|
24724
|
+
"`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.",
|
|
24513
24725
|
nullable: true,
|
|
24514
24726
|
properties: {
|
|
24515
|
-
ends_at: {
|
|
24516
|
-
|
|
24727
|
+
ends_at: {
|
|
24728
|
+
description:
|
|
24729
|
+
"Ending timestamp for the access system user's access.",
|
|
24730
|
+
format: 'date-time',
|
|
24731
|
+
type: 'string',
|
|
24732
|
+
},
|
|
24733
|
+
starts_at: {
|
|
24734
|
+
description:
|
|
24735
|
+
"Starting timestamp for the access system user's access.",
|
|
24736
|
+
format: 'date-time',
|
|
24737
|
+
type: 'string',
|
|
24738
|
+
},
|
|
24517
24739
|
},
|
|
24518
24740
|
required: ['starts_at', 'ends_at'],
|
|
24519
24741
|
type: 'object',
|
|
@@ -24586,13 +24808,20 @@ export default {
|
|
|
24586
24808
|
},
|
|
24587
24809
|
'/action_attempts/get': {
|
|
24588
24810
|
post: {
|
|
24811
|
+
description:
|
|
24812
|
+
'Returns a specified [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts).',
|
|
24589
24813
|
operationId: 'actionAttemptsGetPost',
|
|
24590
24814
|
requestBody: {
|
|
24591
24815
|
content: {
|
|
24592
24816
|
'application/json': {
|
|
24593
24817
|
schema: {
|
|
24594
24818
|
properties: {
|
|
24595
|
-
action_attempt_id: {
|
|
24819
|
+
action_attempt_id: {
|
|
24820
|
+
description:
|
|
24821
|
+
'ID of the action attempt that you want to get.',
|
|
24822
|
+
format: 'uuid',
|
|
24823
|
+
type: 'string',
|
|
24824
|
+
},
|
|
24596
24825
|
},
|
|
24597
24826
|
required: ['action_attempt_id'],
|
|
24598
24827
|
type: 'object',
|
|
@@ -24633,10 +24862,13 @@ export default {
|
|
|
24633
24862
|
'x-fern-sdk-method-name': 'get',
|
|
24634
24863
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
24635
24864
|
'x-response-key': 'action_attempt',
|
|
24865
|
+
'x-title': 'Get an Action Attempt',
|
|
24636
24866
|
},
|
|
24637
24867
|
},
|
|
24638
24868
|
'/action_attempts/list': {
|
|
24639
24869
|
post: {
|
|
24870
|
+
description:
|
|
24871
|
+
'Returns a list of the [action attempts](https://docs.seam.co/latest/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.',
|
|
24640
24872
|
operationId: 'actionAttemptsListPost',
|
|
24641
24873
|
requestBody: {
|
|
24642
24874
|
content: {
|
|
@@ -24644,6 +24876,8 @@ export default {
|
|
|
24644
24876
|
schema: {
|
|
24645
24877
|
properties: {
|
|
24646
24878
|
action_attempt_ids: {
|
|
24879
|
+
description:
|
|
24880
|
+
'IDs of the action attempts that you want to retrieve.',
|
|
24647
24881
|
items: { format: 'uuid', type: 'string' },
|
|
24648
24882
|
type: 'array',
|
|
24649
24883
|
},
|
|
@@ -24687,16 +24921,25 @@ export default {
|
|
|
24687
24921
|
'x-fern-sdk-method-name': 'list',
|
|
24688
24922
|
'x-fern-sdk-return-value': 'action_attempts',
|
|
24689
24923
|
'x-response-key': 'action_attempts',
|
|
24924
|
+
'x-title': 'List Action Attempts',
|
|
24690
24925
|
},
|
|
24691
24926
|
},
|
|
24692
24927
|
'/bridges/get': {
|
|
24693
24928
|
post: {
|
|
24929
|
+
description:
|
|
24930
|
+
'Returns a specified [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge).',
|
|
24694
24931
|
operationId: 'bridgesGetPost',
|
|
24695
24932
|
requestBody: {
|
|
24696
24933
|
content: {
|
|
24697
24934
|
'application/json': {
|
|
24698
24935
|
schema: {
|
|
24699
|
-
properties: {
|
|
24936
|
+
properties: {
|
|
24937
|
+
bridge_id: {
|
|
24938
|
+
description: 'ID of the Seam Bridge that you want to get.',
|
|
24939
|
+
format: 'uuid',
|
|
24940
|
+
type: 'string',
|
|
24941
|
+
},
|
|
24942
|
+
},
|
|
24700
24943
|
required: ['bridge_id'],
|
|
24701
24944
|
type: 'object',
|
|
24702
24945
|
},
|
|
@@ -24743,10 +24986,14 @@ export default {
|
|
|
24743
24986
|
'x-fern-sdk-method-name': 'get',
|
|
24744
24987
|
'x-fern-sdk-return-value': 'bridge',
|
|
24745
24988
|
'x-response-key': 'bridge',
|
|
24989
|
+
'x-title': 'Get a Seam Bridge',
|
|
24990
|
+
'x-undocumented': 'Not yet for customer use.',
|
|
24746
24991
|
},
|
|
24747
24992
|
},
|
|
24748
24993
|
'/bridges/list': {
|
|
24749
24994
|
post: {
|
|
24995
|
+
description:
|
|
24996
|
+
'Returns a list of all [Seam Bridges](https://docs.seam.co/latest/capability-guides/seam-bridge).',
|
|
24750
24997
|
operationId: 'bridgesListPost',
|
|
24751
24998
|
requestBody: {
|
|
24752
24999
|
content: {
|
|
@@ -24796,10 +25043,14 @@ export default {
|
|
|
24796
25043
|
'x-fern-sdk-method-name': 'list',
|
|
24797
25044
|
'x-fern-sdk-return-value': 'bridges',
|
|
24798
25045
|
'x-response-key': 'bridges',
|
|
25046
|
+
'x-title': 'List Seam Bridges',
|
|
25047
|
+
'x-undocumented': 'Not yet for customer use.',
|
|
24799
25048
|
},
|
|
24800
25049
|
},
|
|
24801
25050
|
'/client_sessions/create': {
|
|
24802
25051
|
post: {
|
|
25052
|
+
description:
|
|
25053
|
+
'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24803
25054
|
operationId: 'clientSessionsCreatePost',
|
|
24804
25055
|
requestBody: {
|
|
24805
25056
|
content: {
|
|
@@ -24807,16 +25058,32 @@ export default {
|
|
|
24807
25058
|
schema: {
|
|
24808
25059
|
properties: {
|
|
24809
25060
|
connect_webview_ids: {
|
|
25061
|
+
description:
|
|
25062
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
|
|
24810
25063
|
items: { type: 'string' },
|
|
24811
25064
|
type: 'array',
|
|
24812
25065
|
},
|
|
24813
25066
|
connected_account_ids: {
|
|
25067
|
+
description:
|
|
25068
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
|
|
24814
25069
|
items: { type: 'string' },
|
|
24815
25070
|
type: 'array',
|
|
24816
25071
|
},
|
|
24817
|
-
expires_at: {
|
|
24818
|
-
|
|
25072
|
+
expires_at: {
|
|
25073
|
+
description:
|
|
25074
|
+
'Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
25075
|
+
format: 'date-time',
|
|
25076
|
+
type: 'string',
|
|
25077
|
+
},
|
|
25078
|
+
user_identifier_key: {
|
|
25079
|
+
description:
|
|
25080
|
+
'Your user ID for the user for whom you want to create a client session.',
|
|
25081
|
+
minLength: 1,
|
|
25082
|
+
type: 'string',
|
|
25083
|
+
},
|
|
24819
25084
|
user_identity_ids: {
|
|
25085
|
+
description:
|
|
25086
|
+
'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
|
|
24820
25087
|
items: { type: 'string' },
|
|
24821
25088
|
type: 'array',
|
|
24822
25089
|
},
|
|
@@ -24859,8 +25126,11 @@ export default {
|
|
|
24859
25126
|
'x-fern-sdk-method-name': 'create',
|
|
24860
25127
|
'x-fern-sdk-return-value': 'client_session',
|
|
24861
25128
|
'x-response-key': 'client_session',
|
|
25129
|
+
'x-title': 'Create a Client Session',
|
|
24862
25130
|
},
|
|
24863
25131
|
put: {
|
|
25132
|
+
description:
|
|
25133
|
+
'Creates a new [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24864
25134
|
operationId: 'clientSessionsCreatePut',
|
|
24865
25135
|
requestBody: {
|
|
24866
25136
|
content: {
|
|
@@ -24868,16 +25138,32 @@ export default {
|
|
|
24868
25138
|
schema: {
|
|
24869
25139
|
properties: {
|
|
24870
25140
|
connect_webview_ids: {
|
|
25141
|
+
description:
|
|
25142
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session.',
|
|
24871
25143
|
items: { type: 'string' },
|
|
24872
25144
|
type: 'array',
|
|
24873
25145
|
},
|
|
24874
25146
|
connected_account_ids: {
|
|
25147
|
+
description:
|
|
25148
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session.',
|
|
24875
25149
|
items: { type: 'string' },
|
|
24876
25150
|
type: 'array',
|
|
24877
25151
|
},
|
|
24878
|
-
expires_at: {
|
|
24879
|
-
|
|
25152
|
+
expires_at: {
|
|
25153
|
+
description:
|
|
25154
|
+
'Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
25155
|
+
format: 'date-time',
|
|
25156
|
+
type: 'string',
|
|
25157
|
+
},
|
|
25158
|
+
user_identifier_key: {
|
|
25159
|
+
description:
|
|
25160
|
+
'Your user ID for the user for whom you want to create a client session.',
|
|
25161
|
+
minLength: 1,
|
|
25162
|
+
type: 'string',
|
|
25163
|
+
},
|
|
24880
25164
|
user_identity_ids: {
|
|
25165
|
+
description:
|
|
25166
|
+
'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.',
|
|
24881
25167
|
items: { type: 'string' },
|
|
24882
25168
|
type: 'array',
|
|
24883
25169
|
},
|
|
@@ -24918,17 +25204,25 @@ export default {
|
|
|
24918
25204
|
tags: ['/client_sessions'],
|
|
24919
25205
|
'x-fern-ignore': true,
|
|
24920
25206
|
'x-response-key': 'client_session',
|
|
25207
|
+
'x-title': 'Create a Client Session',
|
|
24921
25208
|
},
|
|
24922
25209
|
},
|
|
24923
25210
|
'/client_sessions/delete': {
|
|
24924
25211
|
post: {
|
|
25212
|
+
description:
|
|
25213
|
+
'Deletes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24925
25214
|
operationId: 'clientSessionsDeletePost',
|
|
24926
25215
|
requestBody: {
|
|
24927
25216
|
content: {
|
|
24928
25217
|
'application/json': {
|
|
24929
25218
|
schema: {
|
|
24930
25219
|
properties: {
|
|
24931
|
-
client_session_id: {
|
|
25220
|
+
client_session_id: {
|
|
25221
|
+
description:
|
|
25222
|
+
'ID of the client session that you want to delete.',
|
|
25223
|
+
format: 'uuid',
|
|
25224
|
+
type: 'string',
|
|
25225
|
+
},
|
|
24932
25226
|
},
|
|
24933
25227
|
required: ['client_session_id'],
|
|
24934
25228
|
type: 'object',
|
|
@@ -24962,18 +25256,29 @@ export default {
|
|
|
24962
25256
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
24963
25257
|
'x-fern-sdk-method-name': 'delete',
|
|
24964
25258
|
'x-response-key': null,
|
|
25259
|
+
'x-title': 'Delete a Client Session',
|
|
24965
25260
|
},
|
|
24966
25261
|
},
|
|
24967
25262
|
'/client_sessions/get': {
|
|
24968
25263
|
post: {
|
|
25264
|
+
description:
|
|
25265
|
+
'Returns a specified [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
24969
25266
|
operationId: 'clientSessionsGetPost',
|
|
24970
25267
|
requestBody: {
|
|
24971
25268
|
content: {
|
|
24972
25269
|
'application/json': {
|
|
24973
25270
|
schema: {
|
|
24974
25271
|
properties: {
|
|
24975
|
-
client_session_id: {
|
|
24976
|
-
|
|
25272
|
+
client_session_id: {
|
|
25273
|
+
description:
|
|
25274
|
+
'ID of the client session that you want to get.',
|
|
25275
|
+
type: 'string',
|
|
25276
|
+
},
|
|
25277
|
+
user_identifier_key: {
|
|
25278
|
+
description:
|
|
25279
|
+
'User identifier key associated with the client session that you want to get.',
|
|
25280
|
+
type: 'string',
|
|
25281
|
+
},
|
|
24977
25282
|
},
|
|
24978
25283
|
type: 'object',
|
|
24979
25284
|
},
|
|
@@ -25013,10 +25318,13 @@ export default {
|
|
|
25013
25318
|
'x-fern-sdk-method-name': 'get',
|
|
25014
25319
|
'x-fern-sdk-return-value': 'client_session',
|
|
25015
25320
|
'x-response-key': 'client_session',
|
|
25321
|
+
'x-title': 'Get a Client Session',
|
|
25016
25322
|
},
|
|
25017
25323
|
},
|
|
25018
25324
|
'/client_sessions/get_or_create': {
|
|
25019
25325
|
post: {
|
|
25326
|
+
description:
|
|
25327
|
+
'Returns a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.',
|
|
25020
25328
|
operationId: 'clientSessionsGetOrCreatePost',
|
|
25021
25329
|
requestBody: {
|
|
25022
25330
|
content: {
|
|
@@ -25024,16 +25332,32 @@ export default {
|
|
|
25024
25332
|
schema: {
|
|
25025
25333
|
properties: {
|
|
25026
25334
|
connect_webview_ids: {
|
|
25335
|
+
description:
|
|
25336
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).',
|
|
25027
25337
|
items: { type: 'string' },
|
|
25028
25338
|
type: 'array',
|
|
25029
25339
|
},
|
|
25030
25340
|
connected_account_ids: {
|
|
25341
|
+
description:
|
|
25342
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session).',
|
|
25031
25343
|
items: { type: 'string' },
|
|
25032
25344
|
type: 'array',
|
|
25033
25345
|
},
|
|
25034
|
-
expires_at: {
|
|
25035
|
-
|
|
25346
|
+
expires_at: {
|
|
25347
|
+
description:
|
|
25348
|
+
'Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
25349
|
+
format: 'date-time',
|
|
25350
|
+
type: 'string',
|
|
25351
|
+
},
|
|
25352
|
+
user_identifier_key: {
|
|
25353
|
+
description:
|
|
25354
|
+
'Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session).',
|
|
25355
|
+
minLength: 1,
|
|
25356
|
+
type: 'string',
|
|
25357
|
+
},
|
|
25036
25358
|
user_identity_ids: {
|
|
25359
|
+
description:
|
|
25360
|
+
'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).',
|
|
25037
25361
|
items: { type: 'string' },
|
|
25038
25362
|
type: 'array',
|
|
25039
25363
|
},
|
|
@@ -25076,27 +25400,44 @@ export default {
|
|
|
25076
25400
|
'x-fern-sdk-method-name': 'get_or_create',
|
|
25077
25401
|
'x-fern-sdk-return-value': 'client_session',
|
|
25078
25402
|
'x-response-key': 'client_session',
|
|
25403
|
+
'x-title': 'Get or Create a Client Session',
|
|
25079
25404
|
},
|
|
25080
25405
|
},
|
|
25081
25406
|
'/client_sessions/grant_access': {
|
|
25082
25407
|
patch: {
|
|
25408
|
+
description:
|
|
25409
|
+
'Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.',
|
|
25083
25410
|
operationId: 'clientSessionsGrantAccessPatch',
|
|
25084
25411
|
requestBody: {
|
|
25085
25412
|
content: {
|
|
25086
25413
|
'application/json': {
|
|
25087
25414
|
schema: {
|
|
25088
25415
|
properties: {
|
|
25089
|
-
client_session_id: {
|
|
25416
|
+
client_session_id: {
|
|
25417
|
+
description:
|
|
25418
|
+
'ID of the client session to which you want to grant access to resources.',
|
|
25419
|
+
type: 'string',
|
|
25420
|
+
},
|
|
25090
25421
|
connect_webview_ids: {
|
|
25422
|
+
description:
|
|
25423
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
|
|
25091
25424
|
items: { type: 'string' },
|
|
25092
25425
|
type: 'array',
|
|
25093
25426
|
},
|
|
25094
25427
|
connected_account_ids: {
|
|
25428
|
+
description:
|
|
25429
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
|
|
25095
25430
|
items: { type: 'string' },
|
|
25096
25431
|
type: 'array',
|
|
25097
25432
|
},
|
|
25098
|
-
user_identifier_key: {
|
|
25433
|
+
user_identifier_key: {
|
|
25434
|
+
description:
|
|
25435
|
+
'Your user ID for the user that you want to associate with the client session.',
|
|
25436
|
+
type: 'string',
|
|
25437
|
+
},
|
|
25099
25438
|
user_identity_ids: {
|
|
25439
|
+
description:
|
|
25440
|
+
'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25100
25441
|
items: { type: 'string' },
|
|
25101
25442
|
type: 'array',
|
|
25102
25443
|
},
|
|
@@ -25136,25 +25477,42 @@ export default {
|
|
|
25136
25477
|
tags: ['/client_sessions'],
|
|
25137
25478
|
'x-fern-ignore': true,
|
|
25138
25479
|
'x-response-key': null,
|
|
25480
|
+
'x-title': 'Grant Access to a Client Session',
|
|
25139
25481
|
},
|
|
25140
25482
|
post: {
|
|
25483
|
+
description:
|
|
25484
|
+
'Grants a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews), [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.',
|
|
25141
25485
|
operationId: 'clientSessionsGrantAccessPost',
|
|
25142
25486
|
requestBody: {
|
|
25143
25487
|
content: {
|
|
25144
25488
|
'application/json': {
|
|
25145
25489
|
schema: {
|
|
25146
25490
|
properties: {
|
|
25147
|
-
client_session_id: {
|
|
25491
|
+
client_session_id: {
|
|
25492
|
+
description:
|
|
25493
|
+
'ID of the client session to which you want to grant access to resources.',
|
|
25494
|
+
type: 'string',
|
|
25495
|
+
},
|
|
25148
25496
|
connect_webview_ids: {
|
|
25497
|
+
description:
|
|
25498
|
+
'IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session.',
|
|
25149
25499
|
items: { type: 'string' },
|
|
25150
25500
|
type: 'array',
|
|
25151
25501
|
},
|
|
25152
25502
|
connected_account_ids: {
|
|
25503
|
+
description:
|
|
25504
|
+
'IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session.',
|
|
25153
25505
|
items: { type: 'string' },
|
|
25154
25506
|
type: 'array',
|
|
25155
25507
|
},
|
|
25156
|
-
user_identifier_key: {
|
|
25508
|
+
user_identifier_key: {
|
|
25509
|
+
description:
|
|
25510
|
+
'Your user ID for the user that you want to associate with the client session.',
|
|
25511
|
+
type: 'string',
|
|
25512
|
+
},
|
|
25157
25513
|
user_identity_ids: {
|
|
25514
|
+
description:
|
|
25515
|
+
'IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.',
|
|
25158
25516
|
items: { type: 'string' },
|
|
25159
25517
|
type: 'array',
|
|
25160
25518
|
},
|
|
@@ -25195,21 +25553,44 @@ export default {
|
|
|
25195
25553
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
25196
25554
|
'x-fern-sdk-method-name': 'grant_access',
|
|
25197
25555
|
'x-response-key': null,
|
|
25556
|
+
'x-title': 'Grant Access to a Client Session',
|
|
25198
25557
|
},
|
|
25199
25558
|
},
|
|
25200
25559
|
'/client_sessions/list': {
|
|
25201
25560
|
post: {
|
|
25561
|
+
description:
|
|
25562
|
+
'Returns a list of all [client sessions](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).',
|
|
25202
25563
|
operationId: 'clientSessionsListPost',
|
|
25203
25564
|
requestBody: {
|
|
25204
25565
|
content: {
|
|
25205
25566
|
'application/json': {
|
|
25206
25567
|
schema: {
|
|
25207
25568
|
properties: {
|
|
25208
|
-
client_session_id: {
|
|
25209
|
-
|
|
25210
|
-
|
|
25211
|
-
|
|
25212
|
-
|
|
25569
|
+
client_session_id: {
|
|
25570
|
+
description:
|
|
25571
|
+
'ID of the client session that you want to retrieve.',
|
|
25572
|
+
type: 'string',
|
|
25573
|
+
},
|
|
25574
|
+
connect_webview_id: {
|
|
25575
|
+
description:
|
|
25576
|
+
'ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions.',
|
|
25577
|
+
type: 'string',
|
|
25578
|
+
},
|
|
25579
|
+
user_identifier_key: {
|
|
25580
|
+
description:
|
|
25581
|
+
'Your user ID for the user by which you want to filter client sessions.',
|
|
25582
|
+
type: 'string',
|
|
25583
|
+
},
|
|
25584
|
+
user_identity_id: {
|
|
25585
|
+
description:
|
|
25586
|
+
'ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions.',
|
|
25587
|
+
type: 'string',
|
|
25588
|
+
},
|
|
25589
|
+
without_user_identifier_key: {
|
|
25590
|
+
description:
|
|
25591
|
+
'Indicates whether to retrieve only client sessions without associated user identifier keys.',
|
|
25592
|
+
type: 'boolean',
|
|
25593
|
+
},
|
|
25213
25594
|
},
|
|
25214
25595
|
type: 'object',
|
|
25215
25596
|
},
|
|
@@ -25249,17 +25630,25 @@ export default {
|
|
|
25249
25630
|
'x-fern-sdk-method-name': 'list',
|
|
25250
25631
|
'x-fern-sdk-return-value': 'client_sessions',
|
|
25251
25632
|
'x-response-key': 'client_sessions',
|
|
25633
|
+
'x-title': 'List Client Sessions',
|
|
25252
25634
|
},
|
|
25253
25635
|
},
|
|
25254
25636
|
'/client_sessions/revoke': {
|
|
25255
25637
|
post: {
|
|
25638
|
+
description:
|
|
25639
|
+
'Revokes a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens).\n\nNote that [deleting a client session](https://docs.seam.co/latest/api/client_sessions/delete) is a separate action.',
|
|
25256
25640
|
operationId: 'clientSessionsRevokePost',
|
|
25257
25641
|
requestBody: {
|
|
25258
25642
|
content: {
|
|
25259
25643
|
'application/json': {
|
|
25260
25644
|
schema: {
|
|
25261
25645
|
properties: {
|
|
25262
|
-
client_session_id: {
|
|
25646
|
+
client_session_id: {
|
|
25647
|
+
description:
|
|
25648
|
+
'ID of the client session that you want to revoke.',
|
|
25649
|
+
format: 'uuid',
|
|
25650
|
+
type: 'string',
|
|
25651
|
+
},
|
|
25263
25652
|
},
|
|
25264
25653
|
required: ['client_session_id'],
|
|
25265
25654
|
type: 'object',
|
|
@@ -25293,10 +25682,13 @@ export default {
|
|
|
25293
25682
|
'x-fern-sdk-group-name': ['client_sessions'],
|
|
25294
25683
|
'x-fern-sdk-method-name': 'revoke',
|
|
25295
25684
|
'x-response-key': null,
|
|
25685
|
+
'x-title': 'Revoke a Client Session',
|
|
25296
25686
|
},
|
|
25297
25687
|
},
|
|
25298
25688
|
'/connect_webviews/create': {
|
|
25299
25689
|
post: {
|
|
25690
|
+
description:
|
|
25691
|
+
'Creates a new [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nTo enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.\n\nYou should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.\n\nSee also: [Connect Webview Process](https://docs.seam.co/latest/core-concepts/connect-webviews/connect-webview-process).',
|
|
25300
25692
|
operationId: 'connectWebviewsCreatePost',
|
|
25301
25693
|
requestBody: {
|
|
25302
25694
|
content: {
|
|
@@ -25304,6 +25696,8 @@ export default {
|
|
|
25304
25696
|
schema: {
|
|
25305
25697
|
properties: {
|
|
25306
25698
|
accepted_providers: {
|
|
25699
|
+
description:
|
|
25700
|
+
'Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.',
|
|
25307
25701
|
items: {
|
|
25308
25702
|
enum: [
|
|
25309
25703
|
'dormakaba_community',
|
|
@@ -25363,6 +25757,8 @@ export default {
|
|
|
25363
25757
|
},
|
|
25364
25758
|
automatically_manage_new_devices: {
|
|
25365
25759
|
default: true,
|
|
25760
|
+
description:
|
|
25761
|
+
'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).',
|
|
25366
25762
|
type: 'boolean',
|
|
25367
25763
|
},
|
|
25368
25764
|
custom_metadata: {
|
|
@@ -25373,15 +25769,28 @@ export default {
|
|
|
25373
25769
|
{ type: 'boolean' },
|
|
25374
25770
|
],
|
|
25375
25771
|
},
|
|
25772
|
+
description:
|
|
25773
|
+
'Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).',
|
|
25376
25774
|
type: 'object',
|
|
25377
25775
|
},
|
|
25378
|
-
custom_redirect_failure_url: {
|
|
25379
|
-
|
|
25776
|
+
custom_redirect_failure_url: {
|
|
25777
|
+
description:
|
|
25778
|
+
'Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.',
|
|
25779
|
+
type: 'string',
|
|
25780
|
+
},
|
|
25781
|
+
custom_redirect_url: {
|
|
25782
|
+
description:
|
|
25783
|
+
'URL that you want to redirect the user to after the provider login is complete.',
|
|
25784
|
+
type: 'string',
|
|
25785
|
+
},
|
|
25380
25786
|
device_selection_mode: {
|
|
25381
25787
|
enum: ['none', 'single', 'multiple'],
|
|
25382
25788
|
type: 'string',
|
|
25789
|
+
'x-undocumented': 'Not supported.',
|
|
25383
25790
|
},
|
|
25384
25791
|
provider_category: {
|
|
25792
|
+
description:
|
|
25793
|
+
'Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter.',
|
|
25385
25794
|
enum: [
|
|
25386
25795
|
'stable',
|
|
25387
25796
|
'consumer_smartlocks',
|
|
@@ -25392,7 +25801,12 @@ export default {
|
|
|
25392
25801
|
],
|
|
25393
25802
|
type: 'string',
|
|
25394
25803
|
},
|
|
25395
|
-
wait_for_device_creation: {
|
|
25804
|
+
wait_for_device_creation: {
|
|
25805
|
+
default: false,
|
|
25806
|
+
description:
|
|
25807
|
+
'Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).',
|
|
25808
|
+
type: 'boolean',
|
|
25809
|
+
},
|
|
25396
25810
|
},
|
|
25397
25811
|
type: 'object',
|
|
25398
25812
|
},
|
|
@@ -25432,17 +25846,25 @@ export default {
|
|
|
25432
25846
|
'x-fern-sdk-method-name': 'create',
|
|
25433
25847
|
'x-fern-sdk-return-value': 'connect_webview',
|
|
25434
25848
|
'x-response-key': 'connect_webview',
|
|
25849
|
+
'x-title': 'Create a Connect Webview',
|
|
25435
25850
|
},
|
|
25436
25851
|
},
|
|
25437
25852
|
'/connect_webviews/delete': {
|
|
25438
25853
|
post: {
|
|
25854
|
+
description:
|
|
25855
|
+
'Deletes a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nYou do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.',
|
|
25439
25856
|
operationId: 'connectWebviewsDeletePost',
|
|
25440
25857
|
requestBody: {
|
|
25441
25858
|
content: {
|
|
25442
25859
|
'application/json': {
|
|
25443
25860
|
schema: {
|
|
25444
25861
|
properties: {
|
|
25445
|
-
connect_webview_id: {
|
|
25862
|
+
connect_webview_id: {
|
|
25863
|
+
description:
|
|
25864
|
+
'ID of the Connect Webview that you want to delete.',
|
|
25865
|
+
format: 'uuid',
|
|
25866
|
+
type: 'string',
|
|
25867
|
+
},
|
|
25446
25868
|
},
|
|
25447
25869
|
required: ['connect_webview_id'],
|
|
25448
25870
|
type: 'object',
|
|
@@ -25476,17 +25898,25 @@ export default {
|
|
|
25476
25898
|
'x-fern-sdk-group-name': ['connect_webviews'],
|
|
25477
25899
|
'x-fern-sdk-method-name': 'delete',
|
|
25478
25900
|
'x-response-key': null,
|
|
25901
|
+
'x-title': 'Delete a Connect Webview',
|
|
25479
25902
|
},
|
|
25480
25903
|
},
|
|
25481
25904
|
'/connect_webviews/get': {
|
|
25482
25905
|
post: {
|
|
25906
|
+
description:
|
|
25907
|
+
"Returns a specified [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).\n\nUnless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.",
|
|
25483
25908
|
operationId: 'connectWebviewsGetPost',
|
|
25484
25909
|
requestBody: {
|
|
25485
25910
|
content: {
|
|
25486
25911
|
'application/json': {
|
|
25487
25912
|
schema: {
|
|
25488
25913
|
properties: {
|
|
25489
|
-
connect_webview_id: {
|
|
25914
|
+
connect_webview_id: {
|
|
25915
|
+
description:
|
|
25916
|
+
'ID of the Connect Webview that you want to get.',
|
|
25917
|
+
format: 'uuid',
|
|
25918
|
+
type: 'string',
|
|
25919
|
+
},
|
|
25490
25920
|
},
|
|
25491
25921
|
required: ['connect_webview_id'],
|
|
25492
25922
|
type: 'object',
|
|
@@ -25527,10 +25957,13 @@ export default {
|
|
|
25527
25957
|
'x-fern-sdk-method-name': 'get',
|
|
25528
25958
|
'x-fern-sdk-return-value': 'connect_webview',
|
|
25529
25959
|
'x-response-key': 'connect_webview',
|
|
25960
|
+
'x-title': 'Get a Connect Webview',
|
|
25530
25961
|
},
|
|
25531
25962
|
},
|
|
25532
25963
|
'/connect_webviews/list': {
|
|
25533
25964
|
post: {
|
|
25965
|
+
description:
|
|
25966
|
+
'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
|
|
25534
25967
|
operationId: 'connectWebviewsListPost',
|
|
25535
25968
|
requestBody: {
|
|
25536
25969
|
content: {
|
|
@@ -25542,13 +25975,19 @@ export default {
|
|
|
25542
25975
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
25543
25976
|
},
|
|
25544
25977
|
description:
|
|
25545
|
-
'
|
|
25978
|
+
'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.',
|
|
25546
25979
|
type: 'object',
|
|
25547
25980
|
},
|
|
25548
|
-
limit: {
|
|
25981
|
+
limit: {
|
|
25982
|
+
default: 500,
|
|
25983
|
+
description:
|
|
25984
|
+
'Maximum number of records to return per page.',
|
|
25985
|
+
format: 'float',
|
|
25986
|
+
type: 'number',
|
|
25987
|
+
},
|
|
25549
25988
|
user_identifier_key: {
|
|
25550
25989
|
description:
|
|
25551
|
-
'
|
|
25990
|
+
'Your user ID for the user by which you want to filter Connect Webviews.',
|
|
25552
25991
|
type: 'string',
|
|
25553
25992
|
},
|
|
25554
25993
|
},
|
|
@@ -25591,18 +26030,30 @@ export default {
|
|
|
25591
26030
|
'x-fern-sdk-method-name': 'list',
|
|
25592
26031
|
'x-fern-sdk-return-value': 'connect_webviews',
|
|
25593
26032
|
'x-response-key': 'connect_webviews',
|
|
26033
|
+
'x-title': 'List Connect Webviews',
|
|
25594
26034
|
},
|
|
25595
26035
|
},
|
|
25596
26036
|
'/connected_accounts/delete': {
|
|
25597
26037
|
post: {
|
|
26038
|
+
description:
|
|
26039
|
+
'Deletes a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).\n\nDeleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.\n\nFor example, if you delete a connected account with a device that has an access code, Seam sends a `connected_account.deleted` event, a `device.deleted` event, and an `access_code.deleted` event, but Seam does not remove the access code from the device.',
|
|
25598
26040
|
operationId: 'connectedAccountsDeletePost',
|
|
25599
26041
|
requestBody: {
|
|
25600
26042
|
content: {
|
|
25601
26043
|
'application/json': {
|
|
25602
26044
|
schema: {
|
|
25603
26045
|
properties: {
|
|
25604
|
-
connected_account_id: {
|
|
25605
|
-
|
|
26046
|
+
connected_account_id: {
|
|
26047
|
+
description:
|
|
26048
|
+
'ID of the connected account that you want to delete.',
|
|
26049
|
+
format: 'uuid',
|
|
26050
|
+
type: 'string',
|
|
26051
|
+
},
|
|
26052
|
+
sync: {
|
|
26053
|
+
default: false,
|
|
26054
|
+
type: 'boolean',
|
|
26055
|
+
'x-undocumented': 'Only used internally.',
|
|
26056
|
+
},
|
|
25606
26057
|
},
|
|
25607
26058
|
required: ['connected_account_id'],
|
|
25608
26059
|
type: 'object',
|
|
@@ -25641,6 +26092,8 @@ export default {
|
|
|
25641
26092
|
},
|
|
25642
26093
|
'/connected_accounts/get': {
|
|
25643
26094
|
post: {
|
|
26095
|
+
description:
|
|
26096
|
+
'Returns a specified [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
25644
26097
|
operationId: 'connectedAccountsGetPost',
|
|
25645
26098
|
requestBody: {
|
|
25646
26099
|
content: {
|
|
@@ -25649,13 +26102,25 @@ export default {
|
|
|
25649
26102
|
oneOf: [
|
|
25650
26103
|
{
|
|
25651
26104
|
properties: {
|
|
25652
|
-
connected_account_id: {
|
|
26105
|
+
connected_account_id: {
|
|
26106
|
+
description:
|
|
26107
|
+
'ID of the connected account that you want to get.',
|
|
26108
|
+
format: 'uuid',
|
|
26109
|
+
type: 'string',
|
|
26110
|
+
},
|
|
25653
26111
|
},
|
|
25654
26112
|
required: ['connected_account_id'],
|
|
25655
26113
|
type: 'object',
|
|
25656
26114
|
},
|
|
25657
26115
|
{
|
|
25658
|
-
properties: {
|
|
26116
|
+
properties: {
|
|
26117
|
+
email: {
|
|
26118
|
+
description:
|
|
26119
|
+
'Email address associated with the connected account that you want to get.',
|
|
26120
|
+
format: 'email',
|
|
26121
|
+
type: 'string',
|
|
26122
|
+
},
|
|
26123
|
+
},
|
|
25659
26124
|
required: ['email'],
|
|
25660
26125
|
type: 'object',
|
|
25661
26126
|
},
|
|
@@ -25702,6 +26167,8 @@ export default {
|
|
|
25702
26167
|
},
|
|
25703
26168
|
'/connected_accounts/list': {
|
|
25704
26169
|
post: {
|
|
26170
|
+
description:
|
|
26171
|
+
'Returns a list of all [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
25705
26172
|
operationId: 'connectedAccountsListPost',
|
|
25706
26173
|
requestBody: {
|
|
25707
26174
|
content: {
|
|
@@ -25713,7 +26180,7 @@ export default {
|
|
|
25713
26180
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
25714
26181
|
},
|
|
25715
26182
|
description:
|
|
25716
|
-
'Returns accounts
|
|
26183
|
+
'Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.',
|
|
25717
26184
|
type: 'object',
|
|
25718
26185
|
},
|
|
25719
26186
|
customer_ids: {
|
|
@@ -25736,7 +26203,7 @@ export default {
|
|
|
25736
26203
|
},
|
|
25737
26204
|
user_identifier_key: {
|
|
25738
26205
|
description:
|
|
25739
|
-
'
|
|
26206
|
+
'Your user ID for the user by which you want to filter connected accounts.',
|
|
25740
26207
|
type: 'string',
|
|
25741
26208
|
},
|
|
25742
26209
|
},
|
|
@@ -25784,14 +26251,25 @@ export default {
|
|
|
25784
26251
|
},
|
|
25785
26252
|
'/connected_accounts/update': {
|
|
25786
26253
|
post: {
|
|
26254
|
+
description:
|
|
26255
|
+
'Updates a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
|
|
25787
26256
|
operationId: 'connectedAccountsUpdatePost',
|
|
25788
26257
|
requestBody: {
|
|
25789
26258
|
content: {
|
|
25790
26259
|
'application/json': {
|
|
25791
26260
|
schema: {
|
|
25792
26261
|
properties: {
|
|
25793
|
-
automatically_manage_new_devices: {
|
|
25794
|
-
|
|
26262
|
+
automatically_manage_new_devices: {
|
|
26263
|
+
description:
|
|
26264
|
+
'Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
|
|
26265
|
+
type: 'boolean',
|
|
26266
|
+
},
|
|
26267
|
+
connected_account_id: {
|
|
26268
|
+
description:
|
|
26269
|
+
'ID of the connected account that you want to update.',
|
|
26270
|
+
format: 'uuid',
|
|
26271
|
+
type: 'string',
|
|
26272
|
+
},
|
|
25795
26273
|
custom_metadata: {
|
|
25796
26274
|
additionalProperties: {
|
|
25797
26275
|
nullable: true,
|
|
@@ -25800,6 +26278,8 @@ export default {
|
|
|
25800
26278
|
{ type: 'boolean' },
|
|
25801
26279
|
],
|
|
25802
26280
|
},
|
|
26281
|
+
description:
|
|
26282
|
+
'Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).',
|
|
25803
26283
|
type: 'object',
|
|
25804
26284
|
},
|
|
25805
26285
|
},
|
|
@@ -25845,12 +26325,20 @@ export default {
|
|
|
25845
26325
|
},
|
|
25846
26326
|
'/devices/delete': {
|
|
25847
26327
|
post: {
|
|
26328
|
+
description:
|
|
26329
|
+
'Deletes a specified [device](https://docs.seam.co/latest/core-concepts/devices).',
|
|
25848
26330
|
operationId: 'devicesDeletePost',
|
|
25849
26331
|
requestBody: {
|
|
25850
26332
|
content: {
|
|
25851
26333
|
'application/json': {
|
|
25852
26334
|
schema: {
|
|
25853
|
-
properties: {
|
|
26335
|
+
properties: {
|
|
26336
|
+
device_id: {
|
|
26337
|
+
description: 'ID of the device that you want to delete.',
|
|
26338
|
+
format: 'uuid',
|
|
26339
|
+
type: 'string',
|
|
26340
|
+
},
|
|
26341
|
+
},
|
|
25854
26342
|
required: ['device_id'],
|
|
25855
26343
|
type: 'object',
|
|
25856
26344
|
},
|
|
@@ -25885,20 +26373,30 @@ export default {
|
|
|
25885
26373
|
'x-fern-sdk-group-name': ['devices'],
|
|
25886
26374
|
'x-fern-sdk-method-name': 'delete',
|
|
25887
26375
|
'x-response-key': null,
|
|
26376
|
+
'x-title': 'Delete a Device',
|
|
25888
26377
|
'x-undocumented':
|
|
25889
26378
|
'Deleting a device is no longer supported and will be removed.',
|
|
25890
26379
|
},
|
|
25891
26380
|
},
|
|
25892
26381
|
'/devices/get': {
|
|
25893
26382
|
post: {
|
|
26383
|
+
description:
|
|
26384
|
+
'Returns a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou must specify either `device_id` or `name`.',
|
|
25894
26385
|
operationId: 'devicesGetPost',
|
|
25895
26386
|
requestBody: {
|
|
25896
26387
|
content: {
|
|
25897
26388
|
'application/json': {
|
|
25898
26389
|
schema: {
|
|
25899
26390
|
properties: {
|
|
25900
|
-
device_id: {
|
|
25901
|
-
|
|
26391
|
+
device_id: {
|
|
26392
|
+
description: 'ID of the device that you want to get.',
|
|
26393
|
+
format: 'uuid',
|
|
26394
|
+
type: 'string',
|
|
26395
|
+
},
|
|
26396
|
+
name: {
|
|
26397
|
+
description: 'Name of the device that you want to get.',
|
|
26398
|
+
type: 'string',
|
|
26399
|
+
},
|
|
25902
26400
|
},
|
|
25903
26401
|
type: 'object',
|
|
25904
26402
|
},
|
|
@@ -25936,6 +26434,7 @@ export default {
|
|
|
25936
26434
|
'x-fern-sdk-method-name': 'get',
|
|
25937
26435
|
'x-fern-sdk-return-value': 'device',
|
|
25938
26436
|
'x-response-key': 'device',
|
|
26437
|
+
'x-title': 'Get a Device',
|
|
25939
26438
|
},
|
|
25940
26439
|
},
|
|
25941
26440
|
'/devices/list': {
|
|
@@ -25950,25 +26449,25 @@ export default {
|
|
|
25950
26449
|
properties: {
|
|
25951
26450
|
connect_webview_id: {
|
|
25952
26451
|
description:
|
|
25953
|
-
'ID of the Connect Webview
|
|
26452
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
25954
26453
|
format: 'uuid',
|
|
25955
26454
|
type: 'string',
|
|
25956
26455
|
},
|
|
25957
26456
|
connected_account_id: {
|
|
25958
26457
|
description:
|
|
25959
|
-
'ID of the connected account
|
|
26458
|
+
'ID of the connected account for which you want to list devices.',
|
|
25960
26459
|
format: 'uuid',
|
|
25961
26460
|
type: 'string',
|
|
25962
26461
|
},
|
|
25963
26462
|
connected_account_ids: {
|
|
25964
26463
|
description:
|
|
25965
|
-
'Array of IDs of the connected accounts
|
|
26464
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
25966
26465
|
items: { format: 'uuid', type: 'string' },
|
|
25967
26466
|
type: 'array',
|
|
25968
26467
|
},
|
|
25969
26468
|
created_before: {
|
|
25970
26469
|
description:
|
|
25971
|
-
'
|
|
26470
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
25972
26471
|
format: 'date-time',
|
|
25973
26472
|
type: 'string',
|
|
25974
26473
|
},
|
|
@@ -25977,7 +26476,7 @@ export default {
|
|
|
25977
26476
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
25978
26477
|
},
|
|
25979
26478
|
description:
|
|
25980
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
26479
|
+
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
25981
26480
|
type: 'object',
|
|
25982
26481
|
},
|
|
25983
26482
|
customer_ids: {
|
|
@@ -25986,12 +26485,13 @@ export default {
|
|
|
25986
26485
|
},
|
|
25987
26486
|
device_ids: {
|
|
25988
26487
|
description:
|
|
25989
|
-
'Array of device IDs
|
|
26488
|
+
'Array of device IDs for which you want to list devices.',
|
|
25990
26489
|
items: { format: 'uuid', type: 'string' },
|
|
25991
26490
|
type: 'array',
|
|
25992
26491
|
},
|
|
25993
26492
|
device_type: {
|
|
25994
|
-
description:
|
|
26493
|
+
description:
|
|
26494
|
+
'Device type for which you want to list devices.',
|
|
25995
26495
|
oneOf: [
|
|
25996
26496
|
{
|
|
25997
26497
|
enum: [
|
|
@@ -26049,7 +26549,7 @@ export default {
|
|
|
26049
26549
|
},
|
|
26050
26550
|
device_types: {
|
|
26051
26551
|
description:
|
|
26052
|
-
'Array of device types
|
|
26552
|
+
'Array of device types for which you want to list devices.',
|
|
26053
26553
|
items: {
|
|
26054
26554
|
oneOf: [
|
|
26055
26555
|
{
|
|
@@ -26156,7 +26656,8 @@ export default {
|
|
|
26156
26656
|
type: 'number',
|
|
26157
26657
|
},
|
|
26158
26658
|
manufacturer: {
|
|
26159
|
-
description:
|
|
26659
|
+
description:
|
|
26660
|
+
'Manufacturer for which you want to list devices.',
|
|
26160
26661
|
enum: [
|
|
26161
26662
|
'akuvox',
|
|
26162
26663
|
'august',
|
|
@@ -26206,6 +26707,8 @@ export default {
|
|
|
26206
26707
|
type: 'string',
|
|
26207
26708
|
},
|
|
26208
26709
|
unstable_location_id: {
|
|
26710
|
+
description:
|
|
26711
|
+
'ID of the location for which you want to list devices.',
|
|
26209
26712
|
format: 'uuid',
|
|
26210
26713
|
nullable: true,
|
|
26211
26714
|
type: 'string',
|
|
@@ -26213,7 +26716,7 @@ export default {
|
|
|
26213
26716
|
},
|
|
26214
26717
|
user_identifier_key: {
|
|
26215
26718
|
description:
|
|
26216
|
-
'Your own internal user ID for the user
|
|
26719
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
26217
26720
|
type: 'string',
|
|
26218
26721
|
},
|
|
26219
26722
|
},
|
|
@@ -26262,6 +26765,8 @@ export default {
|
|
|
26262
26765
|
},
|
|
26263
26766
|
'/devices/list_device_providers': {
|
|
26264
26767
|
post: {
|
|
26768
|
+
description:
|
|
26769
|
+
'Returns a list of all device providers.\n\nThe information that this endpoint returns for each provider includes a set of [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.\n\nWhen you create a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).',
|
|
26265
26770
|
operationId: 'devicesListDeviceProvidersPost',
|
|
26266
26771
|
requestBody: {
|
|
26267
26772
|
content: {
|
|
@@ -26269,6 +26774,8 @@ export default {
|
|
|
26269
26774
|
schema: {
|
|
26270
26775
|
properties: {
|
|
26271
26776
|
provider_category: {
|
|
26777
|
+
description:
|
|
26778
|
+
'Category for which you want to list providers.',
|
|
26272
26779
|
enum: [
|
|
26273
26780
|
'stable',
|
|
26274
26781
|
'consumer_smartlocks',
|
|
@@ -26318,16 +26825,26 @@ export default {
|
|
|
26318
26825
|
'x-fern-sdk-method-name': 'list_device_providers',
|
|
26319
26826
|
'x-fern-sdk-return-value': 'device_providers',
|
|
26320
26827
|
'x-response-key': 'device_providers',
|
|
26828
|
+
'x-title': 'List Device Providers',
|
|
26321
26829
|
},
|
|
26322
26830
|
},
|
|
26323
26831
|
'/devices/simulate/connect': {
|
|
26324
26832
|
post: {
|
|
26833
|
+
description:
|
|
26834
|
+
'Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).',
|
|
26325
26835
|
operationId: 'devicesSimulateConnectPost',
|
|
26326
26836
|
requestBody: {
|
|
26327
26837
|
content: {
|
|
26328
26838
|
'application/json': {
|
|
26329
26839
|
schema: {
|
|
26330
|
-
properties: {
|
|
26840
|
+
properties: {
|
|
26841
|
+
device_id: {
|
|
26842
|
+
description:
|
|
26843
|
+
'ID of the device that you want to simulate connecting to Seam.',
|
|
26844
|
+
format: 'uuid',
|
|
26845
|
+
type: 'string',
|
|
26846
|
+
},
|
|
26847
|
+
},
|
|
26331
26848
|
required: ['device_id'],
|
|
26332
26849
|
type: 'object',
|
|
26333
26850
|
},
|
|
@@ -26360,16 +26877,26 @@ export default {
|
|
|
26360
26877
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
26361
26878
|
'x-fern-sdk-method-name': 'connect',
|
|
26362
26879
|
'x-response-key': null,
|
|
26880
|
+
'x-title': 'Simulate Device Connection',
|
|
26363
26881
|
},
|
|
26364
26882
|
},
|
|
26365
26883
|
'/devices/simulate/disconnect': {
|
|
26366
26884
|
post: {
|
|
26885
|
+
description:
|
|
26886
|
+
'Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).',
|
|
26367
26887
|
operationId: 'devicesSimulateDisconnectPost',
|
|
26368
26888
|
requestBody: {
|
|
26369
26889
|
content: {
|
|
26370
26890
|
'application/json': {
|
|
26371
26891
|
schema: {
|
|
26372
|
-
properties: {
|
|
26892
|
+
properties: {
|
|
26893
|
+
device_id: {
|
|
26894
|
+
description:
|
|
26895
|
+
'ID of the device that you want to simulate disconnecting from Seam.',
|
|
26896
|
+
format: 'uuid',
|
|
26897
|
+
type: 'string',
|
|
26898
|
+
},
|
|
26899
|
+
},
|
|
26373
26900
|
required: ['device_id'],
|
|
26374
26901
|
type: 'object',
|
|
26375
26902
|
},
|
|
@@ -26402,16 +26929,26 @@ export default {
|
|
|
26402
26929
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
26403
26930
|
'x-fern-sdk-method-name': 'disconnect',
|
|
26404
26931
|
'x-response-key': null,
|
|
26932
|
+
'x-title': 'Simulate Device Disconnection',
|
|
26405
26933
|
},
|
|
26406
26934
|
},
|
|
26407
26935
|
'/devices/simulate/remove': {
|
|
26408
26936
|
post: {
|
|
26937
|
+
description:
|
|
26938
|
+
'Simulates removing a device from Seam. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://docs.seam.co/latest/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).',
|
|
26409
26939
|
operationId: 'devicesSimulateRemovePost',
|
|
26410
26940
|
requestBody: {
|
|
26411
26941
|
content: {
|
|
26412
26942
|
'application/json': {
|
|
26413
26943
|
schema: {
|
|
26414
|
-
properties: {
|
|
26944
|
+
properties: {
|
|
26945
|
+
device_id: {
|
|
26946
|
+
description:
|
|
26947
|
+
'ID of the device that you want to simulate removing from Seam.',
|
|
26948
|
+
format: 'uuid',
|
|
26949
|
+
type: 'string',
|
|
26950
|
+
},
|
|
26951
|
+
},
|
|
26415
26952
|
required: ['device_id'],
|
|
26416
26953
|
type: 'object',
|
|
26417
26954
|
},
|
|
@@ -26444,18 +26981,30 @@ export default {
|
|
|
26444
26981
|
'x-fern-sdk-group-name': ['devices', 'simulate'],
|
|
26445
26982
|
'x-fern-sdk-method-name': 'remove',
|
|
26446
26983
|
'x-response-key': null,
|
|
26984
|
+
'x-title': 'Simulate Device Removal',
|
|
26447
26985
|
},
|
|
26448
26986
|
},
|
|
26449
26987
|
'/devices/unmanaged/get': {
|
|
26450
26988
|
post: {
|
|
26989
|
+
description:
|
|
26990
|
+
'Returns a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).\n\nYou must specify either `device_id` or `name`.',
|
|
26451
26991
|
operationId: 'devicesUnmanagedGetPost',
|
|
26452
26992
|
requestBody: {
|
|
26453
26993
|
content: {
|
|
26454
26994
|
'application/json': {
|
|
26455
26995
|
schema: {
|
|
26456
26996
|
properties: {
|
|
26457
|
-
device_id: {
|
|
26458
|
-
|
|
26997
|
+
device_id: {
|
|
26998
|
+
description:
|
|
26999
|
+
'ID of the unmanaged device that you want to get.',
|
|
27000
|
+
format: 'uuid',
|
|
27001
|
+
type: 'string',
|
|
27002
|
+
},
|
|
27003
|
+
name: {
|
|
27004
|
+
description:
|
|
27005
|
+
'Name of the unmanaged device that you want to get.',
|
|
27006
|
+
type: 'string',
|
|
27007
|
+
},
|
|
26459
27008
|
},
|
|
26460
27009
|
type: 'object',
|
|
26461
27010
|
},
|
|
@@ -26493,10 +27042,13 @@ export default {
|
|
|
26493
27042
|
'x-fern-sdk-method-name': 'get',
|
|
26494
27043
|
'x-fern-sdk-return-value': 'device',
|
|
26495
27044
|
'x-response-key': 'device',
|
|
27045
|
+
'x-title': 'Get an Unmanaged Device',
|
|
26496
27046
|
},
|
|
26497
27047
|
},
|
|
26498
27048
|
'/devices/unmanaged/list': {
|
|
26499
27049
|
post: {
|
|
27050
|
+
description:
|
|
27051
|
+
'Returns a list of all [unmanaged devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
|
|
26500
27052
|
operationId: 'devicesUnmanagedListPost',
|
|
26501
27053
|
requestBody: {
|
|
26502
27054
|
content: {
|
|
@@ -26505,25 +27057,25 @@ export default {
|
|
|
26505
27057
|
properties: {
|
|
26506
27058
|
connect_webview_id: {
|
|
26507
27059
|
description:
|
|
26508
|
-
'ID of the Connect Webview
|
|
27060
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
26509
27061
|
format: 'uuid',
|
|
26510
27062
|
type: 'string',
|
|
26511
27063
|
},
|
|
26512
27064
|
connected_account_id: {
|
|
26513
27065
|
description:
|
|
26514
|
-
'ID of the connected account
|
|
27066
|
+
'ID of the connected account for which you want to list devices.',
|
|
26515
27067
|
format: 'uuid',
|
|
26516
27068
|
type: 'string',
|
|
26517
27069
|
},
|
|
26518
27070
|
connected_account_ids: {
|
|
26519
27071
|
description:
|
|
26520
|
-
'Array of IDs of the connected accounts
|
|
27072
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
26521
27073
|
items: { format: 'uuid', type: 'string' },
|
|
26522
27074
|
type: 'array',
|
|
26523
27075
|
},
|
|
26524
27076
|
created_before: {
|
|
26525
27077
|
description:
|
|
26526
|
-
'
|
|
27078
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
26527
27079
|
format: 'date-time',
|
|
26528
27080
|
type: 'string',
|
|
26529
27081
|
},
|
|
@@ -26532,7 +27084,7 @@ export default {
|
|
|
26532
27084
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
26533
27085
|
},
|
|
26534
27086
|
description:
|
|
26535
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
27087
|
+
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
26536
27088
|
type: 'object',
|
|
26537
27089
|
},
|
|
26538
27090
|
customer_ids: {
|
|
@@ -26541,12 +27093,13 @@ export default {
|
|
|
26541
27093
|
},
|
|
26542
27094
|
device_ids: {
|
|
26543
27095
|
description:
|
|
26544
|
-
'Array of device IDs
|
|
27096
|
+
'Array of device IDs for which you want to list devices.',
|
|
26545
27097
|
items: { format: 'uuid', type: 'string' },
|
|
26546
27098
|
type: 'array',
|
|
26547
27099
|
},
|
|
26548
27100
|
device_type: {
|
|
26549
|
-
description:
|
|
27101
|
+
description:
|
|
27102
|
+
'Device type for which you want to list devices.',
|
|
26550
27103
|
oneOf: [
|
|
26551
27104
|
{
|
|
26552
27105
|
enum: [
|
|
@@ -26604,7 +27157,7 @@ export default {
|
|
|
26604
27157
|
},
|
|
26605
27158
|
device_types: {
|
|
26606
27159
|
description:
|
|
26607
|
-
'Array of device types
|
|
27160
|
+
'Array of device types for which you want to list devices.',
|
|
26608
27161
|
items: {
|
|
26609
27162
|
oneOf: [
|
|
26610
27163
|
{
|
|
@@ -26711,7 +27264,8 @@ export default {
|
|
|
26711
27264
|
type: 'number',
|
|
26712
27265
|
},
|
|
26713
27266
|
manufacturer: {
|
|
26714
|
-
description:
|
|
27267
|
+
description:
|
|
27268
|
+
'Manufacturer for which you want to list devices.',
|
|
26715
27269
|
enum: [
|
|
26716
27270
|
'akuvox',
|
|
26717
27271
|
'august',
|
|
@@ -26761,6 +27315,8 @@ export default {
|
|
|
26761
27315
|
type: 'string',
|
|
26762
27316
|
},
|
|
26763
27317
|
unstable_location_id: {
|
|
27318
|
+
description:
|
|
27319
|
+
'ID of the location for which you want to list devices.',
|
|
26764
27320
|
format: 'uuid',
|
|
26765
27321
|
nullable: true,
|
|
26766
27322
|
type: 'string',
|
|
@@ -26768,7 +27324,7 @@ export default {
|
|
|
26768
27324
|
},
|
|
26769
27325
|
user_identifier_key: {
|
|
26770
27326
|
description:
|
|
26771
|
-
'Your own internal user ID for the user
|
|
27327
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
26772
27328
|
type: 'string',
|
|
26773
27329
|
},
|
|
26774
27330
|
},
|
|
@@ -26810,18 +27366,31 @@ export default {
|
|
|
26810
27366
|
'x-fern-sdk-method-name': 'list',
|
|
26811
27367
|
'x-fern-sdk-return-value': 'devices',
|
|
26812
27368
|
'x-response-key': 'devices',
|
|
27369
|
+
'x-title': 'List Unmanaged Devices',
|
|
26813
27370
|
},
|
|
26814
27371
|
},
|
|
26815
27372
|
'/devices/unmanaged/update': {
|
|
26816
27373
|
patch: {
|
|
27374
|
+
description:
|
|
27375
|
+
'Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
|
|
26817
27376
|
operationId: 'devicesUnmanagedUpdatePatch',
|
|
26818
27377
|
requestBody: {
|
|
26819
27378
|
content: {
|
|
26820
27379
|
'application/json': {
|
|
26821
27380
|
schema: {
|
|
26822
27381
|
properties: {
|
|
26823
|
-
device_id: {
|
|
26824
|
-
|
|
27382
|
+
device_id: {
|
|
27383
|
+
description:
|
|
27384
|
+
'ID of the unmanaged device that you want to update.',
|
|
27385
|
+
format: 'uuid',
|
|
27386
|
+
type: 'string',
|
|
27387
|
+
},
|
|
27388
|
+
is_managed: {
|
|
27389
|
+
description:
|
|
27390
|
+
'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
|
|
27391
|
+
enum: [true],
|
|
27392
|
+
type: 'boolean',
|
|
27393
|
+
},
|
|
26825
27394
|
},
|
|
26826
27395
|
required: ['device_id', 'is_managed'],
|
|
26827
27396
|
type: 'object',
|
|
@@ -26854,16 +27423,29 @@ export default {
|
|
|
26854
27423
|
tags: ['/devices'],
|
|
26855
27424
|
'x-fern-ignore': true,
|
|
26856
27425
|
'x-response-key': null,
|
|
27426
|
+
'x-title': 'Update an Unmanaged Device',
|
|
26857
27427
|
},
|
|
26858
27428
|
post: {
|
|
27429
|
+
description:
|
|
27430
|
+
'Updates a specified [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.\n\nAn unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).',
|
|
26859
27431
|
operationId: 'devicesUnmanagedUpdatePost',
|
|
26860
27432
|
requestBody: {
|
|
26861
27433
|
content: {
|
|
26862
27434
|
'application/json': {
|
|
26863
27435
|
schema: {
|
|
26864
27436
|
properties: {
|
|
26865
|
-
device_id: {
|
|
26866
|
-
|
|
27437
|
+
device_id: {
|
|
27438
|
+
description:
|
|
27439
|
+
'ID of the unmanaged device that you want to update.',
|
|
27440
|
+
format: 'uuid',
|
|
27441
|
+
type: 'string',
|
|
27442
|
+
},
|
|
27443
|
+
is_managed: {
|
|
27444
|
+
description:
|
|
27445
|
+
'Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed.',
|
|
27446
|
+
enum: [true],
|
|
27447
|
+
type: 'boolean',
|
|
27448
|
+
},
|
|
26867
27449
|
},
|
|
26868
27450
|
required: ['device_id', 'is_managed'],
|
|
26869
27451
|
type: 'object',
|
|
@@ -26897,10 +27479,13 @@ export default {
|
|
|
26897
27479
|
'x-fern-sdk-group-name': ['devices', 'unmanaged'],
|
|
26898
27480
|
'x-fern-sdk-method-name': 'update',
|
|
26899
27481
|
'x-response-key': null,
|
|
27482
|
+
'x-title': 'Update an Unmanaged Device',
|
|
26900
27483
|
},
|
|
26901
27484
|
},
|
|
26902
27485
|
'/devices/update': {
|
|
26903
27486
|
patch: {
|
|
27487
|
+
description:
|
|
27488
|
+
"Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
|
|
26904
27489
|
operationId: 'devicesUpdatePatch',
|
|
26905
27490
|
requestBody: {
|
|
26906
27491
|
content: {
|
|
@@ -26915,13 +27500,34 @@ export default {
|
|
|
26915
27500
|
{ type: 'boolean' },
|
|
26916
27501
|
],
|
|
26917
27502
|
},
|
|
27503
|
+
description:
|
|
27504
|
+
'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).',
|
|
26918
27505
|
type: 'object',
|
|
26919
27506
|
},
|
|
26920
|
-
device_id: {
|
|
26921
|
-
|
|
26922
|
-
|
|
27507
|
+
device_id: {
|
|
27508
|
+
description: 'ID of the device that you want to update.',
|
|
27509
|
+
format: 'uuid',
|
|
27510
|
+
type: 'string',
|
|
27511
|
+
},
|
|
27512
|
+
is_managed: {
|
|
27513
|
+
default: true,
|
|
27514
|
+
description:
|
|
27515
|
+
'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
|
|
27516
|
+
type: 'boolean',
|
|
27517
|
+
},
|
|
27518
|
+
name: {
|
|
27519
|
+
description: 'Name for the device.',
|
|
27520
|
+
nullable: true,
|
|
27521
|
+
type: 'string',
|
|
27522
|
+
},
|
|
26923
27523
|
properties: {
|
|
26924
|
-
properties: {
|
|
27524
|
+
properties: {
|
|
27525
|
+
name: {
|
|
27526
|
+
description: 'Name for the device.',
|
|
27527
|
+
nullable: true,
|
|
27528
|
+
type: 'string',
|
|
27529
|
+
},
|
|
27530
|
+
},
|
|
26925
27531
|
type: 'object',
|
|
26926
27532
|
},
|
|
26927
27533
|
},
|
|
@@ -26957,8 +27563,11 @@ export default {
|
|
|
26957
27563
|
tags: ['/devices'],
|
|
26958
27564
|
'x-fern-ignore': true,
|
|
26959
27565
|
'x-response-key': null,
|
|
27566
|
+
'x-title': 'Update a Device',
|
|
26960
27567
|
},
|
|
26961
27568
|
post: {
|
|
27569
|
+
description:
|
|
27570
|
+
"Updates a specified [device](https://docs.seam.co/latest/core-concepts/devices).\n\nYou can add or change [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).",
|
|
26962
27571
|
operationId: 'devicesUpdatePost',
|
|
26963
27572
|
requestBody: {
|
|
26964
27573
|
content: {
|
|
@@ -26973,13 +27582,34 @@ export default {
|
|
|
26973
27582
|
{ type: 'boolean' },
|
|
26974
27583
|
],
|
|
26975
27584
|
},
|
|
27585
|
+
description:
|
|
27586
|
+
'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata).',
|
|
26976
27587
|
type: 'object',
|
|
26977
27588
|
},
|
|
26978
|
-
device_id: {
|
|
26979
|
-
|
|
26980
|
-
|
|
27589
|
+
device_id: {
|
|
27590
|
+
description: 'ID of the device that you want to update.',
|
|
27591
|
+
format: 'uuid',
|
|
27592
|
+
type: 'string',
|
|
27593
|
+
},
|
|
27594
|
+
is_managed: {
|
|
27595
|
+
default: true,
|
|
27596
|
+
description:
|
|
27597
|
+
'Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`.',
|
|
27598
|
+
type: 'boolean',
|
|
27599
|
+
},
|
|
27600
|
+
name: {
|
|
27601
|
+
description: 'Name for the device.',
|
|
27602
|
+
nullable: true,
|
|
27603
|
+
type: 'string',
|
|
27604
|
+
},
|
|
26981
27605
|
properties: {
|
|
26982
|
-
properties: {
|
|
27606
|
+
properties: {
|
|
27607
|
+
name: {
|
|
27608
|
+
description: 'Name for the device.',
|
|
27609
|
+
nullable: true,
|
|
27610
|
+
type: 'string',
|
|
27611
|
+
},
|
|
27612
|
+
},
|
|
26983
27613
|
type: 'object',
|
|
26984
27614
|
},
|
|
26985
27615
|
},
|
|
@@ -27016,10 +27646,13 @@ export default {
|
|
|
27016
27646
|
'x-fern-sdk-group-name': ['devices'],
|
|
27017
27647
|
'x-fern-sdk-method-name': 'update',
|
|
27018
27648
|
'x-response-key': null,
|
|
27649
|
+
'x-title': 'Update a Device',
|
|
27019
27650
|
},
|
|
27020
27651
|
},
|
|
27021
27652
|
'/events/get': {
|
|
27022
27653
|
post: {
|
|
27654
|
+
description:
|
|
27655
|
+
'Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to retrieve an event that already took place.',
|
|
27023
27656
|
operationId: 'eventsGetPost',
|
|
27024
27657
|
requestBody: {
|
|
27025
27658
|
content: {
|
|
@@ -27067,10 +27700,13 @@ export default {
|
|
|
27067
27700
|
'x-fern-sdk-method-name': 'get',
|
|
27068
27701
|
'x-fern-sdk-return-value': 'event',
|
|
27069
27702
|
'x-response-key': 'event',
|
|
27703
|
+
'x-title': 'Get an Event',
|
|
27070
27704
|
},
|
|
27071
27705
|
},
|
|
27072
27706
|
'/events/list': {
|
|
27073
27707
|
post: {
|
|
27708
|
+
description:
|
|
27709
|
+
'Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/latest/developer-tools/webhooks), but it enables you to filter or see events that already took place.',
|
|
27074
27710
|
operationId: 'eventsListPost',
|
|
27075
27711
|
requestBody: {
|
|
27076
27712
|
content: {
|
|
@@ -27345,6 +27981,7 @@ export default {
|
|
|
27345
27981
|
'x-fern-sdk-method-name': 'list',
|
|
27346
27982
|
'x-fern-sdk-return-value': 'events',
|
|
27347
27983
|
'x-response-key': 'events',
|
|
27984
|
+
'x-title': 'List Events',
|
|
27348
27985
|
},
|
|
27349
27986
|
},
|
|
27350
27987
|
'/locks/get': {
|
|
@@ -27408,25 +28045,25 @@ export default {
|
|
|
27408
28045
|
properties: {
|
|
27409
28046
|
connect_webview_id: {
|
|
27410
28047
|
description:
|
|
27411
|
-
'ID of the Connect Webview
|
|
28048
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
27412
28049
|
format: 'uuid',
|
|
27413
28050
|
type: 'string',
|
|
27414
28051
|
},
|
|
27415
28052
|
connected_account_id: {
|
|
27416
28053
|
description:
|
|
27417
|
-
'ID of the connected account
|
|
28054
|
+
'ID of the connected account for which you want to list devices.',
|
|
27418
28055
|
format: 'uuid',
|
|
27419
28056
|
type: 'string',
|
|
27420
28057
|
},
|
|
27421
28058
|
connected_account_ids: {
|
|
27422
28059
|
description:
|
|
27423
|
-
'Array of IDs of the connected accounts
|
|
28060
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
27424
28061
|
items: { format: 'uuid', type: 'string' },
|
|
27425
28062
|
type: 'array',
|
|
27426
28063
|
},
|
|
27427
28064
|
created_before: {
|
|
27428
28065
|
description:
|
|
27429
|
-
'
|
|
28066
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
27430
28067
|
format: 'date-time',
|
|
27431
28068
|
type: 'string',
|
|
27432
28069
|
},
|
|
@@ -27435,7 +28072,7 @@ export default {
|
|
|
27435
28072
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27436
28073
|
},
|
|
27437
28074
|
description:
|
|
27438
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
28075
|
+
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
27439
28076
|
type: 'object',
|
|
27440
28077
|
},
|
|
27441
28078
|
customer_ids: {
|
|
@@ -27444,7 +28081,7 @@ export default {
|
|
|
27444
28081
|
},
|
|
27445
28082
|
device_ids: {
|
|
27446
28083
|
description:
|
|
27447
|
-
'Array of device IDs
|
|
28084
|
+
'Array of device IDs for which you want to list devices.',
|
|
27448
28085
|
items: { format: 'uuid', type: 'string' },
|
|
27449
28086
|
type: 'array',
|
|
27450
28087
|
},
|
|
@@ -27605,6 +28242,8 @@ export default {
|
|
|
27605
28242
|
type: 'string',
|
|
27606
28243
|
},
|
|
27607
28244
|
unstable_location_id: {
|
|
28245
|
+
description:
|
|
28246
|
+
'ID of the location for which you want to list devices.',
|
|
27608
28247
|
format: 'uuid',
|
|
27609
28248
|
nullable: true,
|
|
27610
28249
|
type: 'string',
|
|
@@ -27612,7 +28251,7 @@ export default {
|
|
|
27612
28251
|
},
|
|
27613
28252
|
user_identifier_key: {
|
|
27614
28253
|
description:
|
|
27615
|
-
'Your own internal user ID for the user
|
|
28254
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
27616
28255
|
type: 'string',
|
|
27617
28256
|
},
|
|
27618
28257
|
},
|
|
@@ -27969,25 +28608,25 @@ export default {
|
|
|
27969
28608
|
properties: {
|
|
27970
28609
|
connect_webview_id: {
|
|
27971
28610
|
description:
|
|
27972
|
-
'ID of the Connect Webview
|
|
28611
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
27973
28612
|
format: 'uuid',
|
|
27974
28613
|
type: 'string',
|
|
27975
28614
|
},
|
|
27976
28615
|
connected_account_id: {
|
|
27977
28616
|
description:
|
|
27978
|
-
'ID of the connected account
|
|
28617
|
+
'ID of the connected account for which you want to list devices.',
|
|
27979
28618
|
format: 'uuid',
|
|
27980
28619
|
type: 'string',
|
|
27981
28620
|
},
|
|
27982
28621
|
connected_account_ids: {
|
|
27983
28622
|
description:
|
|
27984
|
-
'Array of IDs of the connected accounts
|
|
28623
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
27985
28624
|
items: { format: 'uuid', type: 'string' },
|
|
27986
28625
|
type: 'array',
|
|
27987
28626
|
},
|
|
27988
28627
|
created_before: {
|
|
27989
28628
|
description:
|
|
27990
|
-
'
|
|
28629
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
27991
28630
|
format: 'date-time',
|
|
27992
28631
|
type: 'string',
|
|
27993
28632
|
},
|
|
@@ -27996,7 +28635,7 @@ export default {
|
|
|
27996
28635
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
27997
28636
|
},
|
|
27998
28637
|
description:
|
|
27999
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
28638
|
+
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
28000
28639
|
type: 'object',
|
|
28001
28640
|
},
|
|
28002
28641
|
customer_ids: {
|
|
@@ -28005,7 +28644,7 @@ export default {
|
|
|
28005
28644
|
},
|
|
28006
28645
|
device_ids: {
|
|
28007
28646
|
description:
|
|
28008
|
-
'Array of device IDs
|
|
28647
|
+
'Array of device IDs for which you want to list devices.',
|
|
28009
28648
|
items: { format: 'uuid', type: 'string' },
|
|
28010
28649
|
type: 'array',
|
|
28011
28650
|
},
|
|
@@ -28082,6 +28721,8 @@ export default {
|
|
|
28082
28721
|
type: 'string',
|
|
28083
28722
|
},
|
|
28084
28723
|
unstable_location_id: {
|
|
28724
|
+
description:
|
|
28725
|
+
'ID of the location for which you want to list devices.',
|
|
28085
28726
|
format: 'uuid',
|
|
28086
28727
|
nullable: true,
|
|
28087
28728
|
type: 'string',
|
|
@@ -28089,7 +28730,7 @@ export default {
|
|
|
28089
28730
|
},
|
|
28090
28731
|
user_identifier_key: {
|
|
28091
28732
|
description:
|
|
28092
|
-
'Your own internal user ID for the user
|
|
28733
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
28093
28734
|
type: 'string',
|
|
28094
28735
|
},
|
|
28095
28736
|
},
|
|
@@ -31023,25 +31664,25 @@ export default {
|
|
|
31023
31664
|
properties: {
|
|
31024
31665
|
connect_webview_id: {
|
|
31025
31666
|
description:
|
|
31026
|
-
'ID of the Connect Webview
|
|
31667
|
+
'ID of the Connect Webview for which you want to list devices.',
|
|
31027
31668
|
format: 'uuid',
|
|
31028
31669
|
type: 'string',
|
|
31029
31670
|
},
|
|
31030
31671
|
connected_account_id: {
|
|
31031
31672
|
description:
|
|
31032
|
-
'ID of the connected account
|
|
31673
|
+
'ID of the connected account for which you want to list devices.',
|
|
31033
31674
|
format: 'uuid',
|
|
31034
31675
|
type: 'string',
|
|
31035
31676
|
},
|
|
31036
31677
|
connected_account_ids: {
|
|
31037
31678
|
description:
|
|
31038
|
-
'Array of IDs of the connected accounts
|
|
31679
|
+
'Array of IDs of the connected accounts for which you want to list devices.',
|
|
31039
31680
|
items: { format: 'uuid', type: 'string' },
|
|
31040
31681
|
type: 'array',
|
|
31041
31682
|
},
|
|
31042
31683
|
created_before: {
|
|
31043
31684
|
description:
|
|
31044
|
-
'
|
|
31685
|
+
'Timestamp by which to limit returned devices. Returns devices created before this timestamp.',
|
|
31045
31686
|
format: 'date-time',
|
|
31046
31687
|
type: 'string',
|
|
31047
31688
|
},
|
|
@@ -31050,7 +31691,7 @@ export default {
|
|
|
31050
31691
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
31051
31692
|
},
|
|
31052
31693
|
description:
|
|
31053
|
-
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
31694
|
+
'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.',
|
|
31054
31695
|
type: 'object',
|
|
31055
31696
|
},
|
|
31056
31697
|
customer_ids: {
|
|
@@ -31059,7 +31700,7 @@ export default {
|
|
|
31059
31700
|
},
|
|
31060
31701
|
device_ids: {
|
|
31061
31702
|
description:
|
|
31062
|
-
'Array of device IDs
|
|
31703
|
+
'Array of device IDs for which you want to list devices.',
|
|
31063
31704
|
items: { format: 'uuid', type: 'string' },
|
|
31064
31705
|
type: 'array',
|
|
31065
31706
|
},
|
|
@@ -31158,6 +31799,8 @@ export default {
|
|
|
31158
31799
|
type: 'string',
|
|
31159
31800
|
},
|
|
31160
31801
|
unstable_location_id: {
|
|
31802
|
+
description:
|
|
31803
|
+
'ID of the location for which you want to list devices.',
|
|
31161
31804
|
format: 'uuid',
|
|
31162
31805
|
nullable: true,
|
|
31163
31806
|
type: 'string',
|
|
@@ -31165,7 +31808,7 @@ export default {
|
|
|
31165
31808
|
},
|
|
31166
31809
|
user_identifier_key: {
|
|
31167
31810
|
description:
|
|
31168
|
-
'Your own internal user ID for the user
|
|
31811
|
+
'Your own internal user ID for the user for which you want to list devices.',
|
|
31169
31812
|
type: 'string',
|
|
31170
31813
|
},
|
|
31171
31814
|
},
|
|
@@ -34484,6 +35127,101 @@ export default {
|
|
|
34484
35127
|
'x-undocumented': 'Experimental locations.',
|
|
34485
35128
|
},
|
|
34486
35129
|
},
|
|
35130
|
+
'/unstable_partner/resources/push': {
|
|
35131
|
+
post: {
|
|
35132
|
+
description: 'Send Seam some of your resources.',
|
|
35133
|
+
operationId: 'unstablePartnerResourcesPushPost',
|
|
35134
|
+
requestBody: {
|
|
35135
|
+
content: {
|
|
35136
|
+
'application/json': {
|
|
35137
|
+
schema: {
|
|
35138
|
+
oneOf: [
|
|
35139
|
+
{
|
|
35140
|
+
items: {
|
|
35141
|
+
properties: {
|
|
35142
|
+
custom_metadata: {
|
|
35143
|
+
additionalProperties: { type: 'string' },
|
|
35144
|
+
type: 'object',
|
|
35145
|
+
},
|
|
35146
|
+
customer_key: { type: 'string' },
|
|
35147
|
+
description: { type: 'string' },
|
|
35148
|
+
email_address: { type: 'string' },
|
|
35149
|
+
ends_at: { type: 'string' },
|
|
35150
|
+
icon_url: { type: 'string' },
|
|
35151
|
+
location_keys: {
|
|
35152
|
+
items: { type: 'string' },
|
|
35153
|
+
type: 'array',
|
|
35154
|
+
},
|
|
35155
|
+
name: { type: 'string' },
|
|
35156
|
+
partner_resource_key: { type: 'string' },
|
|
35157
|
+
partner_resource_type: { type: 'string' },
|
|
35158
|
+
phone_number: { type: 'string' },
|
|
35159
|
+
starts_at: { type: 'string' },
|
|
35160
|
+
user_identity_key: { type: 'string' },
|
|
35161
|
+
},
|
|
35162
|
+
type: 'object',
|
|
35163
|
+
},
|
|
35164
|
+
type: 'array',
|
|
35165
|
+
},
|
|
35166
|
+
{
|
|
35167
|
+
properties: {
|
|
35168
|
+
custom_metadata: {
|
|
35169
|
+
additionalProperties: { type: 'string' },
|
|
35170
|
+
type: 'object',
|
|
35171
|
+
},
|
|
35172
|
+
customer_key: { type: 'string' },
|
|
35173
|
+
description: { type: 'string' },
|
|
35174
|
+
email_address: { type: 'string' },
|
|
35175
|
+
ends_at: { type: 'string' },
|
|
35176
|
+
icon_url: { type: 'string' },
|
|
35177
|
+
location_keys: {
|
|
35178
|
+
items: { type: 'string' },
|
|
35179
|
+
type: 'array',
|
|
35180
|
+
},
|
|
35181
|
+
name: { type: 'string' },
|
|
35182
|
+
partner_resource_key: { type: 'string' },
|
|
35183
|
+
partner_resource_type: { type: 'string' },
|
|
35184
|
+
phone_number: { type: 'string' },
|
|
35185
|
+
starts_at: { type: 'string' },
|
|
35186
|
+
user_identity_key: { type: 'string' },
|
|
35187
|
+
},
|
|
35188
|
+
type: 'object',
|
|
35189
|
+
},
|
|
35190
|
+
],
|
|
35191
|
+
},
|
|
35192
|
+
},
|
|
35193
|
+
},
|
|
35194
|
+
},
|
|
35195
|
+
responses: {
|
|
35196
|
+
200: {
|
|
35197
|
+
content: {
|
|
35198
|
+
'application/json': {
|
|
35199
|
+
schema: {
|
|
35200
|
+
properties: { ok: { type: 'boolean' } },
|
|
35201
|
+
required: ['ok'],
|
|
35202
|
+
type: 'object',
|
|
35203
|
+
},
|
|
35204
|
+
},
|
|
35205
|
+
},
|
|
35206
|
+
description: 'OK',
|
|
35207
|
+
},
|
|
35208
|
+
400: { description: 'Bad Request' },
|
|
35209
|
+
401: { description: 'Unauthorized' },
|
|
35210
|
+
},
|
|
35211
|
+
security: [
|
|
35212
|
+
{ pat_with_workspace: [] },
|
|
35213
|
+
{ console_session_with_workspace: [] },
|
|
35214
|
+
{ api_key: [] },
|
|
35215
|
+
],
|
|
35216
|
+
summary: '/unstable_partner/resources/push',
|
|
35217
|
+
tags: [],
|
|
35218
|
+
'x-fern-sdk-group-name': ['unstable_partner', 'resources'],
|
|
35219
|
+
'x-fern-sdk-method-name': 'push',
|
|
35220
|
+
'x-response-key': null,
|
|
35221
|
+
'x-title': 'Push partner resources at Seam',
|
|
35222
|
+
'x-undocumented': 'Experimental partner resources.',
|
|
35223
|
+
},
|
|
35224
|
+
},
|
|
34487
35225
|
'/user_identities/add_acs_user': {
|
|
34488
35226
|
post: {
|
|
34489
35227
|
description:
|
|
@@ -34678,7 +35416,7 @@ export default {
|
|
|
34678
35416
|
'/user_identities/delete': {
|
|
34679
35417
|
post: {
|
|
34680
35418
|
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 [
|
|
35419
|
+
'Deletes a specified [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). To delete a user identity, you must first delete any [credentials](https://docs.seam.co/latest/api/access-control-systems/credentials) and [enrollment automations](https://docs.seam.co/latest/api/user_identities/enrollment_automations/delete) associated with the user identity. You must also deactivate any associated phones.',
|
|
34682
35420
|
operationId: 'userIdentitiesDeletePost',
|
|
34683
35421
|
requestBody: {
|
|
34684
35422
|
content: {
|
|
@@ -36274,6 +37012,8 @@ export default {
|
|
|
36274
37012
|
},
|
|
36275
37013
|
'/workspaces/reset_sandbox': {
|
|
36276
37014
|
post: {
|
|
37015
|
+
description:
|
|
37016
|
+
'Resets a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). Note that this endpoint is only available for sandbox workspaces.',
|
|
36277
37017
|
operationId: 'workspacesResetSandboxPost',
|
|
36278
37018
|
responses: {
|
|
36279
37019
|
200: {
|