@seamapi/types 1.604.0 → 1.606.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 +424 -17
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +626 -95
- package/dist/index.cjs +424 -17
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +19 -19
- package/lib/seam/connect/models/acs/metadata/hotek.d.ts +9 -9
- package/lib/seam/connect/models/acs/metadata/hotek.js +3 -2
- package/lib/seam/connect/models/acs/metadata/hotek.js.map +1 -1
- package/lib/seam/connect/models/acs/metadata/visionline.d.ts +2 -2
- package/lib/seam/connect/models/batch.d.ts +135 -135
- package/lib/seam/connect/models/customer/customer-data.d.ts +34 -0
- package/lib/seam/connect/models/customer/customer-data.js +5 -1
- package/lib/seam/connect/models/customer/customer-data.js.map +1 -1
- package/lib/seam/connect/models/customer/user-identity-resources.d.ts +39 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js +15 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -1
- package/lib/seam/connect/models/phones/phone-session.d.ts +78 -78
- package/lib/seam/connect/openapi.d.ts +415 -8
- package/lib/seam/connect/openapi.js +374 -14
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +142 -40
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/acs/metadata/hotek.ts +3 -2
- package/src/lib/seam/connect/models/customer/customer-data.ts +5 -0
- package/src/lib/seam/connect/models/customer/user-identity-resources.ts +18 -0
- package/src/lib/seam/connect/openapi.ts +396 -14
- package/src/lib/seam/connect/route-types.ts +150 -40
- package/src/lib/seam/connect/schemas.ts +1 -0
|
@@ -13000,11 +13000,11 @@ export type Routes = {
|
|
|
13000
13000
|
hotek_metadata?:
|
|
13001
13001
|
| {
|
|
13002
13002
|
/** Room number of the entrance. */
|
|
13003
|
-
room_number
|
|
13003
|
+
room_number?: string | undefined
|
|
13004
13004
|
/** Display name of the entrance. */
|
|
13005
|
-
|
|
13006
|
-
/**
|
|
13007
|
-
|
|
13005
|
+
common_area_number?: string | undefined
|
|
13006
|
+
/** Display name of the entrance. */
|
|
13007
|
+
common_area_name?: string | undefined
|
|
13008
13008
|
}
|
|
13009
13009
|
| undefined
|
|
13010
13010
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -17112,11 +17112,11 @@ export type Routes = {
|
|
|
17112
17112
|
hotek_metadata?:
|
|
17113
17113
|
| {
|
|
17114
17114
|
/** Room number of the entrance. */
|
|
17115
|
-
room_number
|
|
17115
|
+
room_number?: string | undefined
|
|
17116
|
+
/** Display name of the entrance. */
|
|
17117
|
+
common_area_number?: string | undefined
|
|
17116
17118
|
/** Display name of the entrance. */
|
|
17117
|
-
|
|
17118
|
-
/** Type of door. */
|
|
17119
|
-
door_type: 'common_area' | 'guest'
|
|
17119
|
+
common_area_name?: string | undefined
|
|
17120
17120
|
}
|
|
17121
17121
|
| undefined
|
|
17122
17122
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -24246,11 +24246,11 @@ export type Routes = {
|
|
|
24246
24246
|
hotek_metadata?:
|
|
24247
24247
|
| {
|
|
24248
24248
|
/** Room number of the entrance. */
|
|
24249
|
-
room_number
|
|
24249
|
+
room_number?: string | undefined
|
|
24250
24250
|
/** Display name of the entrance. */
|
|
24251
|
-
|
|
24252
|
-
/**
|
|
24253
|
-
|
|
24251
|
+
common_area_number?: string | undefined
|
|
24252
|
+
/** Display name of the entrance. */
|
|
24253
|
+
common_area_name?: string | undefined
|
|
24254
24254
|
}
|
|
24255
24255
|
| undefined
|
|
24256
24256
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -25856,11 +25856,11 @@ export type Routes = {
|
|
|
25856
25856
|
hotek_metadata?:
|
|
25857
25857
|
| {
|
|
25858
25858
|
/** Room number of the entrance. */
|
|
25859
|
-
room_number
|
|
25859
|
+
room_number?: string | undefined
|
|
25860
25860
|
/** Display name of the entrance. */
|
|
25861
|
-
|
|
25862
|
-
/**
|
|
25863
|
-
|
|
25861
|
+
common_area_number?: string | undefined
|
|
25862
|
+
/** Display name of the entrance. */
|
|
25863
|
+
common_area_name?: string | undefined
|
|
25864
25864
|
}
|
|
25865
25865
|
| undefined
|
|
25866
25866
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -29860,11 +29860,11 @@ export type Routes = {
|
|
|
29860
29860
|
hotek_metadata?:
|
|
29861
29861
|
| {
|
|
29862
29862
|
/** Room number of the entrance. */
|
|
29863
|
-
room_number
|
|
29863
|
+
room_number?: string | undefined
|
|
29864
29864
|
/** Display name of the entrance. */
|
|
29865
|
-
|
|
29866
|
-
/**
|
|
29867
|
-
|
|
29865
|
+
common_area_number?: string | undefined
|
|
29866
|
+
/** Display name of the entrance. */
|
|
29867
|
+
common_area_name?: string | undefined
|
|
29868
29868
|
}
|
|
29869
29869
|
| undefined
|
|
29870
29870
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -30054,11 +30054,11 @@ export type Routes = {
|
|
|
30054
30054
|
hotek_metadata?:
|
|
30055
30055
|
| {
|
|
30056
30056
|
/** Room number of the entrance. */
|
|
30057
|
-
room_number
|
|
30057
|
+
room_number?: string | undefined
|
|
30058
30058
|
/** Display name of the entrance. */
|
|
30059
|
-
|
|
30060
|
-
/**
|
|
30061
|
-
|
|
30059
|
+
common_area_number?: string | undefined
|
|
30060
|
+
/** Display name of the entrance. */
|
|
30061
|
+
common_area_name?: string | undefined
|
|
30062
30062
|
}
|
|
30063
30063
|
| undefined
|
|
30064
30064
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -30895,6 +30895,44 @@ export type Routes = {
|
|
|
30895
30895
|
}[]
|
|
30896
30896
|
}
|
|
30897
30897
|
}
|
|
30898
|
+
'/acs/systems/report_devices': {
|
|
30899
|
+
route: '/acs/systems/report_devices'
|
|
30900
|
+
method: 'POST'
|
|
30901
|
+
queryParams: {}
|
|
30902
|
+
jsonBody: {}
|
|
30903
|
+
commonParams: {
|
|
30904
|
+
/** ID of the ACS system to report resources for */
|
|
30905
|
+
acs_system_id: string
|
|
30906
|
+
/** Array of ACS encoders to report */
|
|
30907
|
+
acs_encoders?:
|
|
30908
|
+
| {
|
|
30909
|
+
/** Whether the encoder is removed */
|
|
30910
|
+
is_removed?: boolean | undefined
|
|
30911
|
+
hotek_metadata: {
|
|
30912
|
+
/** The encoder number determined by the USB port connection. */
|
|
30913
|
+
encoder_number: string
|
|
30914
|
+
}
|
|
30915
|
+
}[]
|
|
30916
|
+
| undefined
|
|
30917
|
+
/** Array of ACS entrances to report */
|
|
30918
|
+
acs_entrances?:
|
|
30919
|
+
| {
|
|
30920
|
+
/** Whether the entrance is removed */
|
|
30921
|
+
is_removed?: boolean | undefined
|
|
30922
|
+
/** Hotek-specific metadata associated with the entrance. */
|
|
30923
|
+
hotek_metadata: {
|
|
30924
|
+
/** The room number identifier */
|
|
30925
|
+
room_number?: string | undefined
|
|
30926
|
+
/** The common area name */
|
|
30927
|
+
common_area_name?: string | undefined
|
|
30928
|
+
common_area_number?: string | undefined
|
|
30929
|
+
}
|
|
30930
|
+
}[]
|
|
30931
|
+
| undefined
|
|
30932
|
+
}
|
|
30933
|
+
formData: {}
|
|
30934
|
+
jsonResponse: {}
|
|
30935
|
+
}
|
|
30898
30936
|
'/acs/users/add_to_access_group': {
|
|
30899
30937
|
route: '/acs/users/add_to_access_group'
|
|
30900
30938
|
method: 'PUT' | 'POST'
|
|
@@ -31798,11 +31836,11 @@ export type Routes = {
|
|
|
31798
31836
|
hotek_metadata?:
|
|
31799
31837
|
| {
|
|
31800
31838
|
/** Room number of the entrance. */
|
|
31801
|
-
room_number
|
|
31839
|
+
room_number?: string | undefined
|
|
31802
31840
|
/** Display name of the entrance. */
|
|
31803
|
-
|
|
31804
|
-
/**
|
|
31805
|
-
|
|
31841
|
+
common_area_number?: string | undefined
|
|
31842
|
+
/** Display name of the entrance. */
|
|
31843
|
+
common_area_name?: string | undefined
|
|
31806
31844
|
}
|
|
31807
31845
|
| undefined
|
|
31808
31846
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -36928,6 +36966,21 @@ export type Routes = {
|
|
|
36928
36966
|
user_identity_key: string
|
|
36929
36967
|
}[]
|
|
36930
36968
|
| undefined
|
|
36969
|
+
/** List of staff members. */
|
|
36970
|
+
staff_members?:
|
|
36971
|
+
| {
|
|
36972
|
+
/** Your display name for this user identity resource. */
|
|
36973
|
+
name: string
|
|
36974
|
+
/** Email address associated with the user identity. */
|
|
36975
|
+
email_address?: string | undefined
|
|
36976
|
+
/** Phone number associated with the user identity. */
|
|
36977
|
+
phone_number?: string | undefined
|
|
36978
|
+
/** Your unique identifier for the staff. */
|
|
36979
|
+
staff_member_key: string
|
|
36980
|
+
/** List of unique identifiers for the sites the staff member is associated with. */
|
|
36981
|
+
site_keys: string[]
|
|
36982
|
+
}[]
|
|
36983
|
+
| undefined
|
|
36931
36984
|
/** List of reservations. */
|
|
36932
36985
|
reservations?:
|
|
36933
36986
|
| {
|
|
@@ -37290,6 +37343,21 @@ export type Routes = {
|
|
|
37290
37343
|
user_identity_key: string
|
|
37291
37344
|
}[]
|
|
37292
37345
|
| undefined
|
|
37346
|
+
/** List of staff members. */
|
|
37347
|
+
staff_members?:
|
|
37348
|
+
| {
|
|
37349
|
+
/** Your display name for this user identity resource. */
|
|
37350
|
+
name: string
|
|
37351
|
+
/** Email address associated with the user identity. */
|
|
37352
|
+
email_address?: string | undefined
|
|
37353
|
+
/** Phone number associated with the user identity. */
|
|
37354
|
+
phone_number?: string | undefined
|
|
37355
|
+
/** Your unique identifier for the staff. */
|
|
37356
|
+
staff_member_key: string
|
|
37357
|
+
/** List of unique identifiers for the sites the staff member is associated with. */
|
|
37358
|
+
site_keys: string[]
|
|
37359
|
+
}[]
|
|
37360
|
+
| undefined
|
|
37293
37361
|
/** List of reservations. */
|
|
37294
37362
|
reservations?:
|
|
37295
37363
|
| {
|
|
@@ -70439,6 +70507,48 @@ export type Routes = {
|
|
|
70439
70507
|
}[]
|
|
70440
70508
|
}
|
|
70441
70509
|
}
|
|
70510
|
+
'/seam/customer/v1/staff_members/list': {
|
|
70511
|
+
route: '/seam/customer/v1/staff_members/list'
|
|
70512
|
+
method: 'GET' | 'POST'
|
|
70513
|
+
queryParams: {}
|
|
70514
|
+
jsonBody: {}
|
|
70515
|
+
commonParams: {
|
|
70516
|
+
/** Filter staff members by space key. */
|
|
70517
|
+
space_key?: string | undefined
|
|
70518
|
+
/** Filter staff members by space ID (UUID). */
|
|
70519
|
+
space_id?: string | undefined
|
|
70520
|
+
/** Maximum number of records to return per page. */
|
|
70521
|
+
limit?: number
|
|
70522
|
+
/** Timestamp by which to limit returned staff members. Returns staff members created before this timestamp. */
|
|
70523
|
+
created_before?: Date | undefined
|
|
70524
|
+
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
70525
|
+
page_cursor?: ((string | undefined) | null) | undefined
|
|
70526
|
+
}
|
|
70527
|
+
formData: {}
|
|
70528
|
+
jsonResponse: {
|
|
70529
|
+
staff_members: {
|
|
70530
|
+
/** Your display name for this user identity resource. */
|
|
70531
|
+
name: string
|
|
70532
|
+
/** Email address associated with the user identity. */
|
|
70533
|
+
email_address?: string | undefined
|
|
70534
|
+
/** Phone number associated with the user identity. */
|
|
70535
|
+
phone_number?: string | undefined
|
|
70536
|
+
/** Your unique identifier for the staff. */
|
|
70537
|
+
staff_member_key: string
|
|
70538
|
+
/** List of unique identifiers for the sites the staff member is associated with. */
|
|
70539
|
+
site_keys: string[]
|
|
70540
|
+
}[]
|
|
70541
|
+
/** Information about the current page of results. */
|
|
70542
|
+
pagination: {
|
|
70543
|
+
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
70544
|
+
next_page_cursor: string | null
|
|
70545
|
+
/** Indicates whether there is another page of results after this one. */
|
|
70546
|
+
has_next_page: boolean
|
|
70547
|
+
/** URL to get the next page of results. */
|
|
70548
|
+
next_page_url: string | null
|
|
70549
|
+
}
|
|
70550
|
+
}
|
|
70551
|
+
}
|
|
70442
70552
|
'/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
|
|
70443
70553
|
route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]'
|
|
70444
70554
|
method: 'POST'
|
|
@@ -70952,11 +71062,11 @@ export type Routes = {
|
|
|
70952
71062
|
hotek_metadata?:
|
|
70953
71063
|
| {
|
|
70954
71064
|
/** Room number of the entrance. */
|
|
70955
|
-
room_number
|
|
71065
|
+
room_number?: string | undefined
|
|
71066
|
+
/** Display name of the entrance. */
|
|
71067
|
+
common_area_number?: string | undefined
|
|
70956
71068
|
/** Display name of the entrance. */
|
|
70957
|
-
|
|
70958
|
-
/** Type of door. */
|
|
70959
|
-
door_type: 'common_area' | 'guest'
|
|
71069
|
+
common_area_name?: string | undefined
|
|
70960
71070
|
}
|
|
70961
71071
|
| undefined
|
|
70962
71072
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -72921,11 +73031,11 @@ export type Routes = {
|
|
|
72921
73031
|
hotek_metadata?:
|
|
72922
73032
|
| {
|
|
72923
73033
|
/** Room number of the entrance. */
|
|
72924
|
-
room_number
|
|
73034
|
+
room_number?: string | undefined
|
|
72925
73035
|
/** Display name of the entrance. */
|
|
72926
|
-
|
|
72927
|
-
/**
|
|
72928
|
-
|
|
73036
|
+
common_area_number?: string | undefined
|
|
73037
|
+
/** Display name of the entrance. */
|
|
73038
|
+
common_area_name?: string | undefined
|
|
72929
73039
|
}
|
|
72930
73040
|
| undefined
|
|
72931
73041
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
@@ -98093,11 +98203,11 @@ export type Routes = {
|
|
|
98093
98203
|
hotek_metadata?:
|
|
98094
98204
|
| {
|
|
98095
98205
|
/** Room number of the entrance. */
|
|
98096
|
-
room_number
|
|
98206
|
+
room_number?: string | undefined
|
|
98207
|
+
/** Display name of the entrance. */
|
|
98208
|
+
common_area_number?: string | undefined
|
|
98097
98209
|
/** Display name of the entrance. */
|
|
98098
|
-
|
|
98099
|
-
/** Type of door. */
|
|
98100
|
-
door_type: 'common_area' | 'guest'
|
|
98210
|
+
common_area_name?: string | undefined
|
|
98101
98211
|
}
|
|
98102
98212
|
| undefined
|
|
98103
98213
|
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|