@seamapi/types 1.750.0 → 1.752.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 +126 -53
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2351 -962
- package/dist/index.cjs +126 -53
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.d.ts +42 -42
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.d.ts +37 -37
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js +9 -9
- package/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -0
- package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +63 -58
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
- package/lib/seam/connect/openapi.d.ts +84 -0
- package/lib/seam/connect/openapi.js +112 -42
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1606 -309
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-access-groups/pending-mutations.ts +14 -14
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +122 -48
- package/src/lib/seam/connect/route-types.ts +1754 -254
|
@@ -11918,6 +11918,8 @@ export type Routes = {
|
|
|
11918
11918
|
can_unlock_with_code?: boolean | undefined;
|
|
11919
11919
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
11920
11920
|
can_belong_to_reservation?: boolean | undefined;
|
|
11921
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
11922
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
11921
11923
|
}[] | undefined;
|
|
11922
11924
|
connected_accounts?: {
|
|
11923
11925
|
/** ID of the connected account. */
|
|
@@ -12284,6 +12286,13 @@ export type Routes = {
|
|
|
12284
12286
|
message: string;
|
|
12285
12287
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
12286
12288
|
mutation_code: 'deleting';
|
|
12289
|
+
} | {
|
|
12290
|
+
/** Date and time at which the mutation was created. */
|
|
12291
|
+
created_at: string;
|
|
12292
|
+
/** Detailed description of the mutation. */
|
|
12293
|
+
message: string;
|
|
12294
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
12295
|
+
mutation_code: 'deferring_deletion';
|
|
12287
12296
|
} | {
|
|
12288
12297
|
/** Date and time at which the mutation was created. */
|
|
12289
12298
|
created_at: string;
|
|
@@ -12367,13 +12376,6 @@ export type Routes = {
|
|
|
12367
12376
|
acs_user_id: string;
|
|
12368
12377
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
12369
12378
|
variant: 'adding' | 'removing';
|
|
12370
|
-
} | {
|
|
12371
|
-
/** Date and time at which the mutation was created. */
|
|
12372
|
-
created_at: string;
|
|
12373
|
-
/** Detailed description of the mutation. */
|
|
12374
|
-
message: string;
|
|
12375
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
12376
|
-
mutation_code: 'deferring_deletion';
|
|
12377
12379
|
})[];
|
|
12378
12380
|
is_managed: true;
|
|
12379
12381
|
}[] | undefined;
|
|
@@ -16129,6 +16131,8 @@ export type Routes = {
|
|
|
16129
16131
|
can_unlock_with_code?: boolean | undefined;
|
|
16130
16132
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
16131
16133
|
can_belong_to_reservation?: boolean | undefined;
|
|
16134
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
16135
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
16132
16136
|
}[] | undefined;
|
|
16133
16137
|
access_grants?: {
|
|
16134
16138
|
/** ID of the Seam workspace associated with the Access Grant. */
|
|
@@ -17059,6 +17063,13 @@ export type Routes = {
|
|
|
17059
17063
|
message: string;
|
|
17060
17064
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
17061
17065
|
mutation_code: 'deleting';
|
|
17066
|
+
} | {
|
|
17067
|
+
/** Date and time at which the mutation was created. */
|
|
17068
|
+
created_at: string;
|
|
17069
|
+
/** Detailed description of the mutation. */
|
|
17070
|
+
message: string;
|
|
17071
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
17072
|
+
mutation_code: 'deferring_deletion';
|
|
17062
17073
|
} | {
|
|
17063
17074
|
/** Date and time at which the mutation was created. */
|
|
17064
17075
|
created_at: string;
|
|
@@ -17142,13 +17153,6 @@ export type Routes = {
|
|
|
17142
17153
|
acs_user_id: string;
|
|
17143
17154
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
17144
17155
|
variant: 'adding' | 'removing';
|
|
17145
|
-
} | {
|
|
17146
|
-
/** Date and time at which the mutation was created. */
|
|
17147
|
-
created_at: string;
|
|
17148
|
-
/** Detailed description of the mutation. */
|
|
17149
|
-
message: string;
|
|
17150
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
17151
|
-
mutation_code: 'deferring_deletion';
|
|
17152
17156
|
})[];
|
|
17153
17157
|
is_managed: true;
|
|
17154
17158
|
};
|
|
@@ -17234,6 +17238,13 @@ export type Routes = {
|
|
|
17234
17238
|
message: string;
|
|
17235
17239
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
17236
17240
|
mutation_code: 'deleting';
|
|
17241
|
+
} | {
|
|
17242
|
+
/** Date and time at which the mutation was created. */
|
|
17243
|
+
created_at: string;
|
|
17244
|
+
/** Detailed description of the mutation. */
|
|
17245
|
+
message: string;
|
|
17246
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
17247
|
+
mutation_code: 'deferring_deletion';
|
|
17237
17248
|
} | {
|
|
17238
17249
|
/** Date and time at which the mutation was created. */
|
|
17239
17250
|
created_at: string;
|
|
@@ -17317,13 +17328,6 @@ export type Routes = {
|
|
|
17317
17328
|
acs_user_id: string;
|
|
17318
17329
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
17319
17330
|
variant: 'adding' | 'removing';
|
|
17320
|
-
} | {
|
|
17321
|
-
/** Date and time at which the mutation was created. */
|
|
17322
|
-
created_at: string;
|
|
17323
|
-
/** Detailed description of the mutation. */
|
|
17324
|
-
message: string;
|
|
17325
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
17326
|
-
mutation_code: 'deferring_deletion';
|
|
17327
17331
|
})[];
|
|
17328
17332
|
is_managed: true;
|
|
17329
17333
|
}[];
|
|
@@ -17469,6 +17473,8 @@ export type Routes = {
|
|
|
17469
17473
|
can_unlock_with_code?: boolean | undefined;
|
|
17470
17474
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
17471
17475
|
can_belong_to_reservation?: boolean | undefined;
|
|
17476
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
17477
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
17472
17478
|
}[];
|
|
17473
17479
|
};
|
|
17474
17480
|
maxDuration: undefined;
|
|
@@ -17813,6 +17819,13 @@ export type Routes = {
|
|
|
17813
17819
|
message: string;
|
|
17814
17820
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
17815
17821
|
mutation_code: 'deleting';
|
|
17822
|
+
} | {
|
|
17823
|
+
/** Date and time at which the mutation was created. */
|
|
17824
|
+
created_at: string;
|
|
17825
|
+
/** Detailed description of the mutation. */
|
|
17826
|
+
message: string;
|
|
17827
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
17828
|
+
mutation_code: 'deferring_deletion';
|
|
17816
17829
|
} | {
|
|
17817
17830
|
/** Date and time at which the mutation was created. */
|
|
17818
17831
|
created_at: string;
|
|
@@ -17896,13 +17909,6 @@ export type Routes = {
|
|
|
17896
17909
|
acs_user_id: string;
|
|
17897
17910
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
17898
17911
|
variant: 'adding' | 'removing';
|
|
17899
|
-
} | {
|
|
17900
|
-
/** Date and time at which the mutation was created. */
|
|
17901
|
-
created_at: string;
|
|
17902
|
-
/** Detailed description of the mutation. */
|
|
17903
|
-
message: string;
|
|
17904
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
17905
|
-
mutation_code: 'deferring_deletion';
|
|
17906
17912
|
})[];
|
|
17907
17913
|
is_managed: false;
|
|
17908
17914
|
};
|
|
@@ -17986,6 +17992,13 @@ export type Routes = {
|
|
|
17986
17992
|
message: string;
|
|
17987
17993
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
17988
17994
|
mutation_code: 'deleting';
|
|
17995
|
+
} | {
|
|
17996
|
+
/** Date and time at which the mutation was created. */
|
|
17997
|
+
created_at: string;
|
|
17998
|
+
/** Detailed description of the mutation. */
|
|
17999
|
+
message: string;
|
|
18000
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
18001
|
+
mutation_code: 'deferring_deletion';
|
|
17989
18002
|
} | {
|
|
17990
18003
|
/** Date and time at which the mutation was created. */
|
|
17991
18004
|
created_at: string;
|
|
@@ -18069,13 +18082,6 @@ export type Routes = {
|
|
|
18069
18082
|
acs_user_id: string;
|
|
18070
18083
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
18071
18084
|
variant: 'adding' | 'removing';
|
|
18072
|
-
} | {
|
|
18073
|
-
/** Date and time at which the mutation was created. */
|
|
18074
|
-
created_at: string;
|
|
18075
|
-
/** Detailed description of the mutation. */
|
|
18076
|
-
message: string;
|
|
18077
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
18078
|
-
mutation_code: 'deferring_deletion';
|
|
18079
18085
|
})[];
|
|
18080
18086
|
is_managed: false;
|
|
18081
18087
|
}[];
|
|
@@ -19127,6 +19133,8 @@ export type Routes = {
|
|
|
19127
19133
|
can_unlock_with_code?: boolean | undefined;
|
|
19128
19134
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
19129
19135
|
can_belong_to_reservation?: boolean | undefined;
|
|
19136
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
19137
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
19130
19138
|
}[];
|
|
19131
19139
|
};
|
|
19132
19140
|
maxDuration: undefined;
|
|
@@ -22631,6 +22639,8 @@ export type Routes = {
|
|
|
22631
22639
|
can_unlock_with_code?: boolean | undefined;
|
|
22632
22640
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
22633
22641
|
can_belong_to_reservation?: boolean | undefined;
|
|
22642
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
22643
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
22634
22644
|
};
|
|
22635
22645
|
};
|
|
22636
22646
|
maxDuration: undefined;
|
|
@@ -22701,272 +22711,1551 @@ export type Routes = {
|
|
|
22701
22711
|
error_code: string;
|
|
22702
22712
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22703
22713
|
message: string;
|
|
22704
|
-
}[];
|
|
22705
|
-
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22706
|
-
latch_metadata?: {
|
|
22707
|
-
/** Accessibility type in the Latch access system. */
|
|
22708
|
-
accessibility_type: string;
|
|
22709
|
-
/** Name of the door in the Latch access system. */
|
|
22710
|
-
door_name: string;
|
|
22711
|
-
/** Type of the door in the Latch access system. */
|
|
22712
|
-
door_type: string;
|
|
22713
|
-
/** Indicates whether the entrance is connected. */
|
|
22714
|
-
is_connected: boolean;
|
|
22715
|
-
} | undefined;
|
|
22716
|
-
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22717
|
-
hotek_metadata?: {
|
|
22718
|
-
/** Room number of the entrance. */
|
|
22719
|
-
room_number?: string | undefined;
|
|
22720
|
-
/** Display name of the entrance. */
|
|
22721
|
-
common_area_number?: string | undefined;
|
|
22722
|
-
/** Display name of the entrance. */
|
|
22723
|
-
common_area_name?: string | undefined;
|
|
22724
|
-
} | undefined;
|
|
22725
|
-
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22726
|
-
visionline_metadata?: {
|
|
22727
|
-
/** Name of the door in the Visionline access system. */
|
|
22728
|
-
door_name: string;
|
|
22729
|
-
/** Category of the door in the Visionline access system. */
|
|
22730
|
-
door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
|
|
22731
|
-
/** Profile for the door in the Visionline access system. */
|
|
22732
|
-
profiles?: {
|
|
22733
|
-
/** Door profile ID in the Visionline access system. */
|
|
22734
|
-
visionline_door_profile_id: string;
|
|
22735
|
-
/** Door profile type in the Visionline access system. */
|
|
22736
|
-
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
|
|
22737
|
-
}[] | undefined;
|
|
22738
|
-
} | undefined;
|
|
22739
|
-
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22740
|
-
salto_ks_metadata?: {
|
|
22741
|
-
/** Name of the door in the Salto KS access system. */
|
|
22742
|
-
door_name: string;
|
|
22743
|
-
/** Locked state of the door in the Salto KS access system. */
|
|
22744
|
-
locked_state: string;
|
|
22745
|
-
/** Type of the lock in the Salto KS access system. */
|
|
22746
|
-
lock_type: string;
|
|
22747
|
-
/** Indicates whether the door access device is online. */
|
|
22748
|
-
online?: boolean | undefined;
|
|
22749
|
-
/** Battery level of the door access device. */
|
|
22750
|
-
battery_level: string;
|
|
22751
|
-
/** Indicates whether the door is left open. */
|
|
22752
|
-
left_open_alarm?: boolean | undefined;
|
|
22753
|
-
/** Indicates whether an intrusion alarm is active on the door. */
|
|
22754
|
-
intrusion_alarm?: boolean | undefined;
|
|
22755
|
-
/** Indicates whether privacy mode is enabled for the lock. */
|
|
22756
|
-
privacy_mode?: boolean | undefined;
|
|
22757
|
-
} | undefined;
|
|
22758
|
-
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22759
|
-
dormakaba_community_metadata?: {
|
|
22760
|
-
/** Type of access point profile in the dormakaba Community access system. */
|
|
22761
|
-
access_point_profile: string;
|
|
22762
|
-
} | undefined;
|
|
22763
|
-
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22764
|
-
assa_abloy_vostio_metadata?: {
|
|
22765
|
-
/** Type of the door in the Vostio access system. */
|
|
22766
|
-
door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
|
|
22767
|
-
/** Name of the door in the Vostio access system. */
|
|
22768
|
-
door_name: string;
|
|
22769
|
-
/** Number of the door in the Vostio access system. */
|
|
22770
|
-
door_number?: number | undefined;
|
|
22771
|
-
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
22772
|
-
stand_open?: boolean | undefined;
|
|
22773
|
-
/** PMS ID of the door in the Vostio access system. */
|
|
22774
|
-
pms_id?: string | undefined;
|
|
22775
|
-
} | undefined;
|
|
22776
|
-
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22777
|
-
salto_space_metadata?: {
|
|
22778
|
-
/** Door ID in the Salto Space access system. */
|
|
22779
|
-
door_id?: string | undefined;
|
|
22780
|
-
/** Name of the door in the Salto Space access system. */
|
|
22781
|
-
door_name?: string | undefined;
|
|
22782
|
-
/** Description of the door in the Salto Space access system. */
|
|
22783
|
-
door_description?: string | undefined;
|
|
22784
|
-
/** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
|
|
22785
|
-
audit_on_keys?: boolean | undefined;
|
|
22786
|
-
/** Name of the room in the Salto Space access system. */
|
|
22787
|
-
room_name?: string | undefined;
|
|
22788
|
-
/** Description of the room in the Salto Space access system. */
|
|
22789
|
-
room_description?: string | undefined;
|
|
22790
|
-
} | undefined;
|
|
22791
|
-
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22792
|
-
dormakaba_ambiance_metadata?: {
|
|
22793
|
-
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
22794
|
-
access_point_name: string;
|
|
22795
|
-
} | undefined;
|
|
22796
|
-
/** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22797
|
-
brivo_metadata?: {
|
|
22798
|
-
/** ID of the access point in the Brivo access system. */
|
|
22799
|
-
access_point_id: string;
|
|
22800
|
-
/** ID of the site that the access point belongs to. */
|
|
22801
|
-
site_id: number;
|
|
22802
|
-
/** Name of the site that the access point belongs to. */
|
|
22803
|
-
site_name: string;
|
|
22804
|
-
} | undefined;
|
|
22805
|
-
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
22806
|
-
can_unlock_with_mobile_key?: boolean | undefined;
|
|
22807
|
-
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
22808
|
-
can_unlock_with_card?: boolean | undefined;
|
|
22809
|
-
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
22810
|
-
can_unlock_with_code?: boolean | undefined;
|
|
22811
|
-
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
22812
|
-
can_belong_to_reservation?: boolean | undefined;
|
|
22813
|
-
|
|
22814
|
-
|
|
22815
|
-
|
|
22816
|
-
|
|
22817
|
-
|
|
22818
|
-
/**
|
|
22819
|
-
|
|
22820
|
-
/**
|
|
22821
|
-
|
|
22822
|
-
|
|
22823
|
-
|
|
22824
|
-
|
|
22825
|
-
|
|
22826
|
-
|
|
22827
|
-
|
|
22828
|
-
|
|
22829
|
-
|
|
22830
|
-
|
|
22831
|
-
|
|
22832
|
-
|
|
22833
|
-
|
|
22834
|
-
/**
|
|
22835
|
-
|
|
22836
|
-
|
|
22837
|
-
|
|
22838
|
-
|
|
22839
|
-
|
|
22840
|
-
|
|
22841
|
-
|
|
22842
|
-
/** ID of the [
|
|
22843
|
-
|
|
22844
|
-
/** ID of the [user
|
|
22845
|
-
|
|
22846
|
-
/** ID of the [
|
|
22847
|
-
|
|
22848
|
-
|
|
22849
|
-
|
|
22850
|
-
|
|
22851
|
-
/** ID of the
|
|
22852
|
-
|
|
22853
|
-
/**
|
|
22854
|
-
|
|
22855
|
-
/**
|
|
22856
|
-
|
|
22857
|
-
/**
|
|
22858
|
-
|
|
22859
|
-
/**
|
|
22860
|
-
|
|
22861
|
-
/**
|
|
22862
|
-
|
|
22863
|
-
/**
|
|
22864
|
-
|
|
22865
|
-
/**
|
|
22866
|
-
|
|
22867
|
-
/**
|
|
22868
|
-
|
|
22869
|
-
/**
|
|
22870
|
-
|
|
22871
|
-
/**
|
|
22872
|
-
|
|
22873
|
-
/**
|
|
22874
|
-
|
|
22875
|
-
/**
|
|
22876
|
-
|
|
22877
|
-
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity
|
|
22878
|
-
|
|
22879
|
-
/**
|
|
22880
|
-
|
|
22881
|
-
|
|
22882
|
-
|
|
22883
|
-
|
|
22884
|
-
|
|
22885
|
-
|
|
22886
|
-
|
|
22887
|
-
|
|
22888
|
-
/**
|
|
22714
|
+
}[];
|
|
22715
|
+
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22716
|
+
latch_metadata?: {
|
|
22717
|
+
/** Accessibility type in the Latch access system. */
|
|
22718
|
+
accessibility_type: string;
|
|
22719
|
+
/** Name of the door in the Latch access system. */
|
|
22720
|
+
door_name: string;
|
|
22721
|
+
/** Type of the door in the Latch access system. */
|
|
22722
|
+
door_type: string;
|
|
22723
|
+
/** Indicates whether the entrance is connected. */
|
|
22724
|
+
is_connected: boolean;
|
|
22725
|
+
} | undefined;
|
|
22726
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22727
|
+
hotek_metadata?: {
|
|
22728
|
+
/** Room number of the entrance. */
|
|
22729
|
+
room_number?: string | undefined;
|
|
22730
|
+
/** Display name of the entrance. */
|
|
22731
|
+
common_area_number?: string | undefined;
|
|
22732
|
+
/** Display name of the entrance. */
|
|
22733
|
+
common_area_name?: string | undefined;
|
|
22734
|
+
} | undefined;
|
|
22735
|
+
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22736
|
+
visionline_metadata?: {
|
|
22737
|
+
/** Name of the door in the Visionline access system. */
|
|
22738
|
+
door_name: string;
|
|
22739
|
+
/** Category of the door in the Visionline access system. */
|
|
22740
|
+
door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
|
|
22741
|
+
/** Profile for the door in the Visionline access system. */
|
|
22742
|
+
profiles?: {
|
|
22743
|
+
/** Door profile ID in the Visionline access system. */
|
|
22744
|
+
visionline_door_profile_id: string;
|
|
22745
|
+
/** Door profile type in the Visionline access system. */
|
|
22746
|
+
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
|
|
22747
|
+
}[] | undefined;
|
|
22748
|
+
} | undefined;
|
|
22749
|
+
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22750
|
+
salto_ks_metadata?: {
|
|
22751
|
+
/** Name of the door in the Salto KS access system. */
|
|
22752
|
+
door_name: string;
|
|
22753
|
+
/** Locked state of the door in the Salto KS access system. */
|
|
22754
|
+
locked_state: string;
|
|
22755
|
+
/** Type of the lock in the Salto KS access system. */
|
|
22756
|
+
lock_type: string;
|
|
22757
|
+
/** Indicates whether the door access device is online. */
|
|
22758
|
+
online?: boolean | undefined;
|
|
22759
|
+
/** Battery level of the door access device. */
|
|
22760
|
+
battery_level: string;
|
|
22761
|
+
/** Indicates whether the door is left open. */
|
|
22762
|
+
left_open_alarm?: boolean | undefined;
|
|
22763
|
+
/** Indicates whether an intrusion alarm is active on the door. */
|
|
22764
|
+
intrusion_alarm?: boolean | undefined;
|
|
22765
|
+
/** Indicates whether privacy mode is enabled for the lock. */
|
|
22766
|
+
privacy_mode?: boolean | undefined;
|
|
22767
|
+
} | undefined;
|
|
22768
|
+
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22769
|
+
dormakaba_community_metadata?: {
|
|
22770
|
+
/** Type of access point profile in the dormakaba Community access system. */
|
|
22771
|
+
access_point_profile: string;
|
|
22772
|
+
} | undefined;
|
|
22773
|
+
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22774
|
+
assa_abloy_vostio_metadata?: {
|
|
22775
|
+
/** Type of the door in the Vostio access system. */
|
|
22776
|
+
door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
|
|
22777
|
+
/** Name of the door in the Vostio access system. */
|
|
22778
|
+
door_name: string;
|
|
22779
|
+
/** Number of the door in the Vostio access system. */
|
|
22780
|
+
door_number?: number | undefined;
|
|
22781
|
+
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
22782
|
+
stand_open?: boolean | undefined;
|
|
22783
|
+
/** PMS ID of the door in the Vostio access system. */
|
|
22784
|
+
pms_id?: string | undefined;
|
|
22785
|
+
} | undefined;
|
|
22786
|
+
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22787
|
+
salto_space_metadata?: {
|
|
22788
|
+
/** Door ID in the Salto Space access system. */
|
|
22789
|
+
door_id?: string | undefined;
|
|
22790
|
+
/** Name of the door in the Salto Space access system. */
|
|
22791
|
+
door_name?: string | undefined;
|
|
22792
|
+
/** Description of the door in the Salto Space access system. */
|
|
22793
|
+
door_description?: string | undefined;
|
|
22794
|
+
/** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
|
|
22795
|
+
audit_on_keys?: boolean | undefined;
|
|
22796
|
+
/** Name of the room in the Salto Space access system. */
|
|
22797
|
+
room_name?: string | undefined;
|
|
22798
|
+
/** Description of the room in the Salto Space access system. */
|
|
22799
|
+
room_description?: string | undefined;
|
|
22800
|
+
} | undefined;
|
|
22801
|
+
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22802
|
+
dormakaba_ambiance_metadata?: {
|
|
22803
|
+
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
22804
|
+
access_point_name: string;
|
|
22805
|
+
} | undefined;
|
|
22806
|
+
/** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
22807
|
+
brivo_metadata?: {
|
|
22808
|
+
/** ID of the access point in the Brivo access system. */
|
|
22809
|
+
access_point_id: string;
|
|
22810
|
+
/** ID of the site that the access point belongs to. */
|
|
22811
|
+
site_id: number;
|
|
22812
|
+
/** Name of the site that the access point belongs to. */
|
|
22813
|
+
site_name: string;
|
|
22814
|
+
} | undefined;
|
|
22815
|
+
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
22816
|
+
can_unlock_with_mobile_key?: boolean | undefined;
|
|
22817
|
+
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
22818
|
+
can_unlock_with_card?: boolean | undefined;
|
|
22819
|
+
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
22820
|
+
can_unlock_with_code?: boolean | undefined;
|
|
22821
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
22822
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
22823
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
22824
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
22825
|
+
}[];
|
|
22826
|
+
/** Information about the current page of results. */
|
|
22827
|
+
pagination: {
|
|
22828
|
+
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
22829
|
+
next_page_cursor: string | null;
|
|
22830
|
+
/** Indicates whether there is another page of results after this one. */
|
|
22831
|
+
has_next_page: boolean;
|
|
22832
|
+
/** URL to get the next page of results. */
|
|
22833
|
+
next_page_url: string | null;
|
|
22834
|
+
};
|
|
22835
|
+
};
|
|
22836
|
+
maxDuration: undefined;
|
|
22837
|
+
};
|
|
22838
|
+
'/acs/entrances/list_credentials_with_access': {
|
|
22839
|
+
route: '/acs/entrances/list_credentials_with_access';
|
|
22840
|
+
method: 'GET' | 'POST';
|
|
22841
|
+
queryParams: {};
|
|
22842
|
+
jsonBody: {};
|
|
22843
|
+
commonParams: {
|
|
22844
|
+
/** ID of the entrance for which you want to list all credentials that grant access. */
|
|
22845
|
+
acs_entrance_id: string;
|
|
22846
|
+
/** Conditions that credentials must meet to be included in the returned list. */
|
|
22847
|
+
include_if?: 'visionline_metadata.is_valid'[] | undefined;
|
|
22848
|
+
};
|
|
22849
|
+
formData: {};
|
|
22850
|
+
jsonResponse: {
|
|
22851
|
+
acs_credentials: {
|
|
22852
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22853
|
+
acs_credential_id: string;
|
|
22854
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
22855
|
+
acs_user_id?: string | undefined;
|
|
22856
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
22857
|
+
user_identity_id?: string | undefined;
|
|
22858
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
22859
|
+
connected_account_id: string;
|
|
22860
|
+
acs_credential_pool_id?: string | undefined;
|
|
22861
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22862
|
+
acs_system_id: string;
|
|
22863
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22864
|
+
parent_acs_credential_id?: string | undefined;
|
|
22865
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
22866
|
+
display_name: string;
|
|
22867
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22868
|
+
code?: (string | undefined) | null;
|
|
22869
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
22870
|
+
is_one_time_use?: boolean | undefined;
|
|
22871
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22872
|
+
card_number?: (string | undefined) | null;
|
|
22873
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
22874
|
+
is_issued?: boolean | undefined;
|
|
22875
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
22876
|
+
issued_at?: (string | undefined) | null;
|
|
22877
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
22878
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
22879
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
22880
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
|
|
22881
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
22882
|
+
external_type_display_name?: string | undefined;
|
|
22883
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
22884
|
+
created_at: string;
|
|
22885
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22886
|
+
workspace_id: string;
|
|
22887
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
22888
|
+
starts_at?: string | undefined;
|
|
22889
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
22890
|
+
ends_at?: string | undefined;
|
|
22891
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22892
|
+
errors: {
|
|
22893
|
+
error_code: string;
|
|
22894
|
+
message: string;
|
|
22895
|
+
}[];
|
|
22896
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22897
|
+
warnings: ({
|
|
22898
|
+
/** Date and time at which Seam created the warning. */
|
|
22899
|
+
created_at: string;
|
|
22900
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22901
|
+
message: string;
|
|
22902
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22903
|
+
warning_code: 'waiting_to_be_issued';
|
|
22904
|
+
} | {
|
|
22905
|
+
/** Date and time at which Seam created the warning. */
|
|
22906
|
+
created_at: string;
|
|
22907
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22908
|
+
message: string;
|
|
22909
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22910
|
+
warning_code: 'schedule_externally_modified';
|
|
22911
|
+
} | {
|
|
22912
|
+
/** Date and time at which Seam created the warning. */
|
|
22913
|
+
created_at: string;
|
|
22914
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22915
|
+
message: string;
|
|
22916
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22917
|
+
warning_code: 'schedule_modified';
|
|
22918
|
+
} | {
|
|
22919
|
+
/** Date and time at which Seam created the warning. */
|
|
22920
|
+
created_at: string;
|
|
22921
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22922
|
+
message: string;
|
|
22923
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22924
|
+
warning_code: 'being_deleted';
|
|
22925
|
+
} | {
|
|
22926
|
+
/** Date and time at which Seam created the warning. */
|
|
22927
|
+
created_at: string;
|
|
22928
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22929
|
+
message: string;
|
|
22930
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22931
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
22932
|
+
} | {
|
|
22933
|
+
/** Date and time at which Seam created the warning. */
|
|
22934
|
+
created_at: string;
|
|
22935
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
22936
|
+
message: string;
|
|
22937
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
22938
|
+
warning_code: 'needs_to_be_reissued';
|
|
22939
|
+
})[];
|
|
22940
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
22941
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
22942
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
22943
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
22944
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
22945
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
22946
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22947
|
+
visionline_metadata?: {
|
|
22948
|
+
/** Card function type in the Visionline access system. */
|
|
22949
|
+
card_function_type: 'guest' | 'staff';
|
|
22950
|
+
/** IDs of the credentials to which you want to join. */
|
|
22951
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
22952
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
22953
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
22954
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
22955
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
22956
|
+
/** Indicates whether the credential is valid. */
|
|
22957
|
+
is_valid?: boolean | undefined;
|
|
22958
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
22959
|
+
auto_join?: boolean | undefined;
|
|
22960
|
+
/** ID of the card in the Visionline access system. */
|
|
22961
|
+
card_id?: string | undefined;
|
|
22962
|
+
/** ID of the credential in the Visionline access system. */
|
|
22963
|
+
credential_id?: string | undefined;
|
|
22964
|
+
} | undefined;
|
|
22965
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22966
|
+
assa_abloy_vostio_metadata?: {
|
|
22967
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
22968
|
+
auto_join?: boolean | undefined;
|
|
22969
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
22970
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
22971
|
+
/** Key ID in the Vostio access system. */
|
|
22972
|
+
key_id?: string | undefined;
|
|
22973
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
22974
|
+
key_issuing_request_id?: string | undefined;
|
|
22975
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
22976
|
+
door_names?: string[] | undefined;
|
|
22977
|
+
/** Endpoint ID in the Vostio access system. */
|
|
22978
|
+
endpoint_id?: string | undefined;
|
|
22979
|
+
} | undefined;
|
|
22980
|
+
is_managed: true;
|
|
22981
|
+
}[];
|
|
22982
|
+
};
|
|
22983
|
+
maxDuration: undefined;
|
|
22984
|
+
};
|
|
22985
|
+
'/acs/entrances/unlock': {
|
|
22986
|
+
route: '/acs/entrances/unlock';
|
|
22987
|
+
method: 'POST';
|
|
22988
|
+
queryParams: {};
|
|
22989
|
+
jsonBody: {};
|
|
22990
|
+
commonParams: {
|
|
22991
|
+
/** ID of the entrance to unlock. */
|
|
22992
|
+
acs_entrance_id: string;
|
|
22993
|
+
/** ID of the cloud_key credential to use for the unlock operation. */
|
|
22994
|
+
acs_credential_id: string;
|
|
22995
|
+
};
|
|
22996
|
+
formData: {};
|
|
22997
|
+
jsonResponse: {
|
|
22998
|
+
/** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
|
|
22999
|
+
|
|
23000
|
+
When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
|
|
23001
|
+
|
|
23002
|
+
See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
|
|
23003
|
+
action_attempt: {
|
|
23004
|
+
/** ID of the action attempt. */
|
|
23005
|
+
action_attempt_id: string;
|
|
23006
|
+
status: 'pending';
|
|
23007
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23008
|
+
result: null;
|
|
23009
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23010
|
+
error: null;
|
|
23011
|
+
/** Action attempt to track the status of locking a door. */
|
|
23012
|
+
action_type: 'LOCK_DOOR';
|
|
23013
|
+
} | {
|
|
23014
|
+
/** ID of the action attempt. */
|
|
23015
|
+
action_attempt_id: string;
|
|
23016
|
+
status: 'success';
|
|
23017
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23018
|
+
error: null;
|
|
23019
|
+
/** Action attempt to track the status of locking a door. */
|
|
23020
|
+
action_type: 'LOCK_DOOR';
|
|
23021
|
+
/** Result of the action. */
|
|
23022
|
+
result: {
|
|
23023
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
23024
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
23025
|
+
};
|
|
23026
|
+
} | {
|
|
23027
|
+
/** ID of the action attempt. */
|
|
23028
|
+
action_attempt_id: string;
|
|
23029
|
+
status: 'error';
|
|
23030
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23031
|
+
result: null;
|
|
23032
|
+
/** Action attempt to track the status of locking a door. */
|
|
23033
|
+
action_type: 'LOCK_DOOR';
|
|
23034
|
+
/** Error associated with the action. */
|
|
23035
|
+
error: {
|
|
23036
|
+
/** Type of the error. */
|
|
23037
|
+
type: string;
|
|
23038
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23039
|
+
message: string;
|
|
23040
|
+
};
|
|
23041
|
+
} | {
|
|
23042
|
+
/** ID of the action attempt. */
|
|
23043
|
+
action_attempt_id: string;
|
|
23044
|
+
status: 'pending';
|
|
23045
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23046
|
+
result: null;
|
|
23047
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23048
|
+
error: null;
|
|
23049
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
23050
|
+
action_type: 'UNLOCK_DOOR';
|
|
23051
|
+
} | {
|
|
23052
|
+
/** ID of the action attempt. */
|
|
23053
|
+
action_attempt_id: string;
|
|
23054
|
+
status: 'success';
|
|
23055
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23056
|
+
error: null;
|
|
23057
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
23058
|
+
action_type: 'UNLOCK_DOOR';
|
|
23059
|
+
/** Result of the action. */
|
|
23060
|
+
result: {
|
|
23061
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
23062
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
23063
|
+
};
|
|
23064
|
+
} | {
|
|
23065
|
+
/** ID of the action attempt. */
|
|
23066
|
+
action_attempt_id: string;
|
|
23067
|
+
status: 'error';
|
|
23068
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23069
|
+
result: null;
|
|
23070
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
23071
|
+
action_type: 'UNLOCK_DOOR';
|
|
23072
|
+
/** Error associated with the action. */
|
|
23073
|
+
error: {
|
|
23074
|
+
/** Type of the error. */
|
|
23075
|
+
type: string;
|
|
23076
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23077
|
+
message: string;
|
|
23078
|
+
};
|
|
23079
|
+
} | {
|
|
23080
|
+
/** ID of the action attempt. */
|
|
23081
|
+
action_attempt_id: string;
|
|
23082
|
+
status: 'pending';
|
|
23083
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23084
|
+
result: null;
|
|
23085
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23086
|
+
error: null;
|
|
23087
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
23088
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
23089
|
+
} | {
|
|
23090
|
+
/** ID of the action attempt. */
|
|
23091
|
+
action_attempt_id: string;
|
|
23092
|
+
status: 'success';
|
|
23093
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23094
|
+
error: null;
|
|
23095
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
23096
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
23097
|
+
/** Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings. */
|
|
23098
|
+
result: {
|
|
23099
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
23100
|
+
acs_credential_on_encoder: {
|
|
23101
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
23102
|
+
created_at: string | null;
|
|
23103
|
+
is_issued: boolean | null;
|
|
23104
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
23105
|
+
starts_at: string | null;
|
|
23106
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
23107
|
+
ends_at: string | null;
|
|
23108
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23109
|
+
card_number: string | null;
|
|
23110
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23111
|
+
visionline_metadata?: {
|
|
23112
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23113
|
+
card_id: string;
|
|
23114
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
23115
|
+
cancelled: boolean;
|
|
23116
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
23117
|
+
discarded: boolean;
|
|
23118
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
23119
|
+
expired: boolean;
|
|
23120
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
23121
|
+
overwritten: boolean;
|
|
23122
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
23123
|
+
overridden?: boolean | undefined;
|
|
23124
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
23125
|
+
pending_auto_update: boolean;
|
|
23126
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23127
|
+
card_format: 'TLCode' | 'rfid48';
|
|
23128
|
+
/** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23129
|
+
card_holder?: string | undefined;
|
|
23130
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23131
|
+
number_of_issued_cards: number;
|
|
23132
|
+
/** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23133
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
23134
|
+
/** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23135
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
23136
|
+
} | undefined;
|
|
23137
|
+
} | null;
|
|
23138
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
23139
|
+
acs_credential_on_seam: ({
|
|
23140
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23141
|
+
acs_credential_id: string;
|
|
23142
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23143
|
+
acs_user_id?: string | undefined;
|
|
23144
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23145
|
+
user_identity_id?: string | undefined;
|
|
23146
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23147
|
+
connected_account_id: string;
|
|
23148
|
+
acs_credential_pool_id?: string | undefined;
|
|
23149
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23150
|
+
acs_system_id: string;
|
|
23151
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23152
|
+
parent_acs_credential_id?: string | undefined;
|
|
23153
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23154
|
+
display_name: string;
|
|
23155
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23156
|
+
code?: (string | undefined) | null;
|
|
23157
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
23158
|
+
is_one_time_use?: boolean | undefined;
|
|
23159
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23160
|
+
card_number?: (string | undefined) | null;
|
|
23161
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
23162
|
+
is_issued?: boolean | undefined;
|
|
23163
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
23164
|
+
issued_at?: (string | undefined) | null;
|
|
23165
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
23166
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
23167
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
23168
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
|
|
23169
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23170
|
+
external_type_display_name?: string | undefined;
|
|
23171
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
23172
|
+
created_at: string;
|
|
23173
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23174
|
+
workspace_id: string;
|
|
23175
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23176
|
+
starts_at?: string | undefined;
|
|
23177
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
23178
|
+
ends_at?: string | undefined;
|
|
23179
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23180
|
+
errors: {
|
|
23181
|
+
error_code: string;
|
|
23182
|
+
message: string;
|
|
23183
|
+
}[];
|
|
23184
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23185
|
+
warnings: ({
|
|
23186
|
+
/** Date and time at which Seam created the warning. */
|
|
23187
|
+
created_at: string;
|
|
23188
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23189
|
+
message: string;
|
|
23190
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23191
|
+
warning_code: 'waiting_to_be_issued';
|
|
23192
|
+
} | {
|
|
23193
|
+
/** Date and time at which Seam created the warning. */
|
|
23194
|
+
created_at: string;
|
|
23195
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23196
|
+
message: string;
|
|
23197
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23198
|
+
warning_code: 'schedule_externally_modified';
|
|
23199
|
+
} | {
|
|
23200
|
+
/** Date and time at which Seam created the warning. */
|
|
23201
|
+
created_at: string;
|
|
23202
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23203
|
+
message: string;
|
|
23204
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23205
|
+
warning_code: 'schedule_modified';
|
|
23206
|
+
} | {
|
|
23207
|
+
/** Date and time at which Seam created the warning. */
|
|
23208
|
+
created_at: string;
|
|
23209
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23210
|
+
message: string;
|
|
23211
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23212
|
+
warning_code: 'being_deleted';
|
|
23213
|
+
} | {
|
|
23214
|
+
/** Date and time at which Seam created the warning. */
|
|
23215
|
+
created_at: string;
|
|
23216
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23217
|
+
message: string;
|
|
23218
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23219
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
23220
|
+
} | {
|
|
23221
|
+
/** Date and time at which Seam created the warning. */
|
|
23222
|
+
created_at: string;
|
|
23223
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23224
|
+
message: string;
|
|
23225
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23226
|
+
warning_code: 'needs_to_be_reissued';
|
|
23227
|
+
})[];
|
|
23228
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23229
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
23230
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
23231
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
23232
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
23233
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
23234
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23235
|
+
visionline_metadata?: {
|
|
23236
|
+
/** Card function type in the Visionline access system. */
|
|
23237
|
+
card_function_type: 'guest' | 'staff';
|
|
23238
|
+
/** IDs of the credentials to which you want to join. */
|
|
23239
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
23240
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
23241
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
23242
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
23243
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
23244
|
+
/** Indicates whether the credential is valid. */
|
|
23245
|
+
is_valid?: boolean | undefined;
|
|
23246
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23247
|
+
auto_join?: boolean | undefined;
|
|
23248
|
+
/** ID of the card in the Visionline access system. */
|
|
23249
|
+
card_id?: string | undefined;
|
|
23250
|
+
/** ID of the credential in the Visionline access system. */
|
|
23251
|
+
credential_id?: string | undefined;
|
|
23252
|
+
} | undefined;
|
|
23253
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23254
|
+
assa_abloy_vostio_metadata?: {
|
|
23255
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23256
|
+
auto_join?: boolean | undefined;
|
|
23257
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
23258
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
23259
|
+
/** Key ID in the Vostio access system. */
|
|
23260
|
+
key_id?: string | undefined;
|
|
23261
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
23262
|
+
key_issuing_request_id?: string | undefined;
|
|
23263
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
23264
|
+
door_names?: string[] | undefined;
|
|
23265
|
+
/** Endpoint ID in the Vostio access system. */
|
|
23266
|
+
endpoint_id?: string | undefined;
|
|
23267
|
+
} | undefined;
|
|
23268
|
+
is_managed: true;
|
|
23269
|
+
} | {
|
|
23270
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23271
|
+
acs_credential_id: string;
|
|
23272
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23273
|
+
acs_user_id?: string | undefined;
|
|
23274
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23275
|
+
user_identity_id?: string | undefined;
|
|
23276
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23277
|
+
connected_account_id: string;
|
|
23278
|
+
acs_credential_pool_id?: string | undefined;
|
|
23279
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23280
|
+
acs_system_id: string;
|
|
23281
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23282
|
+
parent_acs_credential_id?: string | undefined;
|
|
23283
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23284
|
+
display_name: string;
|
|
23285
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23286
|
+
code?: (string | undefined) | null;
|
|
23287
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
23288
|
+
is_one_time_use?: boolean | undefined;
|
|
23289
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23290
|
+
card_number?: (string | undefined) | null;
|
|
23291
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
23292
|
+
is_issued?: boolean | undefined;
|
|
23293
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
23294
|
+
issued_at?: (string | undefined) | null;
|
|
23295
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
23296
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
23297
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
23298
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
|
|
23299
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23300
|
+
external_type_display_name?: string | undefined;
|
|
23301
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
23302
|
+
created_at: string;
|
|
23303
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23304
|
+
workspace_id: string;
|
|
23305
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23306
|
+
starts_at?: string | undefined;
|
|
23307
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
23308
|
+
ends_at?: string | undefined;
|
|
23309
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23310
|
+
errors: {
|
|
23311
|
+
error_code: string;
|
|
23312
|
+
message: string;
|
|
23313
|
+
}[];
|
|
23314
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23315
|
+
warnings: ({
|
|
23316
|
+
/** Date and time at which Seam created the warning. */
|
|
23317
|
+
created_at: string;
|
|
23318
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23319
|
+
message: string;
|
|
23320
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23321
|
+
warning_code: 'waiting_to_be_issued';
|
|
23322
|
+
} | {
|
|
23323
|
+
/** Date and time at which Seam created the warning. */
|
|
23324
|
+
created_at: string;
|
|
23325
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23326
|
+
message: string;
|
|
23327
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23328
|
+
warning_code: 'schedule_externally_modified';
|
|
23329
|
+
} | {
|
|
23330
|
+
/** Date and time at which Seam created the warning. */
|
|
23331
|
+
created_at: string;
|
|
23332
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23333
|
+
message: string;
|
|
23334
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23335
|
+
warning_code: 'schedule_modified';
|
|
23336
|
+
} | {
|
|
23337
|
+
/** Date and time at which Seam created the warning. */
|
|
23338
|
+
created_at: string;
|
|
23339
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23340
|
+
message: string;
|
|
23341
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23342
|
+
warning_code: 'being_deleted';
|
|
23343
|
+
} | {
|
|
23344
|
+
/** Date and time at which Seam created the warning. */
|
|
23345
|
+
created_at: string;
|
|
23346
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23347
|
+
message: string;
|
|
23348
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23349
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
23350
|
+
} | {
|
|
23351
|
+
/** Date and time at which Seam created the warning. */
|
|
23352
|
+
created_at: string;
|
|
23353
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23354
|
+
message: string;
|
|
23355
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23356
|
+
warning_code: 'needs_to_be_reissued';
|
|
23357
|
+
})[];
|
|
23358
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23359
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
23360
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
23361
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
23362
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
23363
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
23364
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23365
|
+
visionline_metadata?: {
|
|
23366
|
+
/** Card function type in the Visionline access system. */
|
|
23367
|
+
card_function_type: 'guest' | 'staff';
|
|
23368
|
+
/** IDs of the credentials to which you want to join. */
|
|
23369
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
23370
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
23371
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
23372
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
23373
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
23374
|
+
/** Indicates whether the credential is valid. */
|
|
23375
|
+
is_valid?: boolean | undefined;
|
|
23376
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23377
|
+
auto_join?: boolean | undefined;
|
|
23378
|
+
/** ID of the card in the Visionline access system. */
|
|
23379
|
+
card_id?: string | undefined;
|
|
23380
|
+
/** ID of the credential in the Visionline access system. */
|
|
23381
|
+
credential_id?: string | undefined;
|
|
23382
|
+
} | undefined;
|
|
23383
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23384
|
+
assa_abloy_vostio_metadata?: {
|
|
23385
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23386
|
+
auto_join?: boolean | undefined;
|
|
23387
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
23388
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
23389
|
+
/** Key ID in the Vostio access system. */
|
|
23390
|
+
key_id?: string | undefined;
|
|
23391
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
23392
|
+
key_issuing_request_id?: string | undefined;
|
|
23393
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
23394
|
+
door_names?: string[] | undefined;
|
|
23395
|
+
/** Endpoint ID in the Vostio access system. */
|
|
23396
|
+
endpoint_id?: string | undefined;
|
|
23397
|
+
} | undefined;
|
|
23398
|
+
is_managed: false;
|
|
23399
|
+
}) | null;
|
|
23400
|
+
/** Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system. */
|
|
23401
|
+
warnings: {
|
|
23402
|
+
/** Indicates a warning related to scanning a credential. */
|
|
23403
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
23404
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23405
|
+
warning_message: string;
|
|
23406
|
+
}[];
|
|
23407
|
+
};
|
|
23408
|
+
} | {
|
|
23409
|
+
/** ID of the action attempt. */
|
|
23410
|
+
action_attempt_id: string;
|
|
23411
|
+
status: 'error';
|
|
23412
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23413
|
+
result: null;
|
|
23414
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
23415
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
23416
|
+
error: {
|
|
23417
|
+
/** Type of the error associated with the action attempt. */
|
|
23418
|
+
type: 'uncategorized_error';
|
|
23419
|
+
/** Message for the error associated with the action attempt. */
|
|
23420
|
+
message: string;
|
|
23421
|
+
} | {
|
|
23422
|
+
/** Type of the error associated with the action attempt. */
|
|
23423
|
+
type: 'action_attempt_expired';
|
|
23424
|
+
/** Message for the error associated with the action attempt. */
|
|
23425
|
+
message: string;
|
|
23426
|
+
} | {
|
|
23427
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
23428
|
+
type: 'no_credential_on_encoder';
|
|
23429
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23430
|
+
message: string;
|
|
23431
|
+
} | {
|
|
23432
|
+
/** Error type to indicate that the encoder is not online. */
|
|
23433
|
+
type: 'encoder_not_online';
|
|
23434
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23435
|
+
message: string;
|
|
23436
|
+
};
|
|
23437
|
+
} | {
|
|
23438
|
+
/** ID of the action attempt. */
|
|
23439
|
+
action_attempt_id: string;
|
|
23440
|
+
status: 'pending';
|
|
23441
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23442
|
+
result: null;
|
|
23443
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23444
|
+
error: null;
|
|
23445
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
23446
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
23447
|
+
} | {
|
|
23448
|
+
/** ID of the action attempt. */
|
|
23449
|
+
action_attempt_id: string;
|
|
23450
|
+
status: 'success';
|
|
23451
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23452
|
+
error: null;
|
|
23453
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
23454
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
23455
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
23456
|
+
result: {
|
|
23457
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23458
|
+
acs_credential_id: string;
|
|
23459
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23460
|
+
acs_user_id?: string | undefined;
|
|
23461
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23462
|
+
user_identity_id?: string | undefined;
|
|
23463
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23464
|
+
connected_account_id: string;
|
|
23465
|
+
acs_credential_pool_id?: string | undefined;
|
|
23466
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23467
|
+
acs_system_id: string;
|
|
23468
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23469
|
+
parent_acs_credential_id?: string | undefined;
|
|
23470
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23471
|
+
display_name: string;
|
|
23472
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23473
|
+
code?: (string | undefined) | null;
|
|
23474
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
23475
|
+
is_one_time_use?: boolean | undefined;
|
|
23476
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23477
|
+
card_number?: (string | undefined) | null;
|
|
23478
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
23479
|
+
is_issued?: boolean | undefined;
|
|
23480
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
23481
|
+
issued_at?: (string | undefined) | null;
|
|
23482
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
23483
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
23484
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
23485
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
|
|
23486
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23487
|
+
external_type_display_name?: string | undefined;
|
|
23488
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
23489
|
+
created_at: string;
|
|
23490
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23491
|
+
workspace_id: string;
|
|
23492
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23493
|
+
starts_at?: string | undefined;
|
|
23494
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
23495
|
+
ends_at?: string | undefined;
|
|
23496
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23497
|
+
errors: {
|
|
23498
|
+
error_code: string;
|
|
23499
|
+
message: string;
|
|
23500
|
+
}[];
|
|
23501
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23502
|
+
warnings: ({
|
|
23503
|
+
/** Date and time at which Seam created the warning. */
|
|
23504
|
+
created_at: string;
|
|
23505
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23506
|
+
message: string;
|
|
23507
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23508
|
+
warning_code: 'waiting_to_be_issued';
|
|
23509
|
+
} | {
|
|
23510
|
+
/** Date and time at which Seam created the warning. */
|
|
23511
|
+
created_at: string;
|
|
23512
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23513
|
+
message: string;
|
|
23514
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23515
|
+
warning_code: 'schedule_externally_modified';
|
|
23516
|
+
} | {
|
|
23517
|
+
/** Date and time at which Seam created the warning. */
|
|
23518
|
+
created_at: string;
|
|
23519
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23520
|
+
message: string;
|
|
23521
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23522
|
+
warning_code: 'schedule_modified';
|
|
23523
|
+
} | {
|
|
23524
|
+
/** Date and time at which Seam created the warning. */
|
|
23525
|
+
created_at: string;
|
|
23526
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23527
|
+
message: string;
|
|
23528
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23529
|
+
warning_code: 'being_deleted';
|
|
23530
|
+
} | {
|
|
23531
|
+
/** Date and time at which Seam created the warning. */
|
|
23532
|
+
created_at: string;
|
|
23533
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23534
|
+
message: string;
|
|
23535
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23536
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
23537
|
+
} | {
|
|
23538
|
+
/** Date and time at which Seam created the warning. */
|
|
23539
|
+
created_at: string;
|
|
23540
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23541
|
+
message: string;
|
|
23542
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23543
|
+
warning_code: 'needs_to_be_reissued';
|
|
23544
|
+
})[];
|
|
23545
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23546
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
23547
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
23548
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
23549
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
23550
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
23551
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23552
|
+
visionline_metadata?: {
|
|
23553
|
+
/** Card function type in the Visionline access system. */
|
|
23554
|
+
card_function_type: 'guest' | 'staff';
|
|
23555
|
+
/** IDs of the credentials to which you want to join. */
|
|
23556
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
23557
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
23558
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
23559
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
23560
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
23561
|
+
/** Indicates whether the credential is valid. */
|
|
23562
|
+
is_valid?: boolean | undefined;
|
|
23563
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23564
|
+
auto_join?: boolean | undefined;
|
|
23565
|
+
/** ID of the card in the Visionline access system. */
|
|
23566
|
+
card_id?: string | undefined;
|
|
23567
|
+
/** ID of the credential in the Visionline access system. */
|
|
23568
|
+
credential_id?: string | undefined;
|
|
23569
|
+
} | undefined;
|
|
23570
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23571
|
+
assa_abloy_vostio_metadata?: {
|
|
23572
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23573
|
+
auto_join?: boolean | undefined;
|
|
23574
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
23575
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
23576
|
+
/** Key ID in the Vostio access system. */
|
|
23577
|
+
key_id?: string | undefined;
|
|
23578
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
23579
|
+
key_issuing_request_id?: string | undefined;
|
|
23580
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
23581
|
+
door_names?: string[] | undefined;
|
|
23582
|
+
/** Endpoint ID in the Vostio access system. */
|
|
23583
|
+
endpoint_id?: string | undefined;
|
|
23584
|
+
} | undefined;
|
|
23585
|
+
is_managed: true;
|
|
23586
|
+
} | {
|
|
23587
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23588
|
+
acs_credential_id: string;
|
|
23589
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23590
|
+
acs_user_id?: string | undefined;
|
|
23591
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23592
|
+
user_identity_id?: string | undefined;
|
|
23593
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
23594
|
+
connected_account_id: string;
|
|
23595
|
+
acs_credential_pool_id?: string | undefined;
|
|
23596
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23597
|
+
acs_system_id: string;
|
|
23598
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23599
|
+
parent_acs_credential_id?: string | undefined;
|
|
23600
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23601
|
+
display_name: string;
|
|
23602
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23603
|
+
code?: (string | undefined) | null;
|
|
23604
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
23605
|
+
is_one_time_use?: boolean | undefined;
|
|
23606
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23607
|
+
card_number?: (string | undefined) | null;
|
|
23608
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
23609
|
+
is_issued?: boolean | undefined;
|
|
23610
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
23611
|
+
issued_at?: (string | undefined) | null;
|
|
23612
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
23613
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
23614
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
23615
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
|
|
23616
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
23617
|
+
external_type_display_name?: string | undefined;
|
|
23618
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
23619
|
+
created_at: string;
|
|
23620
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23621
|
+
workspace_id: string;
|
|
23622
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
23623
|
+
starts_at?: string | undefined;
|
|
23624
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
23625
|
+
ends_at?: string | undefined;
|
|
23626
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23627
|
+
errors: {
|
|
23628
|
+
error_code: string;
|
|
23629
|
+
message: string;
|
|
23630
|
+
}[];
|
|
23631
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23632
|
+
warnings: ({
|
|
23633
|
+
/** Date and time at which Seam created the warning. */
|
|
23634
|
+
created_at: string;
|
|
23635
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23636
|
+
message: string;
|
|
23637
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23638
|
+
warning_code: 'waiting_to_be_issued';
|
|
23639
|
+
} | {
|
|
23640
|
+
/** Date and time at which Seam created the warning. */
|
|
23641
|
+
created_at: string;
|
|
23642
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23643
|
+
message: string;
|
|
23644
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23645
|
+
warning_code: 'schedule_externally_modified';
|
|
23646
|
+
} | {
|
|
23647
|
+
/** Date and time at which Seam created the warning. */
|
|
23648
|
+
created_at: string;
|
|
23649
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23650
|
+
message: string;
|
|
23651
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23652
|
+
warning_code: 'schedule_modified';
|
|
23653
|
+
} | {
|
|
23654
|
+
/** Date and time at which Seam created the warning. */
|
|
23655
|
+
created_at: string;
|
|
23656
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23657
|
+
message: string;
|
|
23658
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23659
|
+
warning_code: 'being_deleted';
|
|
23660
|
+
} | {
|
|
23661
|
+
/** Date and time at which Seam created the warning. */
|
|
23662
|
+
created_at: string;
|
|
23663
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23664
|
+
message: string;
|
|
23665
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23666
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
23667
|
+
} | {
|
|
23668
|
+
/** Date and time at which Seam created the warning. */
|
|
23669
|
+
created_at: string;
|
|
23670
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
23671
|
+
message: string;
|
|
23672
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
23673
|
+
warning_code: 'needs_to_be_reissued';
|
|
23674
|
+
})[];
|
|
23675
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
23676
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
23677
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
23678
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
23679
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
23680
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
23681
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23682
|
+
visionline_metadata?: {
|
|
23683
|
+
/** Card function type in the Visionline access system. */
|
|
23684
|
+
card_function_type: 'guest' | 'staff';
|
|
23685
|
+
/** IDs of the credentials to which you want to join. */
|
|
23686
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
23687
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
23688
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
23689
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
23690
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
23691
|
+
/** Indicates whether the credential is valid. */
|
|
23692
|
+
is_valid?: boolean | undefined;
|
|
23693
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23694
|
+
auto_join?: boolean | undefined;
|
|
23695
|
+
/** ID of the card in the Visionline access system. */
|
|
23696
|
+
card_id?: string | undefined;
|
|
23697
|
+
/** ID of the credential in the Visionline access system. */
|
|
23698
|
+
credential_id?: string | undefined;
|
|
23699
|
+
} | undefined;
|
|
23700
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
23701
|
+
assa_abloy_vostio_metadata?: {
|
|
23702
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
23703
|
+
auto_join?: boolean | undefined;
|
|
23704
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
23705
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
23706
|
+
/** Key ID in the Vostio access system. */
|
|
23707
|
+
key_id?: string | undefined;
|
|
23708
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
23709
|
+
key_issuing_request_id?: string | undefined;
|
|
23710
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
23711
|
+
door_names?: string[] | undefined;
|
|
23712
|
+
/** Endpoint ID in the Vostio access system. */
|
|
23713
|
+
endpoint_id?: string | undefined;
|
|
23714
|
+
} | undefined;
|
|
23715
|
+
is_managed: false;
|
|
23716
|
+
};
|
|
23717
|
+
} | {
|
|
23718
|
+
/** ID of the action attempt. */
|
|
23719
|
+
action_attempt_id: string;
|
|
23720
|
+
status: 'error';
|
|
23721
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23722
|
+
result: null;
|
|
23723
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
23724
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
23725
|
+
error: {
|
|
23726
|
+
/** Type of the error associated with the action attempt. */
|
|
23727
|
+
type: 'uncategorized_error';
|
|
23728
|
+
/** Message for the error associated with the action attempt. */
|
|
23729
|
+
message: string;
|
|
23730
|
+
} | {
|
|
23731
|
+
/** Type of the error associated with the action attempt. */
|
|
23732
|
+
type: 'action_attempt_expired';
|
|
23733
|
+
/** Message for the error associated with the action attempt. */
|
|
23734
|
+
message: string;
|
|
23735
|
+
} | {
|
|
23736
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
23737
|
+
type: 'no_credential_on_encoder';
|
|
23738
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23739
|
+
message: string;
|
|
23740
|
+
} | {
|
|
23741
|
+
/** Error type to indicate an incompatible card format. */
|
|
23742
|
+
type: 'incompatible_card_format';
|
|
23743
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23744
|
+
message: string;
|
|
23745
|
+
} | {
|
|
23746
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
23747
|
+
type: 'credential_cannot_be_reissued';
|
|
23748
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23749
|
+
message: string;
|
|
23750
|
+
} | {
|
|
23751
|
+
/** Error type to indicate that the encoder is not online. */
|
|
23752
|
+
type: 'encoder_not_online';
|
|
23753
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23754
|
+
message: string;
|
|
23755
|
+
};
|
|
23756
|
+
} | {
|
|
23757
|
+
/** ID of the action attempt. */
|
|
23758
|
+
action_attempt_id: string;
|
|
23759
|
+
status: 'pending';
|
|
23760
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23761
|
+
result: null;
|
|
23762
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23763
|
+
error: null;
|
|
23764
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
23765
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
23766
|
+
} | {
|
|
23767
|
+
/** ID of the action attempt. */
|
|
23768
|
+
action_attempt_id: string;
|
|
23769
|
+
status: 'success';
|
|
23770
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23771
|
+
error: null;
|
|
23772
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
23773
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
23774
|
+
/** Result of the action. */
|
|
23775
|
+
result: {};
|
|
23776
|
+
} | {
|
|
23777
|
+
/** ID of the action attempt. */
|
|
23778
|
+
action_attempt_id: string;
|
|
23779
|
+
status: 'error';
|
|
23780
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23781
|
+
result: null;
|
|
23782
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
23783
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
23784
|
+
/** Error associated with the action. */
|
|
23785
|
+
error: {
|
|
23786
|
+
/** Type of the error. */
|
|
23787
|
+
type: string;
|
|
23788
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23789
|
+
message: string;
|
|
23790
|
+
};
|
|
23791
|
+
} | {
|
|
23792
|
+
/** ID of the action attempt. */
|
|
23793
|
+
action_attempt_id: string;
|
|
23794
|
+
status: 'pending';
|
|
23795
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23796
|
+
result: null;
|
|
23797
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23798
|
+
error: null;
|
|
23799
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
23800
|
+
action_type: 'SET_FAN_MODE';
|
|
23801
|
+
} | {
|
|
23802
|
+
/** ID of the action attempt. */
|
|
23803
|
+
action_attempt_id: string;
|
|
23804
|
+
status: 'success';
|
|
23805
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23806
|
+
error: null;
|
|
23807
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
23808
|
+
action_type: 'SET_FAN_MODE';
|
|
23809
|
+
/** Result of the action. */
|
|
23810
|
+
result: {};
|
|
23811
|
+
} | {
|
|
23812
|
+
/** ID of the action attempt. */
|
|
23813
|
+
action_attempt_id: string;
|
|
23814
|
+
status: 'error';
|
|
23815
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23816
|
+
result: null;
|
|
23817
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
23818
|
+
action_type: 'SET_FAN_MODE';
|
|
23819
|
+
/** Error associated with the action. */
|
|
23820
|
+
error: {
|
|
23821
|
+
/** Type of the error. */
|
|
23822
|
+
type: string;
|
|
23823
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23824
|
+
message: string;
|
|
23825
|
+
};
|
|
23826
|
+
} | {
|
|
23827
|
+
/** ID of the action attempt. */
|
|
23828
|
+
action_attempt_id: string;
|
|
23829
|
+
status: 'pending';
|
|
23830
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23831
|
+
result: null;
|
|
23832
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23833
|
+
error: null;
|
|
23834
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
23835
|
+
action_type: 'SET_HVAC_MODE';
|
|
23836
|
+
} | {
|
|
23837
|
+
/** ID of the action attempt. */
|
|
23838
|
+
action_attempt_id: string;
|
|
23839
|
+
status: 'success';
|
|
23840
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23841
|
+
error: null;
|
|
23842
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
23843
|
+
action_type: 'SET_HVAC_MODE';
|
|
23844
|
+
/** Result of the action. */
|
|
23845
|
+
result: {};
|
|
23846
|
+
} | {
|
|
23847
|
+
/** ID of the action attempt. */
|
|
23848
|
+
action_attempt_id: string;
|
|
23849
|
+
status: 'error';
|
|
23850
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23851
|
+
result: null;
|
|
23852
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
23853
|
+
action_type: 'SET_HVAC_MODE';
|
|
23854
|
+
/** Error associated with the action. */
|
|
23855
|
+
error: {
|
|
23856
|
+
/** Type of the error. */
|
|
23857
|
+
type: string;
|
|
23858
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23859
|
+
message: string;
|
|
23860
|
+
};
|
|
23861
|
+
} | {
|
|
23862
|
+
/** ID of the action attempt. */
|
|
23863
|
+
action_attempt_id: string;
|
|
23864
|
+
status: 'pending';
|
|
23865
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23866
|
+
result: null;
|
|
23867
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23868
|
+
error: null;
|
|
23869
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
23870
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
23871
|
+
} | {
|
|
23872
|
+
/** ID of the action attempt. */
|
|
23873
|
+
action_attempt_id: string;
|
|
23874
|
+
status: 'success';
|
|
23875
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23876
|
+
error: null;
|
|
23877
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
23878
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
23879
|
+
/** Result of the action. */
|
|
23880
|
+
result: {};
|
|
23881
|
+
} | {
|
|
23882
|
+
/** ID of the action attempt. */
|
|
23883
|
+
action_attempt_id: string;
|
|
23884
|
+
status: 'error';
|
|
23885
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23886
|
+
result: null;
|
|
23887
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
23888
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
23889
|
+
/** Error associated with the action. */
|
|
23890
|
+
error: {
|
|
23891
|
+
/** Type of the error. */
|
|
23892
|
+
type: string;
|
|
23893
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23894
|
+
message: string;
|
|
23895
|
+
};
|
|
23896
|
+
} | {
|
|
23897
|
+
/** ID of the action attempt. */
|
|
23898
|
+
action_attempt_id: string;
|
|
23899
|
+
status: 'pending';
|
|
23900
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23901
|
+
result: null;
|
|
23902
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23903
|
+
error: null;
|
|
23904
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
23905
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
23906
|
+
} | {
|
|
23907
|
+
/** ID of the action attempt. */
|
|
23908
|
+
action_attempt_id: string;
|
|
23909
|
+
status: 'success';
|
|
23910
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23911
|
+
error: null;
|
|
23912
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
23913
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
23914
|
+
/** Result of the action. */
|
|
23915
|
+
result: {};
|
|
23916
|
+
} | {
|
|
23917
|
+
/** ID of the action attempt. */
|
|
23918
|
+
action_attempt_id: string;
|
|
23919
|
+
status: 'error';
|
|
23920
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23921
|
+
result: null;
|
|
23922
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
23923
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
23924
|
+
/** Error associated with the action. */
|
|
23925
|
+
error: {
|
|
23926
|
+
/** Type of the error. */
|
|
23927
|
+
type: string;
|
|
23928
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23929
|
+
message: string;
|
|
23930
|
+
};
|
|
23931
|
+
} | {
|
|
23932
|
+
/** ID of the action attempt. */
|
|
23933
|
+
action_attempt_id: string;
|
|
23934
|
+
status: 'pending';
|
|
23935
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23936
|
+
result: null;
|
|
23937
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23938
|
+
error: null;
|
|
23939
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
23940
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
23941
|
+
} | {
|
|
23942
|
+
/** ID of the action attempt. */
|
|
23943
|
+
action_attempt_id: string;
|
|
23944
|
+
status: 'success';
|
|
23945
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23946
|
+
error: null;
|
|
23947
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
23948
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
23949
|
+
/** Result of the action. */
|
|
23950
|
+
result: {};
|
|
23951
|
+
} | {
|
|
23952
|
+
/** ID of the action attempt. */
|
|
23953
|
+
action_attempt_id: string;
|
|
23954
|
+
status: 'error';
|
|
23955
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23956
|
+
result: null;
|
|
23957
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
23958
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
23959
|
+
/** Error associated with the action. */
|
|
23960
|
+
error: {
|
|
23961
|
+
/** Type of the error. */
|
|
23962
|
+
type: string;
|
|
23963
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23964
|
+
message: string;
|
|
23965
|
+
};
|
|
23966
|
+
} | {
|
|
23967
|
+
/** ID of the action attempt. */
|
|
23968
|
+
action_attempt_id: string;
|
|
23969
|
+
status: 'pending';
|
|
23970
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23971
|
+
result: null;
|
|
23972
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23973
|
+
error: null;
|
|
23974
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
23975
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
23976
|
+
} | {
|
|
23977
|
+
/** ID of the action attempt. */
|
|
23978
|
+
action_attempt_id: string;
|
|
23979
|
+
status: 'success';
|
|
23980
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23981
|
+
error: null;
|
|
23982
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
23983
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
23984
|
+
/** Result of the action. */
|
|
23985
|
+
result: {};
|
|
23986
|
+
} | {
|
|
23987
|
+
/** ID of the action attempt. */
|
|
23988
|
+
action_attempt_id: string;
|
|
23989
|
+
status: 'error';
|
|
23990
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23991
|
+
result: null;
|
|
23992
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
23993
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
23994
|
+
/** Error associated with the action. */
|
|
23995
|
+
error: {
|
|
23996
|
+
/** Type of the error. */
|
|
23997
|
+
type: string;
|
|
23998
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23999
|
+
message: string;
|
|
24000
|
+
};
|
|
24001
|
+
} | {
|
|
24002
|
+
/** ID of the action attempt. */
|
|
24003
|
+
action_attempt_id: string;
|
|
24004
|
+
status: 'pending';
|
|
24005
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24006
|
+
result: null;
|
|
24007
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24008
|
+
error: null;
|
|
24009
|
+
/** Syncing access codes is pending. */
|
|
24010
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
24011
|
+
} | {
|
|
24012
|
+
/** ID of the action attempt. */
|
|
24013
|
+
action_attempt_id: string;
|
|
24014
|
+
status: 'success';
|
|
24015
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24016
|
+
error: null;
|
|
24017
|
+
/** Syncing access codes succeeded. */
|
|
24018
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
24019
|
+
/** Result of the action. */
|
|
24020
|
+
result: {};
|
|
24021
|
+
} | {
|
|
24022
|
+
/** ID of the action attempt. */
|
|
24023
|
+
action_attempt_id: string;
|
|
24024
|
+
status: 'error';
|
|
24025
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24026
|
+
result: null;
|
|
24027
|
+
/** Syncing access codes failed. */
|
|
24028
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
24029
|
+
/** Error associated with the action. */
|
|
24030
|
+
error: {
|
|
24031
|
+
/** Type of the error. */
|
|
24032
|
+
type: string;
|
|
24033
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
24034
|
+
message: string;
|
|
24035
|
+
};
|
|
24036
|
+
} | {
|
|
24037
|
+
/** ID of the action attempt. */
|
|
24038
|
+
action_attempt_id: string;
|
|
24039
|
+
status: 'pending';
|
|
24040
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24041
|
+
result: null;
|
|
24042
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24043
|
+
error: null;
|
|
24044
|
+
/** Creating an access code is pending. */
|
|
24045
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
24046
|
+
} | {
|
|
24047
|
+
/** ID of the action attempt. */
|
|
24048
|
+
action_attempt_id: string;
|
|
24049
|
+
status: 'success';
|
|
24050
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24051
|
+
error: null;
|
|
24052
|
+
/** Creating an access code succeeded. */
|
|
24053
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
24054
|
+
/** Result of the action. */
|
|
24055
|
+
result: {
|
|
24056
|
+
/** Created access code. */
|
|
24057
|
+
access_code?: any;
|
|
24058
|
+
};
|
|
24059
|
+
} | {
|
|
24060
|
+
/** ID of the action attempt. */
|
|
24061
|
+
action_attempt_id: string;
|
|
24062
|
+
status: 'error';
|
|
24063
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24064
|
+
result: null;
|
|
24065
|
+
/** Creating an access code failed. */
|
|
24066
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
24067
|
+
/** Error associated with the action. */
|
|
24068
|
+
error: {
|
|
24069
|
+
/** Type of the error. */
|
|
24070
|
+
type: string;
|
|
24071
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22889
24072
|
message: string;
|
|
22890
|
-
|
|
22891
|
-
|
|
22892
|
-
|
|
22893
|
-
|
|
22894
|
-
|
|
22895
|
-
|
|
24073
|
+
};
|
|
24074
|
+
} | {
|
|
24075
|
+
/** ID of the action attempt. */
|
|
24076
|
+
action_attempt_id: string;
|
|
24077
|
+
status: 'pending';
|
|
24078
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24079
|
+
result: null;
|
|
24080
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24081
|
+
error: null;
|
|
24082
|
+
/** Deleting an access code is pending. */
|
|
24083
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
24084
|
+
} | {
|
|
24085
|
+
/** ID of the action attempt. */
|
|
24086
|
+
action_attempt_id: string;
|
|
24087
|
+
status: 'success';
|
|
24088
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24089
|
+
error: null;
|
|
24090
|
+
/** Deleting an access code succeeded. */
|
|
24091
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
24092
|
+
/** Result of the action. */
|
|
24093
|
+
result: {};
|
|
24094
|
+
} | {
|
|
24095
|
+
/** ID of the action attempt. */
|
|
24096
|
+
action_attempt_id: string;
|
|
24097
|
+
status: 'error';
|
|
24098
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24099
|
+
result: null;
|
|
24100
|
+
/** Deleting an access code failed. */
|
|
24101
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
24102
|
+
/** Error associated with the action. */
|
|
24103
|
+
error: {
|
|
24104
|
+
/** Type of the error. */
|
|
24105
|
+
type: string;
|
|
24106
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22896
24107
|
message: string;
|
|
22897
|
-
|
|
22898
|
-
|
|
22899
|
-
|
|
22900
|
-
|
|
22901
|
-
|
|
22902
|
-
|
|
24108
|
+
};
|
|
24109
|
+
} | {
|
|
24110
|
+
/** ID of the action attempt. */
|
|
24111
|
+
action_attempt_id: string;
|
|
24112
|
+
status: 'pending';
|
|
24113
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24114
|
+
result: null;
|
|
24115
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24116
|
+
error: null;
|
|
24117
|
+
/** Updating an access code is pending. */
|
|
24118
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
24119
|
+
} | {
|
|
24120
|
+
/** ID of the action attempt. */
|
|
24121
|
+
action_attempt_id: string;
|
|
24122
|
+
status: 'success';
|
|
24123
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24124
|
+
error: null;
|
|
24125
|
+
/** Updating an access code succeeded. */
|
|
24126
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
24127
|
+
/** Result of the action. */
|
|
24128
|
+
result: {
|
|
24129
|
+
/** Updated access code. */
|
|
24130
|
+
access_code?: any;
|
|
24131
|
+
};
|
|
24132
|
+
} | {
|
|
24133
|
+
/** ID of the action attempt. */
|
|
24134
|
+
action_attempt_id: string;
|
|
24135
|
+
status: 'error';
|
|
24136
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24137
|
+
result: null;
|
|
24138
|
+
/** Updating an access code failed. */
|
|
24139
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
24140
|
+
/** Error associated with the action. */
|
|
24141
|
+
error: {
|
|
24142
|
+
/** Type of the error. */
|
|
24143
|
+
type: string;
|
|
24144
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22903
24145
|
message: string;
|
|
22904
|
-
|
|
22905
|
-
|
|
22906
|
-
|
|
22907
|
-
|
|
22908
|
-
|
|
22909
|
-
|
|
24146
|
+
};
|
|
24147
|
+
} | {
|
|
24148
|
+
/** ID of the action attempt. */
|
|
24149
|
+
action_attempt_id: string;
|
|
24150
|
+
status: 'pending';
|
|
24151
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24152
|
+
result: null;
|
|
24153
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24154
|
+
error: null;
|
|
24155
|
+
/** Creating a noise threshold is pending. */
|
|
24156
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
24157
|
+
} | {
|
|
24158
|
+
/** ID of the action attempt. */
|
|
24159
|
+
action_attempt_id: string;
|
|
24160
|
+
status: 'success';
|
|
24161
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24162
|
+
error: null;
|
|
24163
|
+
/** Creating a noise threshold succeeded. */
|
|
24164
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
24165
|
+
/** Result of the action. */
|
|
24166
|
+
result: {
|
|
24167
|
+
/** Created noise threshold. */
|
|
24168
|
+
noise_threshold?: any;
|
|
24169
|
+
};
|
|
24170
|
+
} | {
|
|
24171
|
+
/** ID of the action attempt. */
|
|
24172
|
+
action_attempt_id: string;
|
|
24173
|
+
status: 'error';
|
|
24174
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24175
|
+
result: null;
|
|
24176
|
+
/** Creating a noise threshold failed. */
|
|
24177
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
24178
|
+
/** Error associated with the action. */
|
|
24179
|
+
error: {
|
|
24180
|
+
/** Type of the error. */
|
|
24181
|
+
type: string;
|
|
24182
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22910
24183
|
message: string;
|
|
22911
|
-
|
|
22912
|
-
|
|
22913
|
-
|
|
22914
|
-
|
|
22915
|
-
|
|
22916
|
-
|
|
24184
|
+
};
|
|
24185
|
+
} | {
|
|
24186
|
+
/** ID of the action attempt. */
|
|
24187
|
+
action_attempt_id: string;
|
|
24188
|
+
status: 'pending';
|
|
24189
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24190
|
+
result: null;
|
|
24191
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24192
|
+
error: null;
|
|
24193
|
+
/** Deleting a noise threshold is pending. */
|
|
24194
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
24195
|
+
} | {
|
|
24196
|
+
/** ID of the action attempt. */
|
|
24197
|
+
action_attempt_id: string;
|
|
24198
|
+
status: 'success';
|
|
24199
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24200
|
+
error: null;
|
|
24201
|
+
/** Deleting a noise threshold succeeded. */
|
|
24202
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
24203
|
+
/** Result of the action. */
|
|
24204
|
+
result: {};
|
|
24205
|
+
} | {
|
|
24206
|
+
/** ID of the action attempt. */
|
|
24207
|
+
action_attempt_id: string;
|
|
24208
|
+
status: 'error';
|
|
24209
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24210
|
+
result: null;
|
|
24211
|
+
/** Deleting a noise threshold failed. */
|
|
24212
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
24213
|
+
/** Error associated with the action. */
|
|
24214
|
+
error: {
|
|
24215
|
+
/** Type of the error. */
|
|
24216
|
+
type: string;
|
|
24217
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22917
24218
|
message: string;
|
|
22918
|
-
|
|
22919
|
-
|
|
22920
|
-
|
|
22921
|
-
|
|
22922
|
-
|
|
22923
|
-
|
|
24219
|
+
};
|
|
24220
|
+
} | {
|
|
24221
|
+
/** ID of the action attempt. */
|
|
24222
|
+
action_attempt_id: string;
|
|
24223
|
+
status: 'pending';
|
|
24224
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24225
|
+
result: null;
|
|
24226
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24227
|
+
error: null;
|
|
24228
|
+
/** Updating a noise threshold is pending. */
|
|
24229
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
24230
|
+
} | {
|
|
24231
|
+
/** ID of the action attempt. */
|
|
24232
|
+
action_attempt_id: string;
|
|
24233
|
+
status: 'success';
|
|
24234
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24235
|
+
error: null;
|
|
24236
|
+
/** Updating a noise threshold succeeded. */
|
|
24237
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
24238
|
+
/** Result of the action. */
|
|
24239
|
+
result: {
|
|
24240
|
+
/** Updated noise threshold. */
|
|
24241
|
+
noise_threshold?: any;
|
|
24242
|
+
};
|
|
24243
|
+
} | {
|
|
24244
|
+
/** ID of the action attempt. */
|
|
24245
|
+
action_attempt_id: string;
|
|
24246
|
+
status: 'error';
|
|
24247
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24248
|
+
result: null;
|
|
24249
|
+
/** Updating a noise threshold failed. */
|
|
24250
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
24251
|
+
/** Error associated with the action. */
|
|
24252
|
+
error: {
|
|
24253
|
+
/** Type of the error. */
|
|
24254
|
+
type: string;
|
|
24255
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22924
24256
|
message: string;
|
|
22925
|
-
|
|
22926
|
-
|
|
22927
|
-
})[];
|
|
22928
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
22929
|
-
is_multi_phone_sync_credential?: boolean | undefined;
|
|
22930
|
-
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
22931
|
-
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
22932
|
-
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
22933
|
-
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
22934
|
-
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22935
|
-
visionline_metadata?: {
|
|
22936
|
-
/** Card function type in the Visionline access system. */
|
|
22937
|
-
card_function_type: 'guest' | 'staff';
|
|
22938
|
-
/** IDs of the credentials to which you want to join. */
|
|
22939
|
-
joiner_acs_credential_ids?: string[] | undefined;
|
|
22940
|
-
/** Guest entrance IDs in the Visionline access system. */
|
|
22941
|
-
guest_acs_entrance_ids?: string[] | undefined;
|
|
22942
|
-
/** Common entrance IDs in the Visionline access system. */
|
|
22943
|
-
common_acs_entrance_ids?: string[] | undefined;
|
|
22944
|
-
/** Indicates whether the credential is valid. */
|
|
22945
|
-
is_valid?: boolean | undefined;
|
|
22946
|
-
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
22947
|
-
auto_join?: boolean | undefined;
|
|
22948
|
-
/** ID of the card in the Visionline access system. */
|
|
22949
|
-
card_id?: string | undefined;
|
|
22950
|
-
/** ID of the credential in the Visionline access system. */
|
|
22951
|
-
credential_id?: string | undefined;
|
|
22952
|
-
} | undefined;
|
|
22953
|
-
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
22954
|
-
assa_abloy_vostio_metadata?: {
|
|
22955
|
-
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
22956
|
-
auto_join?: boolean | undefined;
|
|
22957
|
-
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
22958
|
-
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
22959
|
-
/** Key ID in the Vostio access system. */
|
|
22960
|
-
key_id?: string | undefined;
|
|
22961
|
-
/** Key issuing request ID in the Vostio access system. */
|
|
22962
|
-
key_issuing_request_id?: string | undefined;
|
|
22963
|
-
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
22964
|
-
door_names?: string[] | undefined;
|
|
22965
|
-
/** Endpoint ID in the Vostio access system. */
|
|
22966
|
-
endpoint_id?: string | undefined;
|
|
22967
|
-
} | undefined;
|
|
22968
|
-
is_managed: true;
|
|
22969
|
-
}[];
|
|
24257
|
+
};
|
|
24258
|
+
};
|
|
22970
24259
|
};
|
|
22971
24260
|
maxDuration: undefined;
|
|
22972
24261
|
};
|
|
@@ -24390,6 +25679,8 @@ export type Routes = {
|
|
|
24390
25679
|
can_unlock_with_code?: boolean | undefined;
|
|
24391
25680
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
24392
25681
|
can_belong_to_reservation?: boolean | undefined;
|
|
25682
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
25683
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
24393
25684
|
}[];
|
|
24394
25685
|
};
|
|
24395
25686
|
maxDuration: undefined;
|
|
@@ -63056,6 +64347,8 @@ export type Routes = {
|
|
|
63056
64347
|
can_unlock_with_code?: boolean | undefined;
|
|
63057
64348
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
63058
64349
|
can_belong_to_reservation?: boolean | undefined;
|
|
64350
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
64351
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
63059
64352
|
}[];
|
|
63060
64353
|
}[];
|
|
63061
64354
|
}[];
|
|
@@ -64765,6 +66058,8 @@ export type Routes = {
|
|
|
64765
66058
|
can_unlock_with_code?: boolean | undefined;
|
|
64766
66059
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
64767
66060
|
can_belong_to_reservation?: boolean | undefined;
|
|
66061
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
66062
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
64768
66063
|
}[] | undefined;
|
|
64769
66064
|
connected_accounts?: {
|
|
64770
66065
|
/** ID of the connected account. */
|
|
@@ -86830,6 +88125,8 @@ export type Routes = {
|
|
|
86830
88125
|
can_unlock_with_code?: boolean | undefined;
|
|
86831
88126
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
86832
88127
|
can_belong_to_reservation?: boolean | undefined;
|
|
88128
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
88129
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
86833
88130
|
}[] | undefined;
|
|
86834
88131
|
acs_systems?: {
|
|
86835
88132
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
@@ -87246,6 +88543,13 @@ export type Routes = {
|
|
|
87246
88543
|
message: string;
|
|
87247
88544
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
87248
88545
|
mutation_code: 'deleting';
|
|
88546
|
+
} | {
|
|
88547
|
+
/** Date and time at which the mutation was created. */
|
|
88548
|
+
created_at: string;
|
|
88549
|
+
/** Detailed description of the mutation. */
|
|
88550
|
+
message: string;
|
|
88551
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
88552
|
+
mutation_code: 'deferring_deletion';
|
|
87249
88553
|
} | {
|
|
87250
88554
|
/** Date and time at which the mutation was created. */
|
|
87251
88555
|
created_at: string;
|
|
@@ -87329,13 +88633,6 @@ export type Routes = {
|
|
|
87329
88633
|
acs_user_id: string;
|
|
87330
88634
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
87331
88635
|
variant: 'adding' | 'removing';
|
|
87332
|
-
} | {
|
|
87333
|
-
/** Date and time at which the mutation was created. */
|
|
87334
|
-
created_at: string;
|
|
87335
|
-
/** Detailed description of the mutation. */
|
|
87336
|
-
message: string;
|
|
87337
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
87338
|
-
mutation_code: 'deferring_deletion';
|
|
87339
88636
|
})[];
|
|
87340
88637
|
is_managed: true;
|
|
87341
88638
|
}[] | undefined;
|
|
@@ -88942,6 +90239,13 @@ export type Routes = {
|
|
|
88942
90239
|
message: string;
|
|
88943
90240
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
88944
90241
|
mutation_code: 'deleting';
|
|
90242
|
+
} | {
|
|
90243
|
+
/** Date and time at which the mutation was created. */
|
|
90244
|
+
created_at: string;
|
|
90245
|
+
/** Detailed description of the mutation. */
|
|
90246
|
+
message: string;
|
|
90247
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
90248
|
+
mutation_code: 'deferring_deletion';
|
|
88945
90249
|
} | {
|
|
88946
90250
|
/** Date and time at which the mutation was created. */
|
|
88947
90251
|
created_at: string;
|
|
@@ -89025,13 +90329,6 @@ export type Routes = {
|
|
|
89025
90329
|
acs_user_id: string;
|
|
89026
90330
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
89027
90331
|
variant: 'adding' | 'removing';
|
|
89028
|
-
} | {
|
|
89029
|
-
/** Date and time at which the mutation was created. */
|
|
89030
|
-
created_at: string;
|
|
89031
|
-
/** Detailed description of the mutation. */
|
|
89032
|
-
message: string;
|
|
89033
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
89034
|
-
mutation_code: 'deferring_deletion';
|
|
89035
90332
|
})[];
|
|
89036
90333
|
is_managed: false;
|
|
89037
90334
|
}[] | undefined;
|