@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
package/dist/connect.d.cts
CHANGED
|
@@ -4566,6 +4566,13 @@ declare const acs_entrance: z.ZodObject<{
|
|
|
4566
4566
|
door_type: string;
|
|
4567
4567
|
accessibility_type: string;
|
|
4568
4568
|
}>>;
|
|
4569
|
+
hotek_metadata: z.ZodOptional<z.ZodObject<{
|
|
4570
|
+
room_number: z.ZodString;
|
|
4571
|
+
}, "strip", z.ZodTypeAny, {
|
|
4572
|
+
room_number: string;
|
|
4573
|
+
}, {
|
|
4574
|
+
room_number: string;
|
|
4575
|
+
}>>;
|
|
4569
4576
|
visionline_metadata: z.ZodOptional<z.ZodObject<{
|
|
4570
4577
|
door_name: z.ZodString;
|
|
4571
4578
|
door_category: z.ZodEnum<["entrance", "guest", "elevator reader", "common", "common (PMS)"]>;
|
|
@@ -4725,6 +4732,9 @@ declare const acs_entrance: z.ZodObject<{
|
|
|
4725
4732
|
door_type: string;
|
|
4726
4733
|
accessibility_type: string;
|
|
4727
4734
|
} | undefined;
|
|
4735
|
+
hotek_metadata?: {
|
|
4736
|
+
room_number: string;
|
|
4737
|
+
} | undefined;
|
|
4728
4738
|
dormakaba_community_metadata?: {
|
|
4729
4739
|
access_point_name: string;
|
|
4730
4740
|
} | undefined;
|
|
@@ -4783,6 +4793,9 @@ declare const acs_entrance: z.ZodObject<{
|
|
|
4783
4793
|
door_type: string;
|
|
4784
4794
|
accessibility_type: string;
|
|
4785
4795
|
} | undefined;
|
|
4796
|
+
hotek_metadata?: {
|
|
4797
|
+
room_number: string;
|
|
4798
|
+
} | undefined;
|
|
4786
4799
|
dormakaba_community_metadata?: {
|
|
4787
4800
|
access_point_name: string;
|
|
4788
4801
|
} | undefined;
|
|
@@ -14443,6 +14456,13 @@ declare const batch: z.ZodObject<{
|
|
|
14443
14456
|
door_type: string;
|
|
14444
14457
|
accessibility_type: string;
|
|
14445
14458
|
}>>;
|
|
14459
|
+
hotek_metadata: z.ZodOptional<z.ZodObject<{
|
|
14460
|
+
room_number: z.ZodString;
|
|
14461
|
+
}, "strip", z.ZodTypeAny, {
|
|
14462
|
+
room_number: string;
|
|
14463
|
+
}, {
|
|
14464
|
+
room_number: string;
|
|
14465
|
+
}>>;
|
|
14446
14466
|
visionline_metadata: z.ZodOptional<z.ZodObject<{
|
|
14447
14467
|
door_name: z.ZodString;
|
|
14448
14468
|
door_category: z.ZodEnum<["entrance", "guest", "elevator reader", "common", "common (PMS)"]>;
|
|
@@ -14602,6 +14622,9 @@ declare const batch: z.ZodObject<{
|
|
|
14602
14622
|
door_type: string;
|
|
14603
14623
|
accessibility_type: string;
|
|
14604
14624
|
} | undefined;
|
|
14625
|
+
hotek_metadata?: {
|
|
14626
|
+
room_number: string;
|
|
14627
|
+
} | undefined;
|
|
14605
14628
|
dormakaba_community_metadata?: {
|
|
14606
14629
|
access_point_name: string;
|
|
14607
14630
|
} | undefined;
|
|
@@ -14660,6 +14683,9 @@ declare const batch: z.ZodObject<{
|
|
|
14660
14683
|
door_type: string;
|
|
14661
14684
|
accessibility_type: string;
|
|
14662
14685
|
} | undefined;
|
|
14686
|
+
hotek_metadata?: {
|
|
14687
|
+
room_number: string;
|
|
14688
|
+
} | undefined;
|
|
14663
14689
|
dormakaba_community_metadata?: {
|
|
14664
14690
|
access_point_name: string;
|
|
14665
14691
|
} | undefined;
|
|
@@ -25257,6 +25283,7 @@ declare const batch: z.ZodObject<{
|
|
|
25257
25283
|
access_grant_keys: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
25258
25284
|
} & {
|
|
25259
25285
|
event_type: z.ZodLiteral<"access_method.reissued">;
|
|
25286
|
+
code: z.ZodOptional<z.ZodString>;
|
|
25260
25287
|
}, "strip", z.ZodTypeAny, {
|
|
25261
25288
|
workspace_id: string;
|
|
25262
25289
|
created_at: string;
|
|
@@ -25265,6 +25292,7 @@ declare const batch: z.ZodObject<{
|
|
|
25265
25292
|
occurred_at: string;
|
|
25266
25293
|
event_type: "access_method.reissued";
|
|
25267
25294
|
access_grant_ids: string[];
|
|
25295
|
+
code?: string | undefined;
|
|
25268
25296
|
access_grant_keys?: string[] | undefined;
|
|
25269
25297
|
}, {
|
|
25270
25298
|
workspace_id: string;
|
|
@@ -25274,6 +25302,7 @@ declare const batch: z.ZodObject<{
|
|
|
25274
25302
|
occurred_at: string;
|
|
25275
25303
|
event_type: "access_method.reissued";
|
|
25276
25304
|
access_grant_ids: string[];
|
|
25305
|
+
code?: string | undefined;
|
|
25277
25306
|
access_grant_keys?: string[] | undefined;
|
|
25278
25307
|
}>, z.ZodObject<{
|
|
25279
25308
|
event_id: z.ZodString;
|
|
@@ -31275,6 +31304,9 @@ declare const batch: z.ZodObject<{
|
|
|
31275
31304
|
door_type: string;
|
|
31276
31305
|
accessibility_type: string;
|
|
31277
31306
|
} | undefined;
|
|
31307
|
+
hotek_metadata?: {
|
|
31308
|
+
room_number: string;
|
|
31309
|
+
} | undefined;
|
|
31278
31310
|
dormakaba_community_metadata?: {
|
|
31279
31311
|
access_point_name: string;
|
|
31280
31312
|
} | undefined;
|
|
@@ -33142,6 +33174,7 @@ declare const batch: z.ZodObject<{
|
|
|
33142
33174
|
occurred_at: string;
|
|
33143
33175
|
event_type: "access_method.reissued";
|
|
33144
33176
|
access_grant_ids: string[];
|
|
33177
|
+
code?: string | undefined;
|
|
33145
33178
|
access_grant_keys?: string[] | undefined;
|
|
33146
33179
|
} | {
|
|
33147
33180
|
workspace_id: string;
|
|
@@ -35128,6 +35161,9 @@ declare const batch: z.ZodObject<{
|
|
|
35128
35161
|
door_type: string;
|
|
35129
35162
|
accessibility_type: string;
|
|
35130
35163
|
} | undefined;
|
|
35164
|
+
hotek_metadata?: {
|
|
35165
|
+
room_number: string;
|
|
35166
|
+
} | undefined;
|
|
35131
35167
|
dormakaba_community_metadata?: {
|
|
35132
35168
|
access_point_name: string;
|
|
35133
35169
|
} | undefined;
|
|
@@ -36995,6 +37031,7 @@ declare const batch: z.ZodObject<{
|
|
|
36995
37031
|
occurred_at: string;
|
|
36996
37032
|
event_type: "access_method.reissued";
|
|
36997
37033
|
access_grant_ids: string[];
|
|
37034
|
+
code?: string | undefined;
|
|
36998
37035
|
access_grant_keys?: string[] | undefined;
|
|
36999
37036
|
} | {
|
|
37000
37037
|
workspace_id: string;
|
|
@@ -43639,6 +43676,7 @@ declare const device: z.ZodObject<{
|
|
|
43639
43676
|
type Device = z.infer<typeof device>;
|
|
43640
43677
|
|
|
43641
43678
|
declare const DEVICE_PROVIDERS: {
|
|
43679
|
+
readonly HOTEK: "hotek";
|
|
43642
43680
|
readonly DORMAKABA_COMMUNITY: "dormakaba_community";
|
|
43643
43681
|
readonly LEGIC_CONNECT: "legic_connect";
|
|
43644
43682
|
readonly AKUVOX: "akuvox";
|
|
@@ -47988,6 +48026,7 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
47988
48026
|
access_grant_keys: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
47989
48027
|
} & {
|
|
47990
48028
|
event_type: z.ZodLiteral<"access_method.reissued">;
|
|
48029
|
+
code: z.ZodOptional<z.ZodString>;
|
|
47991
48030
|
}, "strip", z.ZodTypeAny, {
|
|
47992
48031
|
workspace_id: string;
|
|
47993
48032
|
created_at: string;
|
|
@@ -47996,6 +48035,7 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
47996
48035
|
occurred_at: string;
|
|
47997
48036
|
event_type: "access_method.reissued";
|
|
47998
48037
|
access_grant_ids: string[];
|
|
48038
|
+
code?: string | undefined;
|
|
47999
48039
|
access_grant_keys?: string[] | undefined;
|
|
48000
48040
|
}, {
|
|
48001
48041
|
workspace_id: string;
|
|
@@ -48005,6 +48045,7 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
|
|
|
48005
48045
|
occurred_at: string;
|
|
48006
48046
|
event_type: "access_method.reissued";
|
|
48007
48047
|
access_grant_ids: string[];
|
|
48048
|
+
code?: string | undefined;
|
|
48008
48049
|
access_grant_keys?: string[] | undefined;
|
|
48009
48050
|
}>, z.ZodObject<{
|
|
48010
48051
|
event_id: z.ZodString;
|
|
@@ -51799,6 +51840,17 @@ declare const _default: {
|
|
|
51799
51840
|
};
|
|
51800
51841
|
type: string;
|
|
51801
51842
|
};
|
|
51843
|
+
hotek_metadata: {
|
|
51844
|
+
description: string;
|
|
51845
|
+
properties: {
|
|
51846
|
+
room_number: {
|
|
51847
|
+
description: string;
|
|
51848
|
+
type: string;
|
|
51849
|
+
};
|
|
51850
|
+
};
|
|
51851
|
+
required: string[];
|
|
51852
|
+
type: string;
|
|
51853
|
+
};
|
|
51802
51854
|
latch_metadata: {
|
|
51803
51855
|
description: string;
|
|
51804
51856
|
properties: {
|
|
@@ -61613,6 +61665,17 @@ declare const _default: {
|
|
|
61613
61665
|
};
|
|
61614
61666
|
type: string;
|
|
61615
61667
|
};
|
|
61668
|
+
hotek_metadata: {
|
|
61669
|
+
description: string;
|
|
61670
|
+
properties: {
|
|
61671
|
+
room_number: {
|
|
61672
|
+
description: string;
|
|
61673
|
+
type: string;
|
|
61674
|
+
};
|
|
61675
|
+
};
|
|
61676
|
+
required: string[];
|
|
61677
|
+
type: string;
|
|
61678
|
+
};
|
|
61616
61679
|
latch_metadata: {
|
|
61617
61680
|
description: string;
|
|
61618
61681
|
properties: {
|
|
@@ -112729,6 +112792,11 @@ type Routes = {
|
|
|
112729
112792
|
/** Indicates whether the entrance is connected. */
|
|
112730
112793
|
is_connected: boolean;
|
|
112731
112794
|
} | undefined;
|
|
112795
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
112796
|
+
hotek_metadata?: {
|
|
112797
|
+
/** Room number of the entrance. */
|
|
112798
|
+
room_number: string;
|
|
112799
|
+
} | undefined;
|
|
112732
112800
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
112733
112801
|
visionline_metadata?: {
|
|
112734
112802
|
/** Name of the door in the Visionline access system. */
|
|
@@ -115852,6 +115920,11 @@ type Routes = {
|
|
|
115852
115920
|
/** Indicates whether the entrance is connected. */
|
|
115853
115921
|
is_connected: boolean;
|
|
115854
115922
|
} | undefined;
|
|
115923
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
115924
|
+
hotek_metadata?: {
|
|
115925
|
+
/** Room number of the entrance. */
|
|
115926
|
+
room_number: string;
|
|
115927
|
+
} | undefined;
|
|
115855
115928
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
115856
115929
|
visionline_metadata?: {
|
|
115857
115930
|
/** Name of the door in the Visionline access system. */
|
|
@@ -119158,6 +119231,8 @@ type Routes = {
|
|
|
119158
119231
|
/** Keys of the access grants associated with this access method (if present). */
|
|
119159
119232
|
access_grant_keys?: string[] | undefined;
|
|
119160
119233
|
event_type: 'access_method.reissued';
|
|
119234
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
119235
|
+
code?: string | undefined;
|
|
119161
119236
|
} | {
|
|
119162
119237
|
/** ID of the event. */
|
|
119163
119238
|
event_id: string;
|
|
@@ -121754,6 +121829,11 @@ type Routes = {
|
|
|
121754
121829
|
/** Indicates whether the entrance is connected. */
|
|
121755
121830
|
is_connected: boolean;
|
|
121756
121831
|
} | undefined;
|
|
121832
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
121833
|
+
hotek_metadata?: {
|
|
121834
|
+
/** Room number of the entrance. */
|
|
121835
|
+
room_number: string;
|
|
121836
|
+
} | undefined;
|
|
121757
121837
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
121758
121838
|
visionline_metadata?: {
|
|
121759
121839
|
/** Name of the door in the Visionline access system. */
|
|
@@ -123104,6 +123184,11 @@ type Routes = {
|
|
|
123104
123184
|
/** Indicates whether the entrance is connected. */
|
|
123105
123185
|
is_connected: boolean;
|
|
123106
123186
|
} | undefined;
|
|
123187
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
123188
|
+
hotek_metadata?: {
|
|
123189
|
+
/** Room number of the entrance. */
|
|
123190
|
+
room_number: string;
|
|
123191
|
+
} | undefined;
|
|
123107
123192
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
123108
123193
|
visionline_metadata?: {
|
|
123109
123194
|
/** Name of the door in the Visionline access system. */
|
|
@@ -126539,6 +126624,11 @@ type Routes = {
|
|
|
126539
126624
|
/** Indicates whether the entrance is connected. */
|
|
126540
126625
|
is_connected: boolean;
|
|
126541
126626
|
} | undefined;
|
|
126627
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
126628
|
+
hotek_metadata?: {
|
|
126629
|
+
/** Room number of the entrance. */
|
|
126630
|
+
room_number: string;
|
|
126631
|
+
} | undefined;
|
|
126542
126632
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
126543
126633
|
visionline_metadata?: {
|
|
126544
126634
|
/** Name of the door in the Visionline access system. */
|
|
@@ -126699,6 +126789,11 @@ type Routes = {
|
|
|
126699
126789
|
/** Indicates whether the entrance is connected. */
|
|
126700
126790
|
is_connected: boolean;
|
|
126701
126791
|
} | undefined;
|
|
126792
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
126793
|
+
hotek_metadata?: {
|
|
126794
|
+
/** Room number of the entrance. */
|
|
126795
|
+
room_number: string;
|
|
126796
|
+
} | undefined;
|
|
126702
126797
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
126703
126798
|
visionline_metadata?: {
|
|
126704
126799
|
/** Name of the door in the Visionline access system. */
|
|
@@ -128129,6 +128224,11 @@ type Routes = {
|
|
|
128129
128224
|
/** Indicates whether the entrance is connected. */
|
|
128130
128225
|
is_connected: boolean;
|
|
128131
128226
|
} | undefined;
|
|
128227
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
128228
|
+
hotek_metadata?: {
|
|
128229
|
+
/** Room number of the entrance. */
|
|
128230
|
+
room_number: string;
|
|
128231
|
+
} | undefined;
|
|
128132
128232
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
128133
128233
|
visionline_metadata?: {
|
|
128134
128234
|
/** Name of the door in the Visionline access system. */
|
|
@@ -131630,7 +131730,7 @@ type Routes = {
|
|
|
131630
131730
|
/** 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. */
|
|
131631
131731
|
customer_key?: string | undefined;
|
|
131632
131732
|
/** 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. */
|
|
131633
|
-
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;
|
|
131733
|
+
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;
|
|
131634
131734
|
/** 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. */
|
|
131635
131735
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
|
|
131636
131736
|
/** 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). */
|
|
@@ -135392,7 +135492,7 @@ type Routes = {
|
|
|
135392
135492
|
formData: {};
|
|
135393
135493
|
jsonResponse: {
|
|
135394
135494
|
device_providers: {
|
|
135395
|
-
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';
|
|
135495
|
+
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';
|
|
135396
135496
|
display_name: string;
|
|
135397
135497
|
image_url: string;
|
|
135398
135498
|
provider_categories: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
|
|
@@ -136958,6 +137058,8 @@ type Routes = {
|
|
|
136958
137058
|
/** Keys of the access grants associated with this access method (if present). */
|
|
136959
137059
|
access_grant_keys?: string[] | undefined;
|
|
136960
137060
|
event_type: 'access_method.reissued';
|
|
137061
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
137062
|
+
code?: string | undefined;
|
|
136961
137063
|
} | {
|
|
136962
137064
|
/** ID of the event. */
|
|
136963
137065
|
event_id: string;
|
|
@@ -138854,6 +138956,8 @@ type Routes = {
|
|
|
138854
138956
|
/** Keys of the access grants associated with this access method (if present). */
|
|
138855
138957
|
access_grant_keys?: string[] | undefined;
|
|
138856
138958
|
event_type: 'access_method.reissued';
|
|
138959
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
138960
|
+
code?: string | undefined;
|
|
138857
138961
|
} | {
|
|
138858
138962
|
/** ID of the event. */
|
|
138859
138963
|
event_id: string;
|
|
@@ -157682,6 +157786,8 @@ type Routes = {
|
|
|
157682
157786
|
/** Keys of the access grants associated with this access method (if present). */
|
|
157683
157787
|
access_grant_keys?: string[] | undefined;
|
|
157684
157788
|
event_type: 'access_method.reissued';
|
|
157789
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
157790
|
+
code?: string | undefined;
|
|
157685
157791
|
} | {
|
|
157686
157792
|
/** ID of the event. */
|
|
157687
157793
|
event_id: string;
|
|
@@ -159416,6 +159522,11 @@ type Routes = {
|
|
|
159416
159522
|
/** Indicates whether the entrance is connected. */
|
|
159417
159523
|
is_connected: boolean;
|
|
159418
159524
|
} | undefined;
|
|
159525
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
159526
|
+
hotek_metadata?: {
|
|
159527
|
+
/** Room number of the entrance. */
|
|
159528
|
+
room_number: string;
|
|
159529
|
+
} | undefined;
|
|
159419
159530
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
159420
159531
|
visionline_metadata?: {
|
|
159421
159532
|
/** Name of the door in the Visionline access system. */
|
|
@@ -160928,6 +161039,11 @@ type Routes = {
|
|
|
160928
161039
|
/** Indicates whether the entrance is connected. */
|
|
160929
161040
|
is_connected: boolean;
|
|
160930
161041
|
} | undefined;
|
|
161042
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
161043
|
+
hotek_metadata?: {
|
|
161044
|
+
/** Room number of the entrance. */
|
|
161045
|
+
room_number: string;
|
|
161046
|
+
} | undefined;
|
|
160931
161047
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
160932
161048
|
visionline_metadata?: {
|
|
160933
161049
|
/** Name of the door in the Visionline access system. */
|
|
@@ -181634,6 +181750,11 @@ type Routes = {
|
|
|
181634
181750
|
/** Indicates whether the entrance is connected. */
|
|
181635
181751
|
is_connected: boolean;
|
|
181636
181752
|
} | undefined;
|
|
181753
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
181754
|
+
hotek_metadata?: {
|
|
181755
|
+
/** Room number of the entrance. */
|
|
181756
|
+
room_number: string;
|
|
181757
|
+
} | undefined;
|
|
181637
181758
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
181638
181759
|
visionline_metadata?: {
|
|
181639
181760
|
/** Name of the door in the Visionline access system. */
|
|
@@ -184940,6 +185061,8 @@ type Routes = {
|
|
|
184940
185061
|
/** Keys of the access grants associated with this access method (if present). */
|
|
184941
185062
|
access_grant_keys?: string[] | undefined;
|
|
184942
185063
|
event_type: 'access_method.reissued';
|
|
185064
|
+
/** The actual PIN code for code access methods (only present when mode is 'code'). */
|
|
185065
|
+
code?: string | undefined;
|
|
184943
185066
|
} | {
|
|
184944
185067
|
/** ID of the event. */
|
|
184945
185068
|
event_id: string;
|
package/dist/index.cjs
CHANGED
|
@@ -1711,6 +1711,7 @@ var device = zod.z.object({
|
|
|
1711
1711
|
Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.
|
|
1712
1712
|
`);
|
|
1713
1713
|
var DEVICE_PROVIDERS = {
|
|
1714
|
+
HOTEK: "hotek",
|
|
1714
1715
|
DORMAKABA_COMMUNITY: "dormakaba_community",
|
|
1715
1716
|
LEGIC_CONNECT: "legic_connect",
|
|
1716
1717
|
AKUVOX: "akuvox",
|
|
@@ -1816,7 +1817,8 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1816
1817
|
"salto_space",
|
|
1817
1818
|
"dormakaba_ambiance",
|
|
1818
1819
|
"dormakaba_community",
|
|
1819
|
-
"legic_connect"
|
|
1820
|
+
"legic_connect",
|
|
1821
|
+
"hotek"
|
|
1820
1822
|
],
|
|
1821
1823
|
internal_beta: ALL_DEVICE_PROVIDERS
|
|
1822
1824
|
};
|
|
@@ -2462,6 +2464,9 @@ var acs_entrance_dormakaba_community_metadata = zod.z.object({
|
|
|
2462
2464
|
}).describe(
|
|
2463
2465
|
"dormakaba Community-specific metadata associated with the entrance."
|
|
2464
2466
|
);
|
|
2467
|
+
var acs_entrance_hotek_metadata = zod.z.object({
|
|
2468
|
+
room_number: zod.z.string().describe("Room number of the entrance.")
|
|
2469
|
+
}).describe("Hotek-specific metadata associated with the entrance.");
|
|
2465
2470
|
var acs_entrance_latch_metadata = zod.z.object({
|
|
2466
2471
|
accessibility_type: zod.z.string().describe("Accessibility type in the Latch access system."),
|
|
2467
2472
|
door_name: zod.z.string().describe("Name of the door in the Latch access system."),
|
|
@@ -2856,6 +2861,9 @@ var acs_entrance = zod.z.object({
|
|
|
2856
2861
|
latch_metadata: acs_entrance_latch_metadata.optional().describe(
|
|
2857
2862
|
"Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
2858
2863
|
),
|
|
2864
|
+
hotek_metadata: acs_entrance_hotek_metadata.optional().describe(
|
|
2865
|
+
"Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
2866
|
+
),
|
|
2859
2867
|
visionline_metadata: acs_entrance_visionline_metadata.optional().describe(
|
|
2860
2868
|
"Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
|
|
2861
2869
|
),
|
|
@@ -4323,7 +4331,10 @@ var access_method_deleted_event = access_method_event.extend({
|
|
|
4323
4331
|
An access method was deleted.
|
|
4324
4332
|
`);
|
|
4325
4333
|
var access_method_reissued_event = access_method_event.extend({
|
|
4326
|
-
event_type: zod.z.literal("access_method.reissued")
|
|
4334
|
+
event_type: zod.z.literal("access_method.reissued"),
|
|
4335
|
+
code: zod.z.string().optional().describe(
|
|
4336
|
+
"The actual PIN code for code access methods (only present when mode is 'code')."
|
|
4337
|
+
)
|
|
4327
4338
|
}).describe(`
|
|
4328
4339
|
---
|
|
4329
4340
|
route_path: /access_methods
|
|
@@ -8041,6 +8052,17 @@ var openapi_default = {
|
|
|
8041
8052
|
},
|
|
8042
8053
|
type: "array"
|
|
8043
8054
|
},
|
|
8055
|
+
hotek_metadata: {
|
|
8056
|
+
description: "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
8057
|
+
properties: {
|
|
8058
|
+
room_number: {
|
|
8059
|
+
description: "Room number of the entrance.",
|
|
8060
|
+
type: "string"
|
|
8061
|
+
}
|
|
8062
|
+
},
|
|
8063
|
+
required: ["room_number"],
|
|
8064
|
+
type: "object"
|
|
8065
|
+
},
|
|
8044
8066
|
latch_metadata: {
|
|
8045
8067
|
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
8046
8068
|
properties: {
|
|
@@ -17009,6 +17031,7 @@ var openapi_default = {
|
|
|
17009
17031
|
can_unlock_with_code: { type: "boolean" },
|
|
17010
17032
|
device_provider_name: {
|
|
17011
17033
|
enum: [
|
|
17034
|
+
"hotek",
|
|
17012
17035
|
"dormakaba_community",
|
|
17013
17036
|
"legic_connect",
|
|
17014
17037
|
"akuvox",
|
|
@@ -18787,6 +18810,10 @@ var openapi_default = {
|
|
|
18787
18810
|
format: "uuid",
|
|
18788
18811
|
type: "string"
|
|
18789
18812
|
},
|
|
18813
|
+
code: {
|
|
18814
|
+
description: "The actual PIN code for code access methods (only present when mode is 'code').",
|
|
18815
|
+
type: "string"
|
|
18816
|
+
},
|
|
18790
18817
|
created_at: {
|
|
18791
18818
|
description: "Date and time at which the event was created.",
|
|
18792
18819
|
format: "date-time",
|
|
@@ -23179,6 +23206,17 @@ var openapi_default = {
|
|
|
23179
23206
|
},
|
|
23180
23207
|
type: "array"
|
|
23181
23208
|
},
|
|
23209
|
+
hotek_metadata: {
|
|
23210
|
+
description: "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
23211
|
+
properties: {
|
|
23212
|
+
room_number: {
|
|
23213
|
+
description: "Room number of the entrance.",
|
|
23214
|
+
type: "string"
|
|
23215
|
+
}
|
|
23216
|
+
},
|
|
23217
|
+
required: ["room_number"],
|
|
23218
|
+
type: "object"
|
|
23219
|
+
},
|
|
23182
23220
|
latch_metadata: {
|
|
23183
23221
|
description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
|
|
23184
23222
|
properties: {
|
|
@@ -39461,6 +39499,7 @@ var openapi_default = {
|
|
|
39461
39499
|
description: "Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.",
|
|
39462
39500
|
items: {
|
|
39463
39501
|
enum: [
|
|
39502
|
+
"hotek",
|
|
39464
39503
|
"dormakaba_community",
|
|
39465
39504
|
"legic_connect",
|
|
39466
39505
|
"akuvox",
|