@seamapi/types 1.531.0 → 1.533.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +41 -2
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +125 -2
- package/dist/index.cjs +41 -2
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +13 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +4 -1
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/metadata/hotek.d.ts +9 -0
- package/lib/seam/connect/models/acs/metadata/hotek.js +7 -0
- package/lib/seam/connect/models/acs/metadata/hotek.js.map +1 -0
- package/lib/seam/connect/models/acs/metadata/index.d.ts +1 -0
- package/lib/seam/connect/models/acs/metadata/index.js +1 -0
- package/lib/seam/connect/models/acs/metadata/index.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +105 -0
- package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
- package/lib/seam/connect/models/devices/device-provider.js +2 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/events/access-methods.d.ts +6 -0
- package/lib/seam/connect/models/events/access-methods.js +4 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +3 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +56 -0
- package/lib/seam/connect/openapi.d.ts +22 -0
- package/lib/seam/connect/openapi.js +28 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +62 -2
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/models/acs/metadata/hotek.ts +11 -0
- package/src/lib/seam/connect/models/acs/metadata/index.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
- package/src/lib/seam/connect/models/events/access-methods.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +31 -0
- package/src/lib/seam/connect/route-types.ts +82 -0
|
@@ -11365,6 +11365,11 @@ export type Routes = {
|
|
|
11365
11365
|
/** Indicates whether the entrance is connected. */
|
|
11366
11366
|
is_connected: boolean;
|
|
11367
11367
|
} | undefined;
|
|
11368
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
11369
|
+
hotek_metadata?: {
|
|
11370
|
+
/** Room number of the entrance. */
|
|
11371
|
+
room_number: string;
|
|
11372
|
+
} | undefined;
|
|
11368
11373
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
11369
11374
|
visionline_metadata?: {
|
|
11370
11375
|
/** Name of the door in the Visionline access system. */
|
|
@@ -14488,6 +14493,11 @@ export type Routes = {
|
|
|
14488
14493
|
/** Indicates whether the entrance is connected. */
|
|
14489
14494
|
is_connected: boolean;
|
|
14490
14495
|
} | undefined;
|
|
14496
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
14497
|
+
hotek_metadata?: {
|
|
14498
|
+
/** Room number of the entrance. */
|
|
14499
|
+
room_number: string;
|
|
14500
|
+
} | undefined;
|
|
14491
14501
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
14492
14502
|
visionline_metadata?: {
|
|
14493
14503
|
/** Name of the door in the Visionline access system. */
|
|
@@ -17794,6 +17804,8 @@ export type Routes = {
|
|
|
17794
17804
|
/** Keys of the access grants associated with this access method (if present). */
|
|
17795
17805
|
access_grant_keys?: string[] | undefined;
|
|
17796
17806
|
event_type: 'access_method.reissued';
|
|
17807
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
17808
|
+
code?: string | undefined;
|
|
17797
17809
|
} | {
|
|
17798
17810
|
/** ID of the event. */
|
|
17799
17811
|
event_id: string;
|
|
@@ -20390,6 +20402,11 @@ export type Routes = {
|
|
|
20390
20402
|
/** Indicates whether the entrance is connected. */
|
|
20391
20403
|
is_connected: boolean;
|
|
20392
20404
|
} | undefined;
|
|
20405
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
20406
|
+
hotek_metadata?: {
|
|
20407
|
+
/** Room number of the entrance. */
|
|
20408
|
+
room_number: string;
|
|
20409
|
+
} | undefined;
|
|
20393
20410
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
20394
20411
|
visionline_metadata?: {
|
|
20395
20412
|
/** Name of the door in the Visionline access system. */
|
|
@@ -21740,6 +21757,11 @@ export type Routes = {
|
|
|
21740
21757
|
/** Indicates whether the entrance is connected. */
|
|
21741
21758
|
is_connected: boolean;
|
|
21742
21759
|
} | undefined;
|
|
21760
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
21761
|
+
hotek_metadata?: {
|
|
21762
|
+
/** Room number of the entrance. */
|
|
21763
|
+
room_number: string;
|
|
21764
|
+
} | undefined;
|
|
21743
21765
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
21744
21766
|
visionline_metadata?: {
|
|
21745
21767
|
/** Name of the door in the Visionline access system. */
|
|
@@ -25175,6 +25197,11 @@ export type Routes = {
|
|
|
25175
25197
|
/** Indicates whether the entrance is connected. */
|
|
25176
25198
|
is_connected: boolean;
|
|
25177
25199
|
} | undefined;
|
|
25200
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
25201
|
+
hotek_metadata?: {
|
|
25202
|
+
/** Room number of the entrance. */
|
|
25203
|
+
room_number: string;
|
|
25204
|
+
} | undefined;
|
|
25178
25205
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
25179
25206
|
visionline_metadata?: {
|
|
25180
25207
|
/** Name of the door in the Visionline access system. */
|
|
@@ -25335,6 +25362,11 @@ export type Routes = {
|
|
|
25335
25362
|
/** Indicates whether the entrance is connected. */
|
|
25336
25363
|
is_connected: boolean;
|
|
25337
25364
|
} | undefined;
|
|
25365
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
25366
|
+
hotek_metadata?: {
|
|
25367
|
+
/** Room number of the entrance. */
|
|
25368
|
+
room_number: string;
|
|
25369
|
+
} | undefined;
|
|
25338
25370
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
25339
25371
|
visionline_metadata?: {
|
|
25340
25372
|
/** Name of the door in the Visionline access system. */
|
|
@@ -26765,6 +26797,11 @@ export type Routes = {
|
|
|
26765
26797
|
/** Indicates whether the entrance is connected. */
|
|
26766
26798
|
is_connected: boolean;
|
|
26767
26799
|
} | undefined;
|
|
26800
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
26801
|
+
hotek_metadata?: {
|
|
26802
|
+
/** Room number of the entrance. */
|
|
26803
|
+
room_number: string;
|
|
26804
|
+
} | undefined;
|
|
26768
26805
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
26769
26806
|
visionline_metadata?: {
|
|
26770
26807
|
/** Name of the door in the Visionline access system. */
|
|
@@ -30266,7 +30303,7 @@ export type Routes = {
|
|
|
30266
30303
|
/** Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key. */
|
|
30267
30304
|
customer_key?: string | undefined;
|
|
30268
30305
|
/** 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. */
|
|
30269
|
-
accepted_providers?: ('dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
30306
|
+
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
|
|
30270
30307
|
/** 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. */
|
|
30271
30308
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
|
|
30272
30309
|
/** 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). */
|
|
@@ -34028,7 +34065,7 @@ export type Routes = {
|
|
|
34028
34065
|
formData: {};
|
|
34029
34066
|
jsonResponse: {
|
|
34030
34067
|
device_providers: {
|
|
34031
|
-
device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
|
|
34068
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
|
|
34032
34069
|
display_name: string;
|
|
34033
34070
|
image_url: string;
|
|
34034
34071
|
provider_categories: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
|
|
@@ -35594,6 +35631,8 @@ export type Routes = {
|
|
|
35594
35631
|
/** Keys of the access grants associated with this access method (if present). */
|
|
35595
35632
|
access_grant_keys?: string[] | undefined;
|
|
35596
35633
|
event_type: 'access_method.reissued';
|
|
35634
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
35635
|
+
code?: string | undefined;
|
|
35597
35636
|
} | {
|
|
35598
35637
|
/** ID of the event. */
|
|
35599
35638
|
event_id: string;
|
|
@@ -37490,6 +37529,8 @@ export type Routes = {
|
|
|
37490
37529
|
/** Keys of the access grants associated with this access method (if present). */
|
|
37491
37530
|
access_grant_keys?: string[] | undefined;
|
|
37492
37531
|
event_type: 'access_method.reissued';
|
|
37532
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
37533
|
+
code?: string | undefined;
|
|
37493
37534
|
} | {
|
|
37494
37535
|
/** ID of the event. */
|
|
37495
37536
|
event_id: string;
|
|
@@ -56318,6 +56359,8 @@ export type Routes = {
|
|
|
56318
56359
|
/** Keys of the access grants associated with this access method (if present). */
|
|
56319
56360
|
access_grant_keys?: string[] | undefined;
|
|
56320
56361
|
event_type: 'access_method.reissued';
|
|
56362
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
56363
|
+
code?: string | undefined;
|
|
56321
56364
|
} | {
|
|
56322
56365
|
/** ID of the event. */
|
|
56323
56366
|
event_id: string;
|
|
@@ -58052,6 +58095,11 @@ export type Routes = {
|
|
|
58052
58095
|
/** Indicates whether the entrance is connected. */
|
|
58053
58096
|
is_connected: boolean;
|
|
58054
58097
|
} | undefined;
|
|
58098
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
58099
|
+
hotek_metadata?: {
|
|
58100
|
+
/** Room number of the entrance. */
|
|
58101
|
+
room_number: string;
|
|
58102
|
+
} | undefined;
|
|
58055
58103
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
58056
58104
|
visionline_metadata?: {
|
|
58057
58105
|
/** Name of the door in the Visionline access system. */
|
|
@@ -59564,6 +59612,11 @@ export type Routes = {
|
|
|
59564
59612
|
/** Indicates whether the entrance is connected. */
|
|
59565
59613
|
is_connected: boolean;
|
|
59566
59614
|
} | undefined;
|
|
59615
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
59616
|
+
hotek_metadata?: {
|
|
59617
|
+
/** Room number of the entrance. */
|
|
59618
|
+
room_number: string;
|
|
59619
|
+
} | undefined;
|
|
59567
59620
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
59568
59621
|
visionline_metadata?: {
|
|
59569
59622
|
/** Name of the door in the Visionline access system. */
|
|
@@ -80270,6 +80323,11 @@ export type Routes = {
|
|
|
80270
80323
|
/** Indicates whether the entrance is connected. */
|
|
80271
80324
|
is_connected: boolean;
|
|
80272
80325
|
} | undefined;
|
|
80326
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
80327
|
+
hotek_metadata?: {
|
|
80328
|
+
/** Room number of the entrance. */
|
|
80329
|
+
room_number: string;
|
|
80330
|
+
} | undefined;
|
|
80273
80331
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
80274
80332
|
visionline_metadata?: {
|
|
80275
80333
|
/** Name of the door in the Visionline access system. */
|
|
@@ -83576,6 +83634,8 @@ export type Routes = {
|
|
|
83576
83634
|
/** Keys of the access grants associated with this access method (if present). */
|
|
83577
83635
|
access_grant_keys?: string[] | undefined;
|
|
83578
83636
|
event_type: 'access_method.reissued';
|
|
83637
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
83638
|
+
code?: string | undefined;
|
|
83579
83639
|
} | {
|
|
83580
83640
|
/** ID of the event. */
|
|
83581
83641
|
event_id: string;
|
package/package.json
CHANGED
|
@@ -4,6 +4,7 @@ import { acs_entrance_dormakaba_ambiance_metadata } from './metadata/dormakaba-a
|
|
|
4
4
|
import {
|
|
5
5
|
acs_entrance_assa_abloy_vostio_metadata,
|
|
6
6
|
acs_entrance_dormakaba_community_metadata,
|
|
7
|
+
acs_entrance_hotek_metadata,
|
|
7
8
|
acs_entrance_latch_metadata,
|
|
8
9
|
acs_entrance_salto_ks_metadata,
|
|
9
10
|
acs_entrance_visionline_metadata,
|
|
@@ -85,6 +86,11 @@ export const acs_entrance = z
|
|
|
85
86
|
.describe(
|
|
86
87
|
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
87
88
|
),
|
|
89
|
+
hotek_metadata: acs_entrance_hotek_metadata
|
|
90
|
+
.optional()
|
|
91
|
+
.describe(
|
|
92
|
+
'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
93
|
+
),
|
|
88
94
|
visionline_metadata: acs_entrance_visionline_metadata
|
|
89
95
|
.optional()
|
|
90
96
|
.describe(
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { z } from 'zod'
|
|
2
|
+
|
|
3
|
+
export const acs_entrance_hotek_metadata = z
|
|
4
|
+
.object({
|
|
5
|
+
room_number: z.string().describe('Room number of the entrance.'),
|
|
6
|
+
})
|
|
7
|
+
.describe('Hotek-specific metadata associated with the entrance.')
|
|
8
|
+
|
|
9
|
+
export type AcsEntranceHotekMetadata = z.infer<
|
|
10
|
+
typeof acs_entrance_hotek_metadata
|
|
11
|
+
>
|
|
@@ -4,6 +4,7 @@ import type { ProviderCapability } from '../provider-capability.js'
|
|
|
4
4
|
import { device_capability_flags } from './device.js'
|
|
5
5
|
|
|
6
6
|
export const DEVICE_PROVIDERS = {
|
|
7
|
+
HOTEK: 'hotek',
|
|
7
8
|
DORMAKABA_COMMUNITY: 'dormakaba_community',
|
|
8
9
|
LEGIC_CONNECT: 'legic_connect',
|
|
9
10
|
AKUVOX: 'akuvox',
|
|
@@ -122,6 +123,7 @@ export const PROVIDER_CATEGORY_MAP = {
|
|
|
122
123
|
'dormakaba_ambiance',
|
|
123
124
|
'dormakaba_community',
|
|
124
125
|
'legic_connect',
|
|
126
|
+
'hotek',
|
|
125
127
|
],
|
|
126
128
|
|
|
127
129
|
internal_beta: ALL_DEVICE_PROVIDERS,
|
|
@@ -69,6 +69,12 @@ export const access_method_deleted_event = access_method_event.extend({
|
|
|
69
69
|
|
|
70
70
|
export const access_method_reissued_event = access_method_event.extend({
|
|
71
71
|
event_type: z.literal('access_method.reissued'),
|
|
72
|
+
code: z
|
|
73
|
+
.string()
|
|
74
|
+
.optional()
|
|
75
|
+
.describe(
|
|
76
|
+
"The actual PIN code for code access methods (only present when mode is 'code').",
|
|
77
|
+
),
|
|
72
78
|
}).describe(`
|
|
73
79
|
---
|
|
74
80
|
route_path: /access_methods
|
|
@@ -2851,6 +2851,18 @@ export default {
|
|
|
2851
2851
|
},
|
|
2852
2852
|
type: 'array',
|
|
2853
2853
|
},
|
|
2854
|
+
hotek_metadata: {
|
|
2855
|
+
description:
|
|
2856
|
+
'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
2857
|
+
properties: {
|
|
2858
|
+
room_number: {
|
|
2859
|
+
description: 'Room number of the entrance.',
|
|
2860
|
+
type: 'string',
|
|
2861
|
+
},
|
|
2862
|
+
},
|
|
2863
|
+
required: ['room_number'],
|
|
2864
|
+
type: 'object',
|
|
2865
|
+
},
|
|
2854
2866
|
latch_metadata: {
|
|
2855
2867
|
description:
|
|
2856
2868
|
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
@@ -12932,6 +12944,7 @@ export default {
|
|
|
12932
12944
|
can_unlock_with_code: { type: 'boolean' },
|
|
12933
12945
|
device_provider_name: {
|
|
12934
12946
|
enum: [
|
|
12947
|
+
'hotek',
|
|
12935
12948
|
'dormakaba_community',
|
|
12936
12949
|
'legic_connect',
|
|
12937
12950
|
'akuvox',
|
|
@@ -14845,6 +14858,11 @@ export default {
|
|
|
14845
14858
|
format: 'uuid',
|
|
14846
14859
|
type: 'string',
|
|
14847
14860
|
},
|
|
14861
|
+
code: {
|
|
14862
|
+
description:
|
|
14863
|
+
"The actual PIN code for code access methods (only present when mode is 'code').",
|
|
14864
|
+
type: 'string',
|
|
14865
|
+
},
|
|
14848
14866
|
created_at: {
|
|
14849
14867
|
description: 'Date and time at which the event was created.',
|
|
14850
14868
|
format: 'date-time',
|
|
@@ -19572,6 +19590,18 @@ export default {
|
|
|
19572
19590
|
},
|
|
19573
19591
|
type: 'array',
|
|
19574
19592
|
},
|
|
19593
|
+
hotek_metadata: {
|
|
19594
|
+
description:
|
|
19595
|
+
'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
19596
|
+
properties: {
|
|
19597
|
+
room_number: {
|
|
19598
|
+
description: 'Room number of the entrance.',
|
|
19599
|
+
type: 'string',
|
|
19600
|
+
},
|
|
19601
|
+
},
|
|
19602
|
+
required: ['room_number'],
|
|
19603
|
+
type: 'object',
|
|
19604
|
+
},
|
|
19575
19605
|
latch_metadata: {
|
|
19576
19606
|
description:
|
|
19577
19607
|
'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
|
|
@@ -37226,6 +37256,7 @@ export default {
|
|
|
37226
37256
|
'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.',
|
|
37227
37257
|
items: {
|
|
37228
37258
|
enum: [
|
|
37259
|
+
'hotek',
|
|
37229
37260
|
'dormakaba_community',
|
|
37230
37261
|
'legic_connect',
|
|
37231
37262
|
'akuvox',
|
|
@@ -12953,6 +12953,13 @@ export type Routes = {
|
|
|
12953
12953
|
is_connected: boolean
|
|
12954
12954
|
}
|
|
12955
12955
|
| undefined
|
|
12956
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
12957
|
+
hotek_metadata?:
|
|
12958
|
+
| {
|
|
12959
|
+
/** Room number of the entrance. */
|
|
12960
|
+
room_number: string
|
|
12961
|
+
}
|
|
12962
|
+
| undefined
|
|
12956
12963
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
12957
12964
|
visionline_metadata?:
|
|
12958
12965
|
| {
|
|
@@ -16711,6 +16718,13 @@ export type Routes = {
|
|
|
16711
16718
|
is_connected: boolean
|
|
16712
16719
|
}
|
|
16713
16720
|
| undefined
|
|
16721
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
16722
|
+
hotek_metadata?:
|
|
16723
|
+
| {
|
|
16724
|
+
/** Room number of the entrance. */
|
|
16725
|
+
room_number: string
|
|
16726
|
+
}
|
|
16727
|
+
| undefined
|
|
16714
16728
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
16715
16729
|
visionline_metadata?:
|
|
16716
16730
|
| {
|
|
@@ -20671,6 +20685,8 @@ export type Routes = {
|
|
|
20671
20685
|
/** Keys of the access grants associated with this access method (if present). */
|
|
20672
20686
|
access_grant_keys?: string[] | undefined
|
|
20673
20687
|
event_type: 'access_method.reissued'
|
|
20688
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
20689
|
+
code?: string | undefined
|
|
20674
20690
|
}
|
|
20675
20691
|
| {
|
|
20676
20692
|
/** ID of the event. */
|
|
@@ -23669,6 +23685,13 @@ export type Routes = {
|
|
|
23669
23685
|
is_connected: boolean
|
|
23670
23686
|
}
|
|
23671
23687
|
| undefined
|
|
23688
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23689
|
+
hotek_metadata?:
|
|
23690
|
+
| {
|
|
23691
|
+
/** Room number of the entrance. */
|
|
23692
|
+
room_number: string
|
|
23693
|
+
}
|
|
23694
|
+
| undefined
|
|
23672
23695
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
23673
23696
|
visionline_metadata?:
|
|
23674
23697
|
| {
|
|
@@ -25254,6 +25277,13 @@ export type Routes = {
|
|
|
25254
25277
|
is_connected: boolean
|
|
25255
25278
|
}
|
|
25256
25279
|
| undefined
|
|
25280
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
25281
|
+
hotek_metadata?:
|
|
25282
|
+
| {
|
|
25283
|
+
/** Room number of the entrance. */
|
|
25284
|
+
room_number: string
|
|
25285
|
+
}
|
|
25286
|
+
| undefined
|
|
25257
25287
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
25258
25288
|
visionline_metadata?:
|
|
25259
25289
|
| {
|
|
@@ -29209,6 +29239,13 @@ export type Routes = {
|
|
|
29209
29239
|
is_connected: boolean
|
|
29210
29240
|
}
|
|
29211
29241
|
| undefined
|
|
29242
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
29243
|
+
hotek_metadata?:
|
|
29244
|
+
| {
|
|
29245
|
+
/** Room number of the entrance. */
|
|
29246
|
+
room_number: string
|
|
29247
|
+
}
|
|
29248
|
+
| undefined
|
|
29212
29249
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
29213
29250
|
visionline_metadata?:
|
|
29214
29251
|
| {
|
|
@@ -29394,6 +29431,13 @@ export type Routes = {
|
|
|
29394
29431
|
is_connected: boolean
|
|
29395
29432
|
}
|
|
29396
29433
|
| undefined
|
|
29434
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
29435
|
+
hotek_metadata?:
|
|
29436
|
+
| {
|
|
29437
|
+
/** Room number of the entrance. */
|
|
29438
|
+
room_number: string
|
|
29439
|
+
}
|
|
29440
|
+
| undefined
|
|
29397
29441
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
29398
29442
|
visionline_metadata?:
|
|
29399
29443
|
| {
|
|
@@ -31118,6 +31162,13 @@ export type Routes = {
|
|
|
31118
31162
|
is_connected: boolean
|
|
31119
31163
|
}
|
|
31120
31164
|
| undefined
|
|
31165
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
31166
|
+
hotek_metadata?:
|
|
31167
|
+
| {
|
|
31168
|
+
/** Room number of the entrance. */
|
|
31169
|
+
room_number: string
|
|
31170
|
+
}
|
|
31171
|
+
| undefined
|
|
31121
31172
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
31122
31173
|
visionline_metadata?:
|
|
31123
31174
|
| {
|
|
@@ -35083,6 +35134,7 @@ export type Routes = {
|
|
|
35083
35134
|
/** 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. */
|
|
35084
35135
|
accepted_providers?:
|
|
35085
35136
|
| (
|
|
35137
|
+
| 'hotek'
|
|
35086
35138
|
| 'dormakaba_community'
|
|
35087
35139
|
| 'legic_connect'
|
|
35088
35140
|
| 'akuvox'
|
|
@@ -39835,6 +39887,7 @@ export type Routes = {
|
|
|
39835
39887
|
jsonResponse: {
|
|
39836
39888
|
device_providers: {
|
|
39837
39889
|
device_provider_name:
|
|
39890
|
+
| 'hotek'
|
|
39838
39891
|
| 'dormakaba_community'
|
|
39839
39892
|
| 'legic_connect'
|
|
39840
39893
|
| 'akuvox'
|
|
@@ -41897,6 +41950,8 @@ export type Routes = {
|
|
|
41897
41950
|
/** Keys of the access grants associated with this access method (if present). */
|
|
41898
41951
|
access_grant_keys?: string[] | undefined
|
|
41899
41952
|
event_type: 'access_method.reissued'
|
|
41953
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
41954
|
+
code?: string | undefined
|
|
41900
41955
|
}
|
|
41901
41956
|
| {
|
|
41902
41957
|
/** ID of the event. */
|
|
@@ -44316,6 +44371,8 @@ export type Routes = {
|
|
|
44316
44371
|
/** Keys of the access grants associated with this access method (if present). */
|
|
44317
44372
|
access_grant_keys?: string[] | undefined
|
|
44318
44373
|
event_type: 'access_method.reissued'
|
|
44374
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
44375
|
+
code?: string | undefined
|
|
44319
44376
|
}
|
|
44320
44377
|
| {
|
|
44321
44378
|
/** ID of the event. */
|
|
@@ -67009,6 +67066,8 @@ export type Routes = {
|
|
|
67009
67066
|
/** Keys of the access grants associated with this access method (if present). */
|
|
67010
67067
|
access_grant_keys?: string[] | undefined
|
|
67011
67068
|
event_type: 'access_method.reissued'
|
|
67069
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
67070
|
+
code?: string | undefined
|
|
67012
67071
|
}
|
|
67013
67072
|
| {
|
|
67014
67073
|
/** ID of the event. */
|
|
@@ -69065,6 +69124,13 @@ export type Routes = {
|
|
|
69065
69124
|
is_connected: boolean
|
|
69066
69125
|
}
|
|
69067
69126
|
| undefined
|
|
69127
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
69128
|
+
hotek_metadata?:
|
|
69129
|
+
| {
|
|
69130
|
+
/** Room number of the entrance. */
|
|
69131
|
+
room_number: string
|
|
69132
|
+
}
|
|
69133
|
+
| undefined
|
|
69068
69134
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
69069
69135
|
visionline_metadata?:
|
|
69070
69136
|
| {
|
|
@@ -70950,6 +71016,13 @@ export type Routes = {
|
|
|
70950
71016
|
is_connected: boolean
|
|
70951
71017
|
}
|
|
70952
71018
|
| undefined
|
|
71019
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
71020
|
+
hotek_metadata?:
|
|
71021
|
+
| {
|
|
71022
|
+
/** Room number of the entrance. */
|
|
71023
|
+
room_number: string
|
|
71024
|
+
}
|
|
71025
|
+
| undefined
|
|
70953
71026
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
70954
71027
|
visionline_metadata?:
|
|
70955
71028
|
| {
|
|
@@ -95472,6 +95545,13 @@ export type Routes = {
|
|
|
95472
95545
|
is_connected: boolean
|
|
95473
95546
|
}
|
|
95474
95547
|
| undefined
|
|
95548
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
95549
|
+
hotek_metadata?:
|
|
95550
|
+
| {
|
|
95551
|
+
/** Room number of the entrance. */
|
|
95552
|
+
room_number: string
|
|
95553
|
+
}
|
|
95554
|
+
| undefined
|
|
95475
95555
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
95476
95556
|
visionline_metadata?:
|
|
95477
95557
|
| {
|
|
@@ -99432,6 +99512,8 @@ export type Routes = {
|
|
|
99432
99512
|
/** Keys of the access grants associated with this access method (if present). */
|
|
99433
99513
|
access_grant_keys?: string[] | undefined
|
|
99434
99514
|
event_type: 'access_method.reissued'
|
|
99515
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
99516
|
+
code?: string | undefined
|
|
99435
99517
|
}
|
|
99436
99518
|
| {
|
|
99437
99519
|
/** ID of the event. */
|