@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
package/dist/connect.d.cts
CHANGED
|
@@ -4348,6 +4348,19 @@ declare const acs_access_group: z.ZodObject<{
|
|
|
4348
4348
|
}>, z.ZodObject<{
|
|
4349
4349
|
created_at: z.ZodString;
|
|
4350
4350
|
message: z.ZodString;
|
|
4351
|
+
} & {
|
|
4352
|
+
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
4353
|
+
}, "strip", z.ZodTypeAny, {
|
|
4354
|
+
message: string;
|
|
4355
|
+
created_at: string;
|
|
4356
|
+
mutation_code: "deferring_deletion";
|
|
4357
|
+
}, {
|
|
4358
|
+
message: string;
|
|
4359
|
+
created_at: string;
|
|
4360
|
+
mutation_code: "deferring_deletion";
|
|
4361
|
+
}>, z.ZodObject<{
|
|
4362
|
+
created_at: z.ZodString;
|
|
4363
|
+
message: z.ZodString;
|
|
4351
4364
|
} & {
|
|
4352
4365
|
mutation_code: z.ZodLiteral<"updating_group_information">;
|
|
4353
4366
|
from: z.ZodObject<{
|
|
@@ -4530,19 +4543,6 @@ declare const acs_access_group: z.ZodObject<{
|
|
|
4530
4543
|
mutation_code: "deferring_user_membership_update";
|
|
4531
4544
|
acs_user_id: string;
|
|
4532
4545
|
variant: "removing" | "adding";
|
|
4533
|
-
}>, z.ZodObject<{
|
|
4534
|
-
created_at: z.ZodString;
|
|
4535
|
-
message: z.ZodString;
|
|
4536
|
-
} & {
|
|
4537
|
-
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
4538
|
-
}, "strip", z.ZodTypeAny, {
|
|
4539
|
-
message: string;
|
|
4540
|
-
created_at: string;
|
|
4541
|
-
mutation_code: "deferring_deletion";
|
|
4542
|
-
}, {
|
|
4543
|
-
message: string;
|
|
4544
|
-
created_at: string;
|
|
4545
|
-
mutation_code: "deferring_deletion";
|
|
4546
4546
|
}>]>, "many">;
|
|
4547
4547
|
} & {
|
|
4548
4548
|
is_managed: z.ZodLiteral<true>;
|
|
@@ -4615,13 +4615,13 @@ declare const acs_access_group: z.ZodObject<{
|
|
|
4615
4615
|
} | {
|
|
4616
4616
|
message: string;
|
|
4617
4617
|
created_at: string;
|
|
4618
|
-
mutation_code: "
|
|
4619
|
-
acs_user_id: string;
|
|
4620
|
-
variant: "removing" | "adding";
|
|
4618
|
+
mutation_code: "deferring_deletion";
|
|
4621
4619
|
} | {
|
|
4622
4620
|
message: string;
|
|
4623
4621
|
created_at: string;
|
|
4624
|
-
mutation_code: "
|
|
4622
|
+
mutation_code: "deferring_user_membership_update";
|
|
4623
|
+
acs_user_id: string;
|
|
4624
|
+
variant: "removing" | "adding";
|
|
4625
4625
|
})[];
|
|
4626
4626
|
acs_access_group_id: string;
|
|
4627
4627
|
acs_system_id: string;
|
|
@@ -4702,13 +4702,13 @@ declare const acs_access_group: z.ZodObject<{
|
|
|
4702
4702
|
} | {
|
|
4703
4703
|
message: string;
|
|
4704
4704
|
created_at: string;
|
|
4705
|
-
mutation_code: "
|
|
4706
|
-
acs_user_id: string;
|
|
4707
|
-
variant: "removing" | "adding";
|
|
4705
|
+
mutation_code: "deferring_deletion";
|
|
4708
4706
|
} | {
|
|
4709
4707
|
message: string;
|
|
4710
4708
|
created_at: string;
|
|
4711
|
-
mutation_code: "
|
|
4709
|
+
mutation_code: "deferring_user_membership_update";
|
|
4710
|
+
acs_user_id: string;
|
|
4711
|
+
variant: "removing" | "adding";
|
|
4712
4712
|
})[];
|
|
4713
4713
|
acs_access_group_id: string;
|
|
4714
4714
|
acs_system_id: string;
|
|
@@ -4799,6 +4799,19 @@ declare const unmanaged_acs_access_group: z.ZodObject<{
|
|
|
4799
4799
|
}>, z.ZodObject<{
|
|
4800
4800
|
created_at: z.ZodString;
|
|
4801
4801
|
message: z.ZodString;
|
|
4802
|
+
} & {
|
|
4803
|
+
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
4804
|
+
}, "strip", z.ZodTypeAny, {
|
|
4805
|
+
message: string;
|
|
4806
|
+
created_at: string;
|
|
4807
|
+
mutation_code: "deferring_deletion";
|
|
4808
|
+
}, {
|
|
4809
|
+
message: string;
|
|
4810
|
+
created_at: string;
|
|
4811
|
+
mutation_code: "deferring_deletion";
|
|
4812
|
+
}>, z.ZodObject<{
|
|
4813
|
+
created_at: z.ZodString;
|
|
4814
|
+
message: z.ZodString;
|
|
4802
4815
|
} & {
|
|
4803
4816
|
mutation_code: z.ZodLiteral<"updating_group_information">;
|
|
4804
4817
|
from: z.ZodObject<{
|
|
@@ -4981,19 +4994,6 @@ declare const unmanaged_acs_access_group: z.ZodObject<{
|
|
|
4981
4994
|
mutation_code: "deferring_user_membership_update";
|
|
4982
4995
|
acs_user_id: string;
|
|
4983
4996
|
variant: "removing" | "adding";
|
|
4984
|
-
}>, z.ZodObject<{
|
|
4985
|
-
created_at: z.ZodString;
|
|
4986
|
-
message: z.ZodString;
|
|
4987
|
-
} & {
|
|
4988
|
-
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
4989
|
-
}, "strip", z.ZodTypeAny, {
|
|
4990
|
-
message: string;
|
|
4991
|
-
created_at: string;
|
|
4992
|
-
mutation_code: "deferring_deletion";
|
|
4993
|
-
}, {
|
|
4994
|
-
message: string;
|
|
4995
|
-
created_at: string;
|
|
4996
|
-
mutation_code: "deferring_deletion";
|
|
4997
4997
|
}>]>, "many">;
|
|
4998
4998
|
} & {
|
|
4999
4999
|
is_managed: z.ZodLiteral<false>;
|
|
@@ -5066,13 +5066,13 @@ declare const unmanaged_acs_access_group: z.ZodObject<{
|
|
|
5066
5066
|
} | {
|
|
5067
5067
|
message: string;
|
|
5068
5068
|
created_at: string;
|
|
5069
|
-
mutation_code: "
|
|
5070
|
-
acs_user_id: string;
|
|
5071
|
-
variant: "removing" | "adding";
|
|
5069
|
+
mutation_code: "deferring_deletion";
|
|
5072
5070
|
} | {
|
|
5073
5071
|
message: string;
|
|
5074
5072
|
created_at: string;
|
|
5075
|
-
mutation_code: "
|
|
5073
|
+
mutation_code: "deferring_user_membership_update";
|
|
5074
|
+
acs_user_id: string;
|
|
5075
|
+
variant: "removing" | "adding";
|
|
5076
5076
|
})[];
|
|
5077
5077
|
acs_access_group_id: string;
|
|
5078
5078
|
acs_system_id: string;
|
|
@@ -5153,13 +5153,13 @@ declare const unmanaged_acs_access_group: z.ZodObject<{
|
|
|
5153
5153
|
} | {
|
|
5154
5154
|
message: string;
|
|
5155
5155
|
created_at: string;
|
|
5156
|
-
mutation_code: "
|
|
5157
|
-
acs_user_id: string;
|
|
5158
|
-
variant: "removing" | "adding";
|
|
5156
|
+
mutation_code: "deferring_deletion";
|
|
5159
5157
|
} | {
|
|
5160
5158
|
message: string;
|
|
5161
5159
|
created_at: string;
|
|
5162
|
-
mutation_code: "
|
|
5160
|
+
mutation_code: "deferring_user_membership_update";
|
|
5161
|
+
acs_user_id: string;
|
|
5162
|
+
variant: "removing" | "adding";
|
|
5163
5163
|
})[];
|
|
5164
5164
|
acs_access_group_id: string;
|
|
5165
5165
|
acs_system_id: string;
|
|
@@ -6019,6 +6019,7 @@ declare const acs_entrance: z.ZodObject<{
|
|
|
6019
6019
|
can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
|
|
6020
6020
|
can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
|
|
6021
6021
|
can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
|
|
6022
|
+
can_unlock_with_cloud_key: z.ZodOptional<z.ZodBoolean>;
|
|
6022
6023
|
}, "strip", z.ZodTypeAny, {
|
|
6023
6024
|
display_name: string;
|
|
6024
6025
|
created_at: string;
|
|
@@ -6064,6 +6065,7 @@ declare const acs_entrance: z.ZodObject<{
|
|
|
6064
6065
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
6065
6066
|
can_unlock_with_card?: boolean | undefined;
|
|
6066
6067
|
can_belong_to_reservation?: boolean | undefined;
|
|
6068
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
6067
6069
|
latch_metadata?: {
|
|
6068
6070
|
door_name: string;
|
|
6069
6071
|
is_connected: boolean;
|
|
@@ -6134,6 +6136,7 @@ declare const acs_entrance: z.ZodObject<{
|
|
|
6134
6136
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
6135
6137
|
can_unlock_with_card?: boolean | undefined;
|
|
6136
6138
|
can_belong_to_reservation?: boolean | undefined;
|
|
6139
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
6137
6140
|
latch_metadata?: {
|
|
6138
6141
|
door_name: string;
|
|
6139
6142
|
is_connected: boolean;
|
|
@@ -16986,6 +16989,7 @@ declare const batch: z.ZodObject<{
|
|
|
16986
16989
|
can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
|
|
16987
16990
|
can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
|
|
16988
16991
|
can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
|
|
16992
|
+
can_unlock_with_cloud_key: z.ZodOptional<z.ZodBoolean>;
|
|
16989
16993
|
}, "strip", z.ZodTypeAny, {
|
|
16990
16994
|
display_name: string;
|
|
16991
16995
|
created_at: string;
|
|
@@ -17031,6 +17035,7 @@ declare const batch: z.ZodObject<{
|
|
|
17031
17035
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
17032
17036
|
can_unlock_with_card?: boolean | undefined;
|
|
17033
17037
|
can_belong_to_reservation?: boolean | undefined;
|
|
17038
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
17034
17039
|
latch_metadata?: {
|
|
17035
17040
|
door_name: string;
|
|
17036
17041
|
is_connected: boolean;
|
|
@@ -17101,6 +17106,7 @@ declare const batch: z.ZodObject<{
|
|
|
17101
17106
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
17102
17107
|
can_unlock_with_card?: boolean | undefined;
|
|
17103
17108
|
can_belong_to_reservation?: boolean | undefined;
|
|
17109
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
17104
17110
|
latch_metadata?: {
|
|
17105
17111
|
door_name: string;
|
|
17106
17112
|
is_connected: boolean;
|
|
@@ -18196,6 +18202,19 @@ declare const batch: z.ZodObject<{
|
|
|
18196
18202
|
}>, z.ZodObject<{
|
|
18197
18203
|
created_at: z.ZodString;
|
|
18198
18204
|
message: z.ZodString;
|
|
18205
|
+
} & {
|
|
18206
|
+
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
18207
|
+
}, "strip", z.ZodTypeAny, {
|
|
18208
|
+
message: string;
|
|
18209
|
+
created_at: string;
|
|
18210
|
+
mutation_code: "deferring_deletion";
|
|
18211
|
+
}, {
|
|
18212
|
+
message: string;
|
|
18213
|
+
created_at: string;
|
|
18214
|
+
mutation_code: "deferring_deletion";
|
|
18215
|
+
}>, z.ZodObject<{
|
|
18216
|
+
created_at: z.ZodString;
|
|
18217
|
+
message: z.ZodString;
|
|
18199
18218
|
} & {
|
|
18200
18219
|
mutation_code: z.ZodLiteral<"updating_group_information">;
|
|
18201
18220
|
from: z.ZodObject<{
|
|
@@ -18378,19 +18397,6 @@ declare const batch: z.ZodObject<{
|
|
|
18378
18397
|
mutation_code: "deferring_user_membership_update";
|
|
18379
18398
|
acs_user_id: string;
|
|
18380
18399
|
variant: "removing" | "adding";
|
|
18381
|
-
}>, z.ZodObject<{
|
|
18382
|
-
created_at: z.ZodString;
|
|
18383
|
-
message: z.ZodString;
|
|
18384
|
-
} & {
|
|
18385
|
-
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
18386
|
-
}, "strip", z.ZodTypeAny, {
|
|
18387
|
-
message: string;
|
|
18388
|
-
created_at: string;
|
|
18389
|
-
mutation_code: "deferring_deletion";
|
|
18390
|
-
}, {
|
|
18391
|
-
message: string;
|
|
18392
|
-
created_at: string;
|
|
18393
|
-
mutation_code: "deferring_deletion";
|
|
18394
18400
|
}>]>, "many">;
|
|
18395
18401
|
} & {
|
|
18396
18402
|
is_managed: z.ZodLiteral<true>;
|
|
@@ -18463,13 +18469,13 @@ declare const batch: z.ZodObject<{
|
|
|
18463
18469
|
} | {
|
|
18464
18470
|
message: string;
|
|
18465
18471
|
created_at: string;
|
|
18466
|
-
mutation_code: "
|
|
18467
|
-
acs_user_id: string;
|
|
18468
|
-
variant: "removing" | "adding";
|
|
18472
|
+
mutation_code: "deferring_deletion";
|
|
18469
18473
|
} | {
|
|
18470
18474
|
message: string;
|
|
18471
18475
|
created_at: string;
|
|
18472
|
-
mutation_code: "
|
|
18476
|
+
mutation_code: "deferring_user_membership_update";
|
|
18477
|
+
acs_user_id: string;
|
|
18478
|
+
variant: "removing" | "adding";
|
|
18473
18479
|
})[];
|
|
18474
18480
|
acs_access_group_id: string;
|
|
18475
18481
|
acs_system_id: string;
|
|
@@ -18550,13 +18556,13 @@ declare const batch: z.ZodObject<{
|
|
|
18550
18556
|
} | {
|
|
18551
18557
|
message: string;
|
|
18552
18558
|
created_at: string;
|
|
18553
|
-
mutation_code: "
|
|
18554
|
-
acs_user_id: string;
|
|
18555
|
-
variant: "removing" | "adding";
|
|
18559
|
+
mutation_code: "deferring_deletion";
|
|
18556
18560
|
} | {
|
|
18557
18561
|
message: string;
|
|
18558
18562
|
created_at: string;
|
|
18559
|
-
mutation_code: "
|
|
18563
|
+
mutation_code: "deferring_user_membership_update";
|
|
18564
|
+
acs_user_id: string;
|
|
18565
|
+
variant: "removing" | "adding";
|
|
18560
18566
|
})[];
|
|
18561
18567
|
acs_access_group_id: string;
|
|
18562
18568
|
acs_system_id: string;
|
|
@@ -23889,6 +23895,19 @@ declare const batch: z.ZodObject<{
|
|
|
23889
23895
|
}>, z.ZodObject<{
|
|
23890
23896
|
created_at: z.ZodString;
|
|
23891
23897
|
message: z.ZodString;
|
|
23898
|
+
} & {
|
|
23899
|
+
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
23900
|
+
}, "strip", z.ZodTypeAny, {
|
|
23901
|
+
message: string;
|
|
23902
|
+
created_at: string;
|
|
23903
|
+
mutation_code: "deferring_deletion";
|
|
23904
|
+
}, {
|
|
23905
|
+
message: string;
|
|
23906
|
+
created_at: string;
|
|
23907
|
+
mutation_code: "deferring_deletion";
|
|
23908
|
+
}>, z.ZodObject<{
|
|
23909
|
+
created_at: z.ZodString;
|
|
23910
|
+
message: z.ZodString;
|
|
23892
23911
|
} & {
|
|
23893
23912
|
mutation_code: z.ZodLiteral<"updating_group_information">;
|
|
23894
23913
|
from: z.ZodObject<{
|
|
@@ -24071,19 +24090,6 @@ declare const batch: z.ZodObject<{
|
|
|
24071
24090
|
mutation_code: "deferring_user_membership_update";
|
|
24072
24091
|
acs_user_id: string;
|
|
24073
24092
|
variant: "removing" | "adding";
|
|
24074
|
-
}>, z.ZodObject<{
|
|
24075
|
-
created_at: z.ZodString;
|
|
24076
|
-
message: z.ZodString;
|
|
24077
|
-
} & {
|
|
24078
|
-
mutation_code: z.ZodLiteral<"deferring_deletion">;
|
|
24079
|
-
}, "strip", z.ZodTypeAny, {
|
|
24080
|
-
message: string;
|
|
24081
|
-
created_at: string;
|
|
24082
|
-
mutation_code: "deferring_deletion";
|
|
24083
|
-
}, {
|
|
24084
|
-
message: string;
|
|
24085
|
-
created_at: string;
|
|
24086
|
-
mutation_code: "deferring_deletion";
|
|
24087
24093
|
}>]>, "many">;
|
|
24088
24094
|
} & {
|
|
24089
24095
|
is_managed: z.ZodLiteral<false>;
|
|
@@ -24156,13 +24162,13 @@ declare const batch: z.ZodObject<{
|
|
|
24156
24162
|
} | {
|
|
24157
24163
|
message: string;
|
|
24158
24164
|
created_at: string;
|
|
24159
|
-
mutation_code: "
|
|
24160
|
-
acs_user_id: string;
|
|
24161
|
-
variant: "removing" | "adding";
|
|
24165
|
+
mutation_code: "deferring_deletion";
|
|
24162
24166
|
} | {
|
|
24163
24167
|
message: string;
|
|
24164
24168
|
created_at: string;
|
|
24165
|
-
mutation_code: "
|
|
24169
|
+
mutation_code: "deferring_user_membership_update";
|
|
24170
|
+
acs_user_id: string;
|
|
24171
|
+
variant: "removing" | "adding";
|
|
24166
24172
|
})[];
|
|
24167
24173
|
acs_access_group_id: string;
|
|
24168
24174
|
acs_system_id: string;
|
|
@@ -24243,13 +24249,13 @@ declare const batch: z.ZodObject<{
|
|
|
24243
24249
|
} | {
|
|
24244
24250
|
message: string;
|
|
24245
24251
|
created_at: string;
|
|
24246
|
-
mutation_code: "
|
|
24247
|
-
acs_user_id: string;
|
|
24248
|
-
variant: "removing" | "adding";
|
|
24252
|
+
mutation_code: "deferring_deletion";
|
|
24249
24253
|
} | {
|
|
24250
24254
|
message: string;
|
|
24251
24255
|
created_at: string;
|
|
24252
|
-
mutation_code: "
|
|
24256
|
+
mutation_code: "deferring_user_membership_update";
|
|
24257
|
+
acs_user_id: string;
|
|
24258
|
+
variant: "removing" | "adding";
|
|
24253
24259
|
})[];
|
|
24254
24260
|
acs_access_group_id: string;
|
|
24255
24261
|
acs_system_id: string;
|
|
@@ -37749,6 +37755,7 @@ declare const batch: z.ZodObject<{
|
|
|
37749
37755
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
37750
37756
|
can_unlock_with_card?: boolean | undefined;
|
|
37751
37757
|
can_belong_to_reservation?: boolean | undefined;
|
|
37758
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
37752
37759
|
latch_metadata?: {
|
|
37753
37760
|
door_name: string;
|
|
37754
37761
|
is_connected: boolean;
|
|
@@ -38048,13 +38055,13 @@ declare const batch: z.ZodObject<{
|
|
|
38048
38055
|
} | {
|
|
38049
38056
|
message: string;
|
|
38050
38057
|
created_at: string;
|
|
38051
|
-
mutation_code: "
|
|
38052
|
-
acs_user_id: string;
|
|
38053
|
-
variant: "removing" | "adding";
|
|
38058
|
+
mutation_code: "deferring_deletion";
|
|
38054
38059
|
} | {
|
|
38055
38060
|
message: string;
|
|
38056
38061
|
created_at: string;
|
|
38057
|
-
mutation_code: "
|
|
38062
|
+
mutation_code: "deferring_user_membership_update";
|
|
38063
|
+
acs_user_id: string;
|
|
38064
|
+
variant: "removing" | "adding";
|
|
38058
38065
|
})[];
|
|
38059
38066
|
acs_access_group_id: string;
|
|
38060
38067
|
acs_system_id: string;
|
|
@@ -39177,13 +39184,13 @@ declare const batch: z.ZodObject<{
|
|
|
39177
39184
|
} | {
|
|
39178
39185
|
message: string;
|
|
39179
39186
|
created_at: string;
|
|
39180
|
-
mutation_code: "
|
|
39181
|
-
acs_user_id: string;
|
|
39182
|
-
variant: "removing" | "adding";
|
|
39187
|
+
mutation_code: "deferring_deletion";
|
|
39183
39188
|
} | {
|
|
39184
39189
|
message: string;
|
|
39185
39190
|
created_at: string;
|
|
39186
|
-
mutation_code: "
|
|
39191
|
+
mutation_code: "deferring_user_membership_update";
|
|
39192
|
+
acs_user_id: string;
|
|
39193
|
+
variant: "removing" | "adding";
|
|
39187
39194
|
})[];
|
|
39188
39195
|
acs_access_group_id: string;
|
|
39189
39196
|
acs_system_id: string;
|
|
@@ -42551,6 +42558,7 @@ declare const batch: z.ZodObject<{
|
|
|
42551
42558
|
can_unlock_with_mobile_key?: boolean | undefined;
|
|
42552
42559
|
can_unlock_with_card?: boolean | undefined;
|
|
42553
42560
|
can_belong_to_reservation?: boolean | undefined;
|
|
42561
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
42554
42562
|
latch_metadata?: {
|
|
42555
42563
|
door_name: string;
|
|
42556
42564
|
is_connected: boolean;
|
|
@@ -42850,13 +42858,13 @@ declare const batch: z.ZodObject<{
|
|
|
42850
42858
|
} | {
|
|
42851
42859
|
message: string;
|
|
42852
42860
|
created_at: string;
|
|
42853
|
-
mutation_code: "
|
|
42854
|
-
acs_user_id: string;
|
|
42855
|
-
variant: "removing" | "adding";
|
|
42861
|
+
mutation_code: "deferring_deletion";
|
|
42856
42862
|
} | {
|
|
42857
42863
|
message: string;
|
|
42858
42864
|
created_at: string;
|
|
42859
|
-
mutation_code: "
|
|
42865
|
+
mutation_code: "deferring_user_membership_update";
|
|
42866
|
+
acs_user_id: string;
|
|
42867
|
+
variant: "removing" | "adding";
|
|
42860
42868
|
})[];
|
|
42861
42869
|
acs_access_group_id: string;
|
|
42862
42870
|
acs_system_id: string;
|
|
@@ -43979,13 +43987,13 @@ declare const batch: z.ZodObject<{
|
|
|
43979
43987
|
} | {
|
|
43980
43988
|
message: string;
|
|
43981
43989
|
created_at: string;
|
|
43982
|
-
mutation_code: "
|
|
43983
|
-
acs_user_id: string;
|
|
43984
|
-
variant: "removing" | "adding";
|
|
43990
|
+
mutation_code: "deferring_deletion";
|
|
43985
43991
|
} | {
|
|
43986
43992
|
message: string;
|
|
43987
43993
|
created_at: string;
|
|
43988
|
-
mutation_code: "
|
|
43994
|
+
mutation_code: "deferring_user_membership_update";
|
|
43995
|
+
acs_user_id: string;
|
|
43996
|
+
variant: "removing" | "adding";
|
|
43989
43997
|
})[];
|
|
43990
43998
|
acs_access_group_id: string;
|
|
43991
43999
|
acs_system_id: string;
|
|
@@ -63673,6 +63681,10 @@ declare const _default: {
|
|
|
63673
63681
|
description: string;
|
|
63674
63682
|
type: string;
|
|
63675
63683
|
};
|
|
63684
|
+
can_unlock_with_cloud_key: {
|
|
63685
|
+
description: string;
|
|
63686
|
+
type: string;
|
|
63687
|
+
};
|
|
63676
63688
|
can_unlock_with_code: {
|
|
63677
63689
|
description: string;
|
|
63678
63690
|
type: string;
|
|
@@ -77314,6 +77326,10 @@ declare const _default: {
|
|
|
77314
77326
|
description: string;
|
|
77315
77327
|
type: string;
|
|
77316
77328
|
};
|
|
77329
|
+
can_unlock_with_cloud_key: {
|
|
77330
|
+
description: string;
|
|
77331
|
+
type: string;
|
|
77332
|
+
};
|
|
77317
77333
|
can_unlock_with_code: {
|
|
77318
77334
|
description: string;
|
|
77319
77335
|
type: string;
|
|
@@ -94726,27 +94742,39 @@ declare const _default: {
|
|
|
94726
94742
|
'x-title': string;
|
|
94727
94743
|
};
|
|
94728
94744
|
};
|
|
94729
|
-
'/acs/
|
|
94730
|
-
|
|
94745
|
+
'/acs/entrances/unlock': {
|
|
94746
|
+
post: {
|
|
94731
94747
|
description: string;
|
|
94732
94748
|
operationId: string;
|
|
94733
|
-
|
|
94734
|
-
|
|
94735
|
-
|
|
94736
|
-
|
|
94737
|
-
|
|
94738
|
-
|
|
94739
|
-
|
|
94740
|
-
|
|
94749
|
+
requestBody: {
|
|
94750
|
+
content: {
|
|
94751
|
+
'application/json': {
|
|
94752
|
+
schema: {
|
|
94753
|
+
properties: {
|
|
94754
|
+
acs_credential_id: {
|
|
94755
|
+
description: string;
|
|
94756
|
+
format: string;
|
|
94757
|
+
type: string;
|
|
94758
|
+
};
|
|
94759
|
+
acs_entrance_id: {
|
|
94760
|
+
description: string;
|
|
94761
|
+
format: string;
|
|
94762
|
+
type: string;
|
|
94763
|
+
};
|
|
94764
|
+
};
|
|
94765
|
+
required: string[];
|
|
94766
|
+
type: string;
|
|
94767
|
+
};
|
|
94768
|
+
};
|
|
94741
94769
|
};
|
|
94742
|
-
}
|
|
94770
|
+
};
|
|
94743
94771
|
responses: {
|
|
94744
94772
|
200: {
|
|
94745
94773
|
content: {
|
|
94746
94774
|
'application/json': {
|
|
94747
94775
|
schema: {
|
|
94748
94776
|
properties: {
|
|
94749
|
-
|
|
94777
|
+
action_attempt: {
|
|
94750
94778
|
$ref: string;
|
|
94751
94779
|
};
|
|
94752
94780
|
ok: {
|
|
@@ -94782,32 +94810,96 @@ declare const _default: {
|
|
|
94782
94810
|
})[];
|
|
94783
94811
|
summary: string;
|
|
94784
94812
|
tags: string[];
|
|
94813
|
+
'x-action-attempt-type': string;
|
|
94785
94814
|
'x-fern-sdk-group-name': string[];
|
|
94786
94815
|
'x-fern-sdk-method-name': string;
|
|
94787
94816
|
'x-fern-sdk-return-value': string;
|
|
94788
94817
|
'x-response-key': string;
|
|
94789
94818
|
'x-title': string;
|
|
94790
94819
|
};
|
|
94791
|
-
|
|
94820
|
+
};
|
|
94821
|
+
'/acs/systems/get': {
|
|
94822
|
+
get: {
|
|
94792
94823
|
description: string;
|
|
94793
94824
|
operationId: string;
|
|
94794
|
-
|
|
94795
|
-
|
|
94796
|
-
|
|
94797
|
-
|
|
94798
|
-
|
|
94799
|
-
|
|
94800
|
-
|
|
94801
|
-
|
|
94802
|
-
type: string;
|
|
94803
|
-
};
|
|
94804
|
-
};
|
|
94805
|
-
required: string[];
|
|
94806
|
-
type: string;
|
|
94807
|
-
};
|
|
94808
|
-
};
|
|
94825
|
+
parameters: {
|
|
94826
|
+
in: string;
|
|
94827
|
+
name: string;
|
|
94828
|
+
required: boolean;
|
|
94829
|
+
schema: {
|
|
94830
|
+
description: string;
|
|
94831
|
+
format: string;
|
|
94832
|
+
type: string;
|
|
94809
94833
|
};
|
|
94810
|
-
};
|
|
94834
|
+
}[];
|
|
94835
|
+
responses: {
|
|
94836
|
+
200: {
|
|
94837
|
+
content: {
|
|
94838
|
+
'application/json': {
|
|
94839
|
+
schema: {
|
|
94840
|
+
properties: {
|
|
94841
|
+
acs_system: {
|
|
94842
|
+
$ref: string;
|
|
94843
|
+
};
|
|
94844
|
+
ok: {
|
|
94845
|
+
type: string;
|
|
94846
|
+
};
|
|
94847
|
+
};
|
|
94848
|
+
required: string[];
|
|
94849
|
+
type: string;
|
|
94850
|
+
};
|
|
94851
|
+
};
|
|
94852
|
+
};
|
|
94853
|
+
description: string;
|
|
94854
|
+
};
|
|
94855
|
+
400: {
|
|
94856
|
+
description: string;
|
|
94857
|
+
};
|
|
94858
|
+
401: {
|
|
94859
|
+
description: string;
|
|
94860
|
+
};
|
|
94861
|
+
};
|
|
94862
|
+
security: ({
|
|
94863
|
+
pat_with_workspace: never[];
|
|
94864
|
+
console_session_with_workspace?: never;
|
|
94865
|
+
api_key?: never;
|
|
94866
|
+
} | {
|
|
94867
|
+
console_session_with_workspace: never[];
|
|
94868
|
+
pat_with_workspace?: never;
|
|
94869
|
+
api_key?: never;
|
|
94870
|
+
} | {
|
|
94871
|
+
api_key: never[];
|
|
94872
|
+
pat_with_workspace?: never;
|
|
94873
|
+
console_session_with_workspace?: never;
|
|
94874
|
+
})[];
|
|
94875
|
+
summary: string;
|
|
94876
|
+
tags: string[];
|
|
94877
|
+
'x-fern-sdk-group-name': string[];
|
|
94878
|
+
'x-fern-sdk-method-name': string;
|
|
94879
|
+
'x-fern-sdk-return-value': string;
|
|
94880
|
+
'x-response-key': string;
|
|
94881
|
+
'x-title': string;
|
|
94882
|
+
};
|
|
94883
|
+
post: {
|
|
94884
|
+
description: string;
|
|
94885
|
+
operationId: string;
|
|
94886
|
+
requestBody: {
|
|
94887
|
+
content: {
|
|
94888
|
+
'application/json': {
|
|
94889
|
+
schema: {
|
|
94890
|
+
properties: {
|
|
94891
|
+
acs_system_id: {
|
|
94892
|
+
description: string;
|
|
94893
|
+
format: string;
|
|
94894
|
+
type: string;
|
|
94895
|
+
};
|
|
94896
|
+
};
|
|
94897
|
+
required: string[];
|
|
94898
|
+
type: string;
|
|
94899
|
+
};
|
|
94900
|
+
};
|
|
94901
|
+
};
|
|
94902
|
+
};
|
|
94811
94903
|
responses: {
|
|
94812
94904
|
200: {
|
|
94813
94905
|
content: {
|
|
@@ -144594,6 +144686,8 @@ type Routes = {
|
|
|
144594
144686
|
can_unlock_with_code?: boolean | undefined;
|
|
144595
144687
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
144596
144688
|
can_belong_to_reservation?: boolean | undefined;
|
|
144689
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
144690
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
144597
144691
|
}[] | undefined;
|
|
144598
144692
|
connected_accounts?: {
|
|
144599
144693
|
/** ID of the connected account. */
|
|
@@ -144960,6 +145054,13 @@ type Routes = {
|
|
|
144960
145054
|
message: string;
|
|
144961
145055
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
144962
145056
|
mutation_code: 'deleting';
|
|
145057
|
+
} | {
|
|
145058
|
+
/** Date and time at which the mutation was created. */
|
|
145059
|
+
created_at: string;
|
|
145060
|
+
/** Detailed description of the mutation. */
|
|
145061
|
+
message: string;
|
|
145062
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
145063
|
+
mutation_code: 'deferring_deletion';
|
|
144963
145064
|
} | {
|
|
144964
145065
|
/** Date and time at which the mutation was created. */
|
|
144965
145066
|
created_at: string;
|
|
@@ -145043,13 +145144,6 @@ type Routes = {
|
|
|
145043
145144
|
acs_user_id: string;
|
|
145044
145145
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
145045
145146
|
variant: 'adding' | 'removing';
|
|
145046
|
-
} | {
|
|
145047
|
-
/** Date and time at which the mutation was created. */
|
|
145048
|
-
created_at: string;
|
|
145049
|
-
/** Detailed description of the mutation. */
|
|
145050
|
-
message: string;
|
|
145051
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
145052
|
-
mutation_code: 'deferring_deletion';
|
|
145053
145147
|
})[];
|
|
145054
145148
|
is_managed: true;
|
|
145055
145149
|
}[] | undefined;
|
|
@@ -148805,6 +148899,8 @@ type Routes = {
|
|
|
148805
148899
|
can_unlock_with_code?: boolean | undefined;
|
|
148806
148900
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
148807
148901
|
can_belong_to_reservation?: boolean | undefined;
|
|
148902
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
148903
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
148808
148904
|
}[] | undefined;
|
|
148809
148905
|
access_grants?: {
|
|
148810
148906
|
/** ID of the Seam workspace associated with the Access Grant. */
|
|
@@ -149735,6 +149831,13 @@ type Routes = {
|
|
|
149735
149831
|
message: string;
|
|
149736
149832
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
149737
149833
|
mutation_code: 'deleting';
|
|
149834
|
+
} | {
|
|
149835
|
+
/** Date and time at which the mutation was created. */
|
|
149836
|
+
created_at: string;
|
|
149837
|
+
/** Detailed description of the mutation. */
|
|
149838
|
+
message: string;
|
|
149839
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
149840
|
+
mutation_code: 'deferring_deletion';
|
|
149738
149841
|
} | {
|
|
149739
149842
|
/** Date and time at which the mutation was created. */
|
|
149740
149843
|
created_at: string;
|
|
@@ -149818,13 +149921,6 @@ type Routes = {
|
|
|
149818
149921
|
acs_user_id: string;
|
|
149819
149922
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
149820
149923
|
variant: 'adding' | 'removing';
|
|
149821
|
-
} | {
|
|
149822
|
-
/** Date and time at which the mutation was created. */
|
|
149823
|
-
created_at: string;
|
|
149824
|
-
/** Detailed description of the mutation. */
|
|
149825
|
-
message: string;
|
|
149826
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
149827
|
-
mutation_code: 'deferring_deletion';
|
|
149828
149924
|
})[];
|
|
149829
149925
|
is_managed: true;
|
|
149830
149926
|
};
|
|
@@ -149910,6 +150006,13 @@ type Routes = {
|
|
|
149910
150006
|
message: string;
|
|
149911
150007
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
149912
150008
|
mutation_code: 'deleting';
|
|
150009
|
+
} | {
|
|
150010
|
+
/** Date and time at which the mutation was created. */
|
|
150011
|
+
created_at: string;
|
|
150012
|
+
/** Detailed description of the mutation. */
|
|
150013
|
+
message: string;
|
|
150014
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
150015
|
+
mutation_code: 'deferring_deletion';
|
|
149913
150016
|
} | {
|
|
149914
150017
|
/** Date and time at which the mutation was created. */
|
|
149915
150018
|
created_at: string;
|
|
@@ -149993,13 +150096,6 @@ type Routes = {
|
|
|
149993
150096
|
acs_user_id: string;
|
|
149994
150097
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
149995
150098
|
variant: 'adding' | 'removing';
|
|
149996
|
-
} | {
|
|
149997
|
-
/** Date and time at which the mutation was created. */
|
|
149998
|
-
created_at: string;
|
|
149999
|
-
/** Detailed description of the mutation. */
|
|
150000
|
-
message: string;
|
|
150001
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
150002
|
-
mutation_code: 'deferring_deletion';
|
|
150003
150099
|
})[];
|
|
150004
150100
|
is_managed: true;
|
|
150005
150101
|
}[];
|
|
@@ -150145,6 +150241,8 @@ type Routes = {
|
|
|
150145
150241
|
can_unlock_with_code?: boolean | undefined;
|
|
150146
150242
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
150147
150243
|
can_belong_to_reservation?: boolean | undefined;
|
|
150244
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
150245
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
150148
150246
|
}[];
|
|
150149
150247
|
};
|
|
150150
150248
|
maxDuration: undefined;
|
|
@@ -150494,174 +150592,8 @@ type Routes = {
|
|
|
150494
150592
|
created_at: string;
|
|
150495
150593
|
/** Detailed description of the mutation. */
|
|
150496
150594
|
message: string;
|
|
150497
|
-
/** Mutation code to indicate that
|
|
150498
|
-
mutation_code: 'updating_group_information';
|
|
150499
|
-
/** Old access group information. */
|
|
150500
|
-
from: {
|
|
150501
|
-
/** Name of the access group. */
|
|
150502
|
-
name?: (string | null) | undefined;
|
|
150503
|
-
};
|
|
150504
|
-
/** New access group information. */
|
|
150505
|
-
to: {
|
|
150506
|
-
/** Name of the access group. */
|
|
150507
|
-
name?: (string | null) | undefined;
|
|
150508
|
-
};
|
|
150509
|
-
} | {
|
|
150510
|
-
/** Date and time at which the mutation was created. */
|
|
150511
|
-
created_at: string;
|
|
150512
|
-
/** Detailed description of the mutation. */
|
|
150513
|
-
message: string;
|
|
150514
|
-
/** Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system. */
|
|
150515
|
-
mutation_code: 'updating_access_schedule';
|
|
150516
|
-
/** Old access schedule information. */
|
|
150517
|
-
from: {
|
|
150518
|
-
/** Starting time for the access schedule. */
|
|
150519
|
-
starts_at: string | null;
|
|
150520
|
-
/** Ending time for the access schedule. */
|
|
150521
|
-
ends_at: string | null;
|
|
150522
|
-
};
|
|
150523
|
-
/** New access schedule information. */
|
|
150524
|
-
to: {
|
|
150525
|
-
/** Starting time for the access schedule. */
|
|
150526
|
-
starts_at: string | null;
|
|
150527
|
-
/** Ending time for the access schedule. */
|
|
150528
|
-
ends_at: string | null;
|
|
150529
|
-
};
|
|
150530
|
-
} | {
|
|
150531
|
-
/** Date and time at which the mutation was created. */
|
|
150532
|
-
created_at: string;
|
|
150533
|
-
/** Detailed description of the mutation. */
|
|
150534
|
-
message: string;
|
|
150535
|
-
/** Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system. */
|
|
150536
|
-
mutation_code: 'updating_user_membership';
|
|
150537
|
-
/** Old user membership. */
|
|
150538
|
-
from: {
|
|
150539
|
-
/** Old user ID. */
|
|
150540
|
-
acs_user_id: string | null;
|
|
150541
|
-
};
|
|
150542
|
-
/** New user membership. */
|
|
150543
|
-
to: {
|
|
150544
|
-
/** New user ID. */
|
|
150545
|
-
acs_user_id: string | null;
|
|
150546
|
-
};
|
|
150547
|
-
} | {
|
|
150548
|
-
/** Date and time at which the mutation was created. */
|
|
150549
|
-
created_at: string;
|
|
150550
|
-
/** Detailed description of the mutation. */
|
|
150551
|
-
message: string;
|
|
150552
|
-
/** Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system. */
|
|
150553
|
-
mutation_code: 'updating_entrance_membership';
|
|
150554
|
-
/** Old entrance membership. */
|
|
150555
|
-
from: {
|
|
150556
|
-
/** Old entrance ID. */
|
|
150557
|
-
acs_entrance_id: string | null;
|
|
150558
|
-
};
|
|
150559
|
-
/** New entrance membership. */
|
|
150560
|
-
to: {
|
|
150561
|
-
/** New entrance ID. */
|
|
150562
|
-
acs_entrance_id: string | null;
|
|
150563
|
-
};
|
|
150564
|
-
} | {
|
|
150565
|
-
/** Date and time at which the mutation was created. */
|
|
150566
|
-
created_at: string;
|
|
150567
|
-
/** Detailed description of the mutation. */
|
|
150568
|
-
message: string;
|
|
150569
|
-
/** Mutation code to indicate that a scheduled user membership change is pending for this access group. */
|
|
150570
|
-
mutation_code: 'deferring_user_membership_update';
|
|
150571
|
-
/** ID of the user involved in the scheduled change. */
|
|
150572
|
-
acs_user_id: string;
|
|
150573
|
-
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
150574
|
-
variant: 'adding' | 'removing';
|
|
150575
|
-
} | {
|
|
150576
|
-
/** Date and time at which the mutation was created. */
|
|
150577
|
-
created_at: string;
|
|
150578
|
-
/** Detailed description of the mutation. */
|
|
150579
|
-
message: string;
|
|
150580
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
150595
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
150581
150596
|
mutation_code: 'deferring_deletion';
|
|
150582
|
-
})[];
|
|
150583
|
-
is_managed: false;
|
|
150584
|
-
};
|
|
150585
|
-
};
|
|
150586
|
-
maxDuration: undefined;
|
|
150587
|
-
};
|
|
150588
|
-
'/acs/access_groups/unmanaged/list': {
|
|
150589
|
-
route: '/acs/access_groups/unmanaged/list';
|
|
150590
|
-
method: 'GET' | 'POST';
|
|
150591
|
-
queryParams: {};
|
|
150592
|
-
jsonBody: {};
|
|
150593
|
-
commonParams: {
|
|
150594
|
-
/** ID of the access system for which you want to retrieve all unmanaged access groups. */
|
|
150595
|
-
acs_system_id?: string | undefined;
|
|
150596
|
-
/** ID of the access system user for which you want to retrieve all unmanaged access groups. */
|
|
150597
|
-
acs_user_id?: string | undefined;
|
|
150598
|
-
/** String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`. */
|
|
150599
|
-
search?: string | undefined;
|
|
150600
|
-
};
|
|
150601
|
-
formData: {};
|
|
150602
|
-
jsonResponse: {
|
|
150603
|
-
acs_access_groups: {
|
|
150604
|
-
/** ID of the access group. */
|
|
150605
|
-
acs_access_group_id: string;
|
|
150606
|
-
/** ID of the access control system that contains the access group. */
|
|
150607
|
-
acs_system_id: string;
|
|
150608
|
-
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
150609
|
-
workspace_id: string;
|
|
150610
|
-
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
150611
|
-
connected_account_id: string;
|
|
150612
|
-
/** Name of the access group. */
|
|
150613
|
-
name: string;
|
|
150614
|
-
/**
|
|
150615
|
-
* @deprecated Use `external_type`.*/
|
|
150616
|
-
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
|
|
150617
|
-
/**
|
|
150618
|
-
* @deprecated Use `external_type_display_name`.*/
|
|
150619
|
-
access_group_type_display_name: string;
|
|
150620
|
-
display_name: string;
|
|
150621
|
-
/** Brand-specific terminology for the access group type. */
|
|
150622
|
-
external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
|
|
150623
|
-
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
150624
|
-
external_type_display_name: string;
|
|
150625
|
-
/** Date and time at which the access group was created. */
|
|
150626
|
-
created_at: string;
|
|
150627
|
-
/** Warnings associated with the `acs_access_group`. */
|
|
150628
|
-
warnings: ({
|
|
150629
|
-
/** Date and time at which Seam created the warning. */
|
|
150630
|
-
created_at: string;
|
|
150631
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
150632
|
-
message: string;
|
|
150633
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
150634
|
-
warning_code: 'unknown_issue_with_acs_access_group';
|
|
150635
|
-
} | {
|
|
150636
|
-
/** Date and time at which Seam created the warning. */
|
|
150637
|
-
created_at: string;
|
|
150638
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
150639
|
-
message: string;
|
|
150640
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
150641
|
-
warning_code: 'being_deleted';
|
|
150642
|
-
})[];
|
|
150643
|
-
/** `starts_at` and `ends_at` timestamps for the access group's access. */
|
|
150644
|
-
access_schedule?: {
|
|
150645
|
-
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
150646
|
-
starts_at: string;
|
|
150647
|
-
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
150648
|
-
ends_at: string | null;
|
|
150649
|
-
} | undefined;
|
|
150650
|
-
/** Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system. */
|
|
150651
|
-
pending_mutations: ({
|
|
150652
|
-
/** Date and time at which the mutation was created. */
|
|
150653
|
-
created_at: string;
|
|
150654
|
-
/** Detailed description of the mutation. */
|
|
150655
|
-
message: string;
|
|
150656
|
-
/** Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system. */
|
|
150657
|
-
mutation_code: 'creating';
|
|
150658
|
-
} | {
|
|
150659
|
-
/** Date and time at which the mutation was created. */
|
|
150660
|
-
created_at: string;
|
|
150661
|
-
/** Detailed description of the mutation. */
|
|
150662
|
-
message: string;
|
|
150663
|
-
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
150664
|
-
mutation_code: 'deleting';
|
|
150665
150597
|
} | {
|
|
150666
150598
|
/** Date and time at which the mutation was created. */
|
|
150667
150599
|
created_at: string;
|
|
@@ -150745,13 +150677,179 @@ type Routes = {
|
|
|
150745
150677
|
acs_user_id: string;
|
|
150746
150678
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
150747
150679
|
variant: 'adding' | 'removing';
|
|
150680
|
+
})[];
|
|
150681
|
+
is_managed: false;
|
|
150682
|
+
};
|
|
150683
|
+
};
|
|
150684
|
+
maxDuration: undefined;
|
|
150685
|
+
};
|
|
150686
|
+
'/acs/access_groups/unmanaged/list': {
|
|
150687
|
+
route: '/acs/access_groups/unmanaged/list';
|
|
150688
|
+
method: 'GET' | 'POST';
|
|
150689
|
+
queryParams: {};
|
|
150690
|
+
jsonBody: {};
|
|
150691
|
+
commonParams: {
|
|
150692
|
+
/** ID of the access system for which you want to retrieve all unmanaged access groups. */
|
|
150693
|
+
acs_system_id?: string | undefined;
|
|
150694
|
+
/** ID of the access system user for which you want to retrieve all unmanaged access groups. */
|
|
150695
|
+
acs_user_id?: string | undefined;
|
|
150696
|
+
/** String for which to search. Filters returned access groups to include all records that satisfy a partial match using `name` or `acs_access_group_id`. */
|
|
150697
|
+
search?: string | undefined;
|
|
150698
|
+
};
|
|
150699
|
+
formData: {};
|
|
150700
|
+
jsonResponse: {
|
|
150701
|
+
acs_access_groups: {
|
|
150702
|
+
/** ID of the access group. */
|
|
150703
|
+
acs_access_group_id: string;
|
|
150704
|
+
/** ID of the access control system that contains the access group. */
|
|
150705
|
+
acs_system_id: string;
|
|
150706
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
|
|
150707
|
+
workspace_id: string;
|
|
150708
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
|
|
150709
|
+
connected_account_id: string;
|
|
150710
|
+
/** Name of the access group. */
|
|
150711
|
+
name: string;
|
|
150712
|
+
/**
|
|
150713
|
+
* @deprecated Use `external_type`.*/
|
|
150714
|
+
access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
|
|
150715
|
+
/**
|
|
150716
|
+
* @deprecated Use `external_type_display_name`.*/
|
|
150717
|
+
access_group_type_display_name: string;
|
|
150718
|
+
display_name: string;
|
|
150719
|
+
/** Brand-specific terminology for the access group type. */
|
|
150720
|
+
external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
|
|
150721
|
+
/** Display name that corresponds to the brand-specific terminology for the access group type. */
|
|
150722
|
+
external_type_display_name: string;
|
|
150723
|
+
/** Date and time at which the access group was created. */
|
|
150724
|
+
created_at: string;
|
|
150725
|
+
/** Warnings associated with the `acs_access_group`. */
|
|
150726
|
+
warnings: ({
|
|
150727
|
+
/** Date and time at which Seam created the warning. */
|
|
150728
|
+
created_at: string;
|
|
150729
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
150730
|
+
message: string;
|
|
150731
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
150732
|
+
warning_code: 'unknown_issue_with_acs_access_group';
|
|
150733
|
+
} | {
|
|
150734
|
+
/** Date and time at which Seam created the warning. */
|
|
150735
|
+
created_at: string;
|
|
150736
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
150737
|
+
message: string;
|
|
150738
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
150739
|
+
warning_code: 'being_deleted';
|
|
150740
|
+
})[];
|
|
150741
|
+
/** `starts_at` and `ends_at` timestamps for the access group's access. */
|
|
150742
|
+
access_schedule?: {
|
|
150743
|
+
/** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
150744
|
+
starts_at: string;
|
|
150745
|
+
/** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
150746
|
+
ends_at: string | null;
|
|
150747
|
+
} | undefined;
|
|
150748
|
+
/** Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system. */
|
|
150749
|
+
pending_mutations: ({
|
|
150750
|
+
/** Date and time at which the mutation was created. */
|
|
150751
|
+
created_at: string;
|
|
150752
|
+
/** Detailed description of the mutation. */
|
|
150753
|
+
message: string;
|
|
150754
|
+
/** Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system. */
|
|
150755
|
+
mutation_code: 'creating';
|
|
150756
|
+
} | {
|
|
150757
|
+
/** Date and time at which the mutation was created. */
|
|
150758
|
+
created_at: string;
|
|
150759
|
+
/** Detailed description of the mutation. */
|
|
150760
|
+
message: string;
|
|
150761
|
+
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
150762
|
+
mutation_code: 'deleting';
|
|
150748
150763
|
} | {
|
|
150749
150764
|
/** Date and time at which the mutation was created. */
|
|
150750
150765
|
created_at: string;
|
|
150751
150766
|
/** Detailed description of the mutation. */
|
|
150752
150767
|
message: string;
|
|
150753
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its
|
|
150768
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
150754
150769
|
mutation_code: 'deferring_deletion';
|
|
150770
|
+
} | {
|
|
150771
|
+
/** Date and time at which the mutation was created. */
|
|
150772
|
+
created_at: string;
|
|
150773
|
+
/** Detailed description of the mutation. */
|
|
150774
|
+
message: string;
|
|
150775
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system. */
|
|
150776
|
+
mutation_code: 'updating_group_information';
|
|
150777
|
+
/** Old access group information. */
|
|
150778
|
+
from: {
|
|
150779
|
+
/** Name of the access group. */
|
|
150780
|
+
name?: (string | null) | undefined;
|
|
150781
|
+
};
|
|
150782
|
+
/** New access group information. */
|
|
150783
|
+
to: {
|
|
150784
|
+
/** Name of the access group. */
|
|
150785
|
+
name?: (string | null) | undefined;
|
|
150786
|
+
};
|
|
150787
|
+
} | {
|
|
150788
|
+
/** Date and time at which the mutation was created. */
|
|
150789
|
+
created_at: string;
|
|
150790
|
+
/** Detailed description of the mutation. */
|
|
150791
|
+
message: string;
|
|
150792
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system. */
|
|
150793
|
+
mutation_code: 'updating_access_schedule';
|
|
150794
|
+
/** Old access schedule information. */
|
|
150795
|
+
from: {
|
|
150796
|
+
/** Starting time for the access schedule. */
|
|
150797
|
+
starts_at: string | null;
|
|
150798
|
+
/** Ending time for the access schedule. */
|
|
150799
|
+
ends_at: string | null;
|
|
150800
|
+
};
|
|
150801
|
+
/** New access schedule information. */
|
|
150802
|
+
to: {
|
|
150803
|
+
/** Starting time for the access schedule. */
|
|
150804
|
+
starts_at: string | null;
|
|
150805
|
+
/** Ending time for the access schedule. */
|
|
150806
|
+
ends_at: string | null;
|
|
150807
|
+
};
|
|
150808
|
+
} | {
|
|
150809
|
+
/** Date and time at which the mutation was created. */
|
|
150810
|
+
created_at: string;
|
|
150811
|
+
/** Detailed description of the mutation. */
|
|
150812
|
+
message: string;
|
|
150813
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system. */
|
|
150814
|
+
mutation_code: 'updating_user_membership';
|
|
150815
|
+
/** Old user membership. */
|
|
150816
|
+
from: {
|
|
150817
|
+
/** Old user ID. */
|
|
150818
|
+
acs_user_id: string | null;
|
|
150819
|
+
};
|
|
150820
|
+
/** New user membership. */
|
|
150821
|
+
to: {
|
|
150822
|
+
/** New user ID. */
|
|
150823
|
+
acs_user_id: string | null;
|
|
150824
|
+
};
|
|
150825
|
+
} | {
|
|
150826
|
+
/** Date and time at which the mutation was created. */
|
|
150827
|
+
created_at: string;
|
|
150828
|
+
/** Detailed description of the mutation. */
|
|
150829
|
+
message: string;
|
|
150830
|
+
/** Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system. */
|
|
150831
|
+
mutation_code: 'updating_entrance_membership';
|
|
150832
|
+
/** Old entrance membership. */
|
|
150833
|
+
from: {
|
|
150834
|
+
/** Old entrance ID. */
|
|
150835
|
+
acs_entrance_id: string | null;
|
|
150836
|
+
};
|
|
150837
|
+
/** New entrance membership. */
|
|
150838
|
+
to: {
|
|
150839
|
+
/** New entrance ID. */
|
|
150840
|
+
acs_entrance_id: string | null;
|
|
150841
|
+
};
|
|
150842
|
+
} | {
|
|
150843
|
+
/** Date and time at which the mutation was created. */
|
|
150844
|
+
created_at: string;
|
|
150845
|
+
/** Detailed description of the mutation. */
|
|
150846
|
+
message: string;
|
|
150847
|
+
/** Mutation code to indicate that a scheduled user membership change is pending for this access group. */
|
|
150848
|
+
mutation_code: 'deferring_user_membership_update';
|
|
150849
|
+
/** ID of the user involved in the scheduled change. */
|
|
150850
|
+
acs_user_id: string;
|
|
150851
|
+
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
150852
|
+
variant: 'adding' | 'removing';
|
|
150755
150853
|
})[];
|
|
150756
150854
|
is_managed: false;
|
|
150757
150855
|
}[];
|
|
@@ -151803,6 +151901,8 @@ type Routes = {
|
|
|
151803
151901
|
can_unlock_with_code?: boolean | undefined;
|
|
151804
151902
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
151805
151903
|
can_belong_to_reservation?: boolean | undefined;
|
|
151904
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
151905
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
151806
151906
|
}[];
|
|
151807
151907
|
};
|
|
151808
151908
|
maxDuration: undefined;
|
|
@@ -153699,101 +153799,1797 @@ type Routes = {
|
|
|
153699
153799
|
};
|
|
153700
153800
|
maxDuration: undefined;
|
|
153701
153801
|
};
|
|
153702
|
-
'/acs/encoders/get': {
|
|
153703
|
-
route: '/acs/encoders/get';
|
|
153802
|
+
'/acs/encoders/get': {
|
|
153803
|
+
route: '/acs/encoders/get';
|
|
153804
|
+
method: 'GET' | 'POST';
|
|
153805
|
+
queryParams: {};
|
|
153806
|
+
jsonBody: {};
|
|
153807
|
+
commonParams: {
|
|
153808
|
+
/** ID of the encoder that you want to get. */
|
|
153809
|
+
acs_encoder_id: string;
|
|
153810
|
+
};
|
|
153811
|
+
formData: {};
|
|
153812
|
+
jsonResponse: {
|
|
153813
|
+
/** Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
153814
|
+
|
|
153815
|
+
Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
|
|
153816
|
+
|
|
153817
|
+
1. Credential creation
|
|
153818
|
+
Configure the access parameters for the credential.
|
|
153819
|
+
2. Card encoding
|
|
153820
|
+
Write the credential data onto the card using a compatible card encoder.
|
|
153821
|
+
|
|
153822
|
+
Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
|
|
153823
|
+
|
|
153824
|
+
See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
|
|
153825
|
+
|
|
153826
|
+
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
|
|
153827
|
+
acs_encoder: {
|
|
153828
|
+
/** ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. */
|
|
153829
|
+
acs_encoder_id: string;
|
|
153830
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153831
|
+
acs_system_id: string;
|
|
153832
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153833
|
+
connected_account_id: string;
|
|
153834
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153835
|
+
workspace_id: string;
|
|
153836
|
+
/** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153837
|
+
errors: {
|
|
153838
|
+
/** Date and time at which Seam created the error. */
|
|
153839
|
+
created_at: string;
|
|
153840
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
153841
|
+
message: string;
|
|
153842
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
153843
|
+
error_code: 'acs_encoder_removed';
|
|
153844
|
+
}[];
|
|
153845
|
+
/** Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created. */
|
|
153846
|
+
created_at: string;
|
|
153847
|
+
/** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153848
|
+
display_name: string;
|
|
153849
|
+
};
|
|
153850
|
+
};
|
|
153851
|
+
maxDuration: undefined;
|
|
153852
|
+
};
|
|
153853
|
+
'/acs/encoders/list': {
|
|
153854
|
+
route: '/acs/encoders/list';
|
|
153855
|
+
method: 'GET' | 'POST';
|
|
153856
|
+
queryParams: {};
|
|
153857
|
+
jsonBody: {};
|
|
153858
|
+
commonParams: ({
|
|
153859
|
+
/** ID of the access system for which you want to retrieve all encoders. */
|
|
153860
|
+
acs_system_id: string;
|
|
153861
|
+
} | {
|
|
153862
|
+
/** IDs of the access systems for which you want to retrieve all encoders. */
|
|
153863
|
+
acs_system_ids: string[];
|
|
153864
|
+
} | {
|
|
153865
|
+
/** IDs of the encoders that you want to retrieve. */
|
|
153866
|
+
acs_encoder_ids: string[];
|
|
153867
|
+
}) & {
|
|
153868
|
+
/** Number of encoders to return. */
|
|
153869
|
+
limit?: number;
|
|
153870
|
+
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
153871
|
+
page_cursor?: (string | undefined) | null;
|
|
153872
|
+
};
|
|
153873
|
+
formData: {};
|
|
153874
|
+
jsonResponse: {
|
|
153875
|
+
acs_encoders: {
|
|
153876
|
+
/** ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. */
|
|
153877
|
+
acs_encoder_id: string;
|
|
153878
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153879
|
+
acs_system_id: string;
|
|
153880
|
+
/** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153881
|
+
connected_account_id: string;
|
|
153882
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153883
|
+
workspace_id: string;
|
|
153884
|
+
/** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153885
|
+
errors: {
|
|
153886
|
+
/** Date and time at which Seam created the error. */
|
|
153887
|
+
created_at: string;
|
|
153888
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
153889
|
+
message: string;
|
|
153890
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
153891
|
+
error_code: 'acs_encoder_removed';
|
|
153892
|
+
}[];
|
|
153893
|
+
/** Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created. */
|
|
153894
|
+
created_at: string;
|
|
153895
|
+
/** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
153896
|
+
display_name: string;
|
|
153897
|
+
}[];
|
|
153898
|
+
/** Information about the current page of results. */
|
|
153899
|
+
pagination: {
|
|
153900
|
+
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
153901
|
+
next_page_cursor: string | null;
|
|
153902
|
+
/** Indicates whether there is another page of results after this one. */
|
|
153903
|
+
has_next_page: boolean;
|
|
153904
|
+
/** URL to get the next page of results. */
|
|
153905
|
+
next_page_url: string | null;
|
|
153906
|
+
};
|
|
153907
|
+
};
|
|
153908
|
+
maxDuration: undefined;
|
|
153909
|
+
};
|
|
153910
|
+
'/acs/encoders/scan_credential': {
|
|
153911
|
+
route: '/acs/encoders/scan_credential';
|
|
153912
|
+
method: 'POST';
|
|
153913
|
+
queryParams: {};
|
|
153914
|
+
jsonBody: {};
|
|
153915
|
+
commonParams: {
|
|
153916
|
+
/** ID of the encoder to use for the scan. */
|
|
153917
|
+
acs_encoder_id: string;
|
|
153918
|
+
};
|
|
153919
|
+
formData: {};
|
|
153920
|
+
jsonResponse: {
|
|
153921
|
+
/** 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.
|
|
153922
|
+
|
|
153923
|
+
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.
|
|
153924
|
+
|
|
153925
|
+
See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
|
|
153926
|
+
action_attempt: {
|
|
153927
|
+
/** ID of the action attempt. */
|
|
153928
|
+
action_attempt_id: string;
|
|
153929
|
+
status: 'pending';
|
|
153930
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
153931
|
+
result: null;
|
|
153932
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
153933
|
+
error: null;
|
|
153934
|
+
/** Action attempt to track the status of locking a door. */
|
|
153935
|
+
action_type: 'LOCK_DOOR';
|
|
153936
|
+
} | {
|
|
153937
|
+
/** ID of the action attempt. */
|
|
153938
|
+
action_attempt_id: string;
|
|
153939
|
+
status: 'success';
|
|
153940
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
153941
|
+
error: null;
|
|
153942
|
+
/** Action attempt to track the status of locking a door. */
|
|
153943
|
+
action_type: 'LOCK_DOOR';
|
|
153944
|
+
/** Result of the action. */
|
|
153945
|
+
result: {
|
|
153946
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
153947
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
153948
|
+
};
|
|
153949
|
+
} | {
|
|
153950
|
+
/** ID of the action attempt. */
|
|
153951
|
+
action_attempt_id: string;
|
|
153952
|
+
status: 'error';
|
|
153953
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
153954
|
+
result: null;
|
|
153955
|
+
/** Action attempt to track the status of locking a door. */
|
|
153956
|
+
action_type: 'LOCK_DOOR';
|
|
153957
|
+
/** Error associated with the action. */
|
|
153958
|
+
error: {
|
|
153959
|
+
/** Type of the error. */
|
|
153960
|
+
type: string;
|
|
153961
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
153962
|
+
message: string;
|
|
153963
|
+
};
|
|
153964
|
+
} | {
|
|
153965
|
+
/** ID of the action attempt. */
|
|
153966
|
+
action_attempt_id: string;
|
|
153967
|
+
status: 'pending';
|
|
153968
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
153969
|
+
result: null;
|
|
153970
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
153971
|
+
error: null;
|
|
153972
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
153973
|
+
action_type: 'UNLOCK_DOOR';
|
|
153974
|
+
} | {
|
|
153975
|
+
/** ID of the action attempt. */
|
|
153976
|
+
action_attempt_id: string;
|
|
153977
|
+
status: 'success';
|
|
153978
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
153979
|
+
error: null;
|
|
153980
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
153981
|
+
action_type: 'UNLOCK_DOOR';
|
|
153982
|
+
/** Result of the action. */
|
|
153983
|
+
result: {
|
|
153984
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
153985
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
153986
|
+
};
|
|
153987
|
+
} | {
|
|
153988
|
+
/** ID of the action attempt. */
|
|
153989
|
+
action_attempt_id: string;
|
|
153990
|
+
status: 'error';
|
|
153991
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
153992
|
+
result: null;
|
|
153993
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
153994
|
+
action_type: 'UNLOCK_DOOR';
|
|
153995
|
+
/** Error associated with the action. */
|
|
153996
|
+
error: {
|
|
153997
|
+
/** Type of the error. */
|
|
153998
|
+
type: string;
|
|
153999
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154000
|
+
message: string;
|
|
154001
|
+
};
|
|
154002
|
+
} | {
|
|
154003
|
+
/** ID of the action attempt. */
|
|
154004
|
+
action_attempt_id: string;
|
|
154005
|
+
status: 'pending';
|
|
154006
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154007
|
+
result: null;
|
|
154008
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154009
|
+
error: null;
|
|
154010
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
154011
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
154012
|
+
} | {
|
|
154013
|
+
/** ID of the action attempt. */
|
|
154014
|
+
action_attempt_id: string;
|
|
154015
|
+
status: 'success';
|
|
154016
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154017
|
+
error: null;
|
|
154018
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
154019
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
154020
|
+
/** 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. */
|
|
154021
|
+
result: {
|
|
154022
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
154023
|
+
acs_credential_on_encoder: {
|
|
154024
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
154025
|
+
created_at: string | null;
|
|
154026
|
+
is_issued: boolean | null;
|
|
154027
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
154028
|
+
starts_at: string | null;
|
|
154029
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
154030
|
+
ends_at: string | null;
|
|
154031
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154032
|
+
card_number: string | null;
|
|
154033
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154034
|
+
visionline_metadata?: {
|
|
154035
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154036
|
+
card_id: string;
|
|
154037
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
154038
|
+
cancelled: boolean;
|
|
154039
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
154040
|
+
discarded: boolean;
|
|
154041
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
154042
|
+
expired: boolean;
|
|
154043
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
154044
|
+
overwritten: boolean;
|
|
154045
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
154046
|
+
overridden?: boolean | undefined;
|
|
154047
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
154048
|
+
pending_auto_update: boolean;
|
|
154049
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154050
|
+
card_format: 'TLCode' | 'rfid48';
|
|
154051
|
+
/** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154052
|
+
card_holder?: string | undefined;
|
|
154053
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154054
|
+
number_of_issued_cards: number;
|
|
154055
|
+
/** 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). */
|
|
154056
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
154057
|
+
/** 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). */
|
|
154058
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
154059
|
+
} | undefined;
|
|
154060
|
+
} | null;
|
|
154061
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
154062
|
+
acs_credential_on_seam: ({
|
|
154063
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154064
|
+
acs_credential_id: string;
|
|
154065
|
+
/** 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. */
|
|
154066
|
+
acs_user_id?: string | undefined;
|
|
154067
|
+
/** 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. */
|
|
154068
|
+
user_identity_id?: string | undefined;
|
|
154069
|
+
/** 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. */
|
|
154070
|
+
connected_account_id: string;
|
|
154071
|
+
acs_credential_pool_id?: string | undefined;
|
|
154072
|
+
/** 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). */
|
|
154073
|
+
acs_system_id: string;
|
|
154074
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154075
|
+
parent_acs_credential_id?: string | undefined;
|
|
154076
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154077
|
+
display_name: string;
|
|
154078
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154079
|
+
code?: (string | undefined) | null;
|
|
154080
|
+
/** 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. */
|
|
154081
|
+
is_one_time_use?: boolean | undefined;
|
|
154082
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154083
|
+
card_number?: (string | undefined) | null;
|
|
154084
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
154085
|
+
is_issued?: boolean | undefined;
|
|
154086
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
154087
|
+
issued_at?: (string | undefined) | null;
|
|
154088
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
154089
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
154090
|
+
/** 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`. */
|
|
154091
|
+
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;
|
|
154092
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154093
|
+
external_type_display_name?: string | undefined;
|
|
154094
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
154095
|
+
created_at: string;
|
|
154096
|
+
/** 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). */
|
|
154097
|
+
workspace_id: string;
|
|
154098
|
+
/** 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. */
|
|
154099
|
+
starts_at?: string | undefined;
|
|
154100
|
+
/** 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`. */
|
|
154101
|
+
ends_at?: string | undefined;
|
|
154102
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154103
|
+
errors: {
|
|
154104
|
+
error_code: string;
|
|
154105
|
+
message: string;
|
|
154106
|
+
}[];
|
|
154107
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154108
|
+
warnings: ({
|
|
154109
|
+
/** Date and time at which Seam created the warning. */
|
|
154110
|
+
created_at: string;
|
|
154111
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154112
|
+
message: string;
|
|
154113
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154114
|
+
warning_code: 'waiting_to_be_issued';
|
|
154115
|
+
} | {
|
|
154116
|
+
/** Date and time at which Seam created the warning. */
|
|
154117
|
+
created_at: string;
|
|
154118
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154119
|
+
message: string;
|
|
154120
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154121
|
+
warning_code: 'schedule_externally_modified';
|
|
154122
|
+
} | {
|
|
154123
|
+
/** Date and time at which Seam created the warning. */
|
|
154124
|
+
created_at: string;
|
|
154125
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154126
|
+
message: string;
|
|
154127
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154128
|
+
warning_code: 'schedule_modified';
|
|
154129
|
+
} | {
|
|
154130
|
+
/** Date and time at which Seam created the warning. */
|
|
154131
|
+
created_at: string;
|
|
154132
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154133
|
+
message: string;
|
|
154134
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154135
|
+
warning_code: 'being_deleted';
|
|
154136
|
+
} | {
|
|
154137
|
+
/** Date and time at which Seam created the warning. */
|
|
154138
|
+
created_at: string;
|
|
154139
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154140
|
+
message: string;
|
|
154141
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154142
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
154143
|
+
} | {
|
|
154144
|
+
/** Date and time at which Seam created the warning. */
|
|
154145
|
+
created_at: string;
|
|
154146
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154147
|
+
message: string;
|
|
154148
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154149
|
+
warning_code: 'needs_to_be_reissued';
|
|
154150
|
+
})[];
|
|
154151
|
+
/** 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). */
|
|
154152
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
154153
|
+
/** 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. */
|
|
154154
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
154155
|
+
/** 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. */
|
|
154156
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
154157
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154158
|
+
visionline_metadata?: {
|
|
154159
|
+
/** Card function type in the Visionline access system. */
|
|
154160
|
+
card_function_type: 'guest' | 'staff';
|
|
154161
|
+
/** IDs of the credentials to which you want to join. */
|
|
154162
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
154163
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
154164
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
154165
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
154166
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
154167
|
+
/** Indicates whether the credential is valid. */
|
|
154168
|
+
is_valid?: boolean | undefined;
|
|
154169
|
+
/** 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. */
|
|
154170
|
+
auto_join?: boolean | undefined;
|
|
154171
|
+
/** ID of the card in the Visionline access system. */
|
|
154172
|
+
card_id?: string | undefined;
|
|
154173
|
+
/** ID of the credential in the Visionline access system. */
|
|
154174
|
+
credential_id?: string | undefined;
|
|
154175
|
+
} | undefined;
|
|
154176
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154177
|
+
assa_abloy_vostio_metadata?: {
|
|
154178
|
+
/** 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. */
|
|
154179
|
+
auto_join?: boolean | undefined;
|
|
154180
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
154181
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
154182
|
+
/** Key ID in the Vostio access system. */
|
|
154183
|
+
key_id?: string | undefined;
|
|
154184
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
154185
|
+
key_issuing_request_id?: string | undefined;
|
|
154186
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
154187
|
+
door_names?: string[] | undefined;
|
|
154188
|
+
/** Endpoint ID in the Vostio access system. */
|
|
154189
|
+
endpoint_id?: string | undefined;
|
|
154190
|
+
} | undefined;
|
|
154191
|
+
is_managed: true;
|
|
154192
|
+
} | {
|
|
154193
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154194
|
+
acs_credential_id: string;
|
|
154195
|
+
/** 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. */
|
|
154196
|
+
acs_user_id?: string | undefined;
|
|
154197
|
+
/** 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. */
|
|
154198
|
+
user_identity_id?: string | undefined;
|
|
154199
|
+
/** 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. */
|
|
154200
|
+
connected_account_id: string;
|
|
154201
|
+
acs_credential_pool_id?: string | undefined;
|
|
154202
|
+
/** 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). */
|
|
154203
|
+
acs_system_id: string;
|
|
154204
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154205
|
+
parent_acs_credential_id?: string | undefined;
|
|
154206
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154207
|
+
display_name: string;
|
|
154208
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154209
|
+
code?: (string | undefined) | null;
|
|
154210
|
+
/** 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. */
|
|
154211
|
+
is_one_time_use?: boolean | undefined;
|
|
154212
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154213
|
+
card_number?: (string | undefined) | null;
|
|
154214
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
154215
|
+
is_issued?: boolean | undefined;
|
|
154216
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
154217
|
+
issued_at?: (string | undefined) | null;
|
|
154218
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
154219
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
154220
|
+
/** 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`. */
|
|
154221
|
+
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;
|
|
154222
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154223
|
+
external_type_display_name?: string | undefined;
|
|
154224
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
154225
|
+
created_at: string;
|
|
154226
|
+
/** 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). */
|
|
154227
|
+
workspace_id: string;
|
|
154228
|
+
/** 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. */
|
|
154229
|
+
starts_at?: string | undefined;
|
|
154230
|
+
/** 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`. */
|
|
154231
|
+
ends_at?: string | undefined;
|
|
154232
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154233
|
+
errors: {
|
|
154234
|
+
error_code: string;
|
|
154235
|
+
message: string;
|
|
154236
|
+
}[];
|
|
154237
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154238
|
+
warnings: ({
|
|
154239
|
+
/** Date and time at which Seam created the warning. */
|
|
154240
|
+
created_at: string;
|
|
154241
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154242
|
+
message: string;
|
|
154243
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154244
|
+
warning_code: 'waiting_to_be_issued';
|
|
154245
|
+
} | {
|
|
154246
|
+
/** Date and time at which Seam created the warning. */
|
|
154247
|
+
created_at: string;
|
|
154248
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154249
|
+
message: string;
|
|
154250
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154251
|
+
warning_code: 'schedule_externally_modified';
|
|
154252
|
+
} | {
|
|
154253
|
+
/** Date and time at which Seam created the warning. */
|
|
154254
|
+
created_at: string;
|
|
154255
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154256
|
+
message: string;
|
|
154257
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154258
|
+
warning_code: 'schedule_modified';
|
|
154259
|
+
} | {
|
|
154260
|
+
/** Date and time at which Seam created the warning. */
|
|
154261
|
+
created_at: string;
|
|
154262
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154263
|
+
message: string;
|
|
154264
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154265
|
+
warning_code: 'being_deleted';
|
|
154266
|
+
} | {
|
|
154267
|
+
/** Date and time at which Seam created the warning. */
|
|
154268
|
+
created_at: string;
|
|
154269
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154270
|
+
message: string;
|
|
154271
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154272
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
154273
|
+
} | {
|
|
154274
|
+
/** Date and time at which Seam created the warning. */
|
|
154275
|
+
created_at: string;
|
|
154276
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154277
|
+
message: string;
|
|
154278
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154279
|
+
warning_code: 'needs_to_be_reissued';
|
|
154280
|
+
})[];
|
|
154281
|
+
/** 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). */
|
|
154282
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
154283
|
+
/** 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. */
|
|
154284
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
154285
|
+
/** 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. */
|
|
154286
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
154287
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154288
|
+
visionline_metadata?: {
|
|
154289
|
+
/** Card function type in the Visionline access system. */
|
|
154290
|
+
card_function_type: 'guest' | 'staff';
|
|
154291
|
+
/** IDs of the credentials to which you want to join. */
|
|
154292
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
154293
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
154294
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
154295
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
154296
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
154297
|
+
/** Indicates whether the credential is valid. */
|
|
154298
|
+
is_valid?: boolean | undefined;
|
|
154299
|
+
/** 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. */
|
|
154300
|
+
auto_join?: boolean | undefined;
|
|
154301
|
+
/** ID of the card in the Visionline access system. */
|
|
154302
|
+
card_id?: string | undefined;
|
|
154303
|
+
/** ID of the credential in the Visionline access system. */
|
|
154304
|
+
credential_id?: string | undefined;
|
|
154305
|
+
} | undefined;
|
|
154306
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154307
|
+
assa_abloy_vostio_metadata?: {
|
|
154308
|
+
/** 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. */
|
|
154309
|
+
auto_join?: boolean | undefined;
|
|
154310
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
154311
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
154312
|
+
/** Key ID in the Vostio access system. */
|
|
154313
|
+
key_id?: string | undefined;
|
|
154314
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
154315
|
+
key_issuing_request_id?: string | undefined;
|
|
154316
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
154317
|
+
door_names?: string[] | undefined;
|
|
154318
|
+
/** Endpoint ID in the Vostio access system. */
|
|
154319
|
+
endpoint_id?: string | undefined;
|
|
154320
|
+
} | undefined;
|
|
154321
|
+
is_managed: false;
|
|
154322
|
+
}) | null;
|
|
154323
|
+
/** 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. */
|
|
154324
|
+
warnings: {
|
|
154325
|
+
/** Indicates a warning related to scanning a credential. */
|
|
154326
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
154327
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154328
|
+
warning_message: string;
|
|
154329
|
+
}[];
|
|
154330
|
+
};
|
|
154331
|
+
} | {
|
|
154332
|
+
/** ID of the action attempt. */
|
|
154333
|
+
action_attempt_id: string;
|
|
154334
|
+
status: 'error';
|
|
154335
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154336
|
+
result: null;
|
|
154337
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
154338
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
154339
|
+
error: {
|
|
154340
|
+
/** Type of the error associated with the action attempt. */
|
|
154341
|
+
type: 'uncategorized_error';
|
|
154342
|
+
/** Message for the error associated with the action attempt. */
|
|
154343
|
+
message: string;
|
|
154344
|
+
} | {
|
|
154345
|
+
/** Type of the error associated with the action attempt. */
|
|
154346
|
+
type: 'action_attempt_expired';
|
|
154347
|
+
/** Message for the error associated with the action attempt. */
|
|
154348
|
+
message: string;
|
|
154349
|
+
} | {
|
|
154350
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
154351
|
+
type: 'no_credential_on_encoder';
|
|
154352
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154353
|
+
message: string;
|
|
154354
|
+
} | {
|
|
154355
|
+
/** Error type to indicate that the encoder is not online. */
|
|
154356
|
+
type: 'encoder_not_online';
|
|
154357
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154358
|
+
message: string;
|
|
154359
|
+
};
|
|
154360
|
+
} | {
|
|
154361
|
+
/** ID of the action attempt. */
|
|
154362
|
+
action_attempt_id: string;
|
|
154363
|
+
status: 'pending';
|
|
154364
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154365
|
+
result: null;
|
|
154366
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154367
|
+
error: null;
|
|
154368
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
154369
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
154370
|
+
} | {
|
|
154371
|
+
/** ID of the action attempt. */
|
|
154372
|
+
action_attempt_id: string;
|
|
154373
|
+
status: 'success';
|
|
154374
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154375
|
+
error: null;
|
|
154376
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
154377
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
154378
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
154379
|
+
result: {
|
|
154380
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154381
|
+
acs_credential_id: string;
|
|
154382
|
+
/** 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. */
|
|
154383
|
+
acs_user_id?: string | undefined;
|
|
154384
|
+
/** 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. */
|
|
154385
|
+
user_identity_id?: string | undefined;
|
|
154386
|
+
/** 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. */
|
|
154387
|
+
connected_account_id: string;
|
|
154388
|
+
acs_credential_pool_id?: string | undefined;
|
|
154389
|
+
/** 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). */
|
|
154390
|
+
acs_system_id: string;
|
|
154391
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154392
|
+
parent_acs_credential_id?: string | undefined;
|
|
154393
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154394
|
+
display_name: string;
|
|
154395
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154396
|
+
code?: (string | undefined) | null;
|
|
154397
|
+
/** 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. */
|
|
154398
|
+
is_one_time_use?: boolean | undefined;
|
|
154399
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154400
|
+
card_number?: (string | undefined) | null;
|
|
154401
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
154402
|
+
is_issued?: boolean | undefined;
|
|
154403
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
154404
|
+
issued_at?: (string | undefined) | null;
|
|
154405
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
154406
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
154407
|
+
/** 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`. */
|
|
154408
|
+
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;
|
|
154409
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154410
|
+
external_type_display_name?: string | undefined;
|
|
154411
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
154412
|
+
created_at: string;
|
|
154413
|
+
/** 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). */
|
|
154414
|
+
workspace_id: string;
|
|
154415
|
+
/** 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. */
|
|
154416
|
+
starts_at?: string | undefined;
|
|
154417
|
+
/** 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`. */
|
|
154418
|
+
ends_at?: string | undefined;
|
|
154419
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154420
|
+
errors: {
|
|
154421
|
+
error_code: string;
|
|
154422
|
+
message: string;
|
|
154423
|
+
}[];
|
|
154424
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154425
|
+
warnings: ({
|
|
154426
|
+
/** Date and time at which Seam created the warning. */
|
|
154427
|
+
created_at: string;
|
|
154428
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154429
|
+
message: string;
|
|
154430
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154431
|
+
warning_code: 'waiting_to_be_issued';
|
|
154432
|
+
} | {
|
|
154433
|
+
/** Date and time at which Seam created the warning. */
|
|
154434
|
+
created_at: string;
|
|
154435
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154436
|
+
message: string;
|
|
154437
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154438
|
+
warning_code: 'schedule_externally_modified';
|
|
154439
|
+
} | {
|
|
154440
|
+
/** Date and time at which Seam created the warning. */
|
|
154441
|
+
created_at: string;
|
|
154442
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154443
|
+
message: string;
|
|
154444
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154445
|
+
warning_code: 'schedule_modified';
|
|
154446
|
+
} | {
|
|
154447
|
+
/** Date and time at which Seam created the warning. */
|
|
154448
|
+
created_at: string;
|
|
154449
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154450
|
+
message: string;
|
|
154451
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154452
|
+
warning_code: 'being_deleted';
|
|
154453
|
+
} | {
|
|
154454
|
+
/** Date and time at which Seam created the warning. */
|
|
154455
|
+
created_at: string;
|
|
154456
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154457
|
+
message: string;
|
|
154458
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154459
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
154460
|
+
} | {
|
|
154461
|
+
/** Date and time at which Seam created the warning. */
|
|
154462
|
+
created_at: string;
|
|
154463
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154464
|
+
message: string;
|
|
154465
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154466
|
+
warning_code: 'needs_to_be_reissued';
|
|
154467
|
+
})[];
|
|
154468
|
+
/** 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). */
|
|
154469
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
154470
|
+
/** 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. */
|
|
154471
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
154472
|
+
/** 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. */
|
|
154473
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
154474
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154475
|
+
visionline_metadata?: {
|
|
154476
|
+
/** Card function type in the Visionline access system. */
|
|
154477
|
+
card_function_type: 'guest' | 'staff';
|
|
154478
|
+
/** IDs of the credentials to which you want to join. */
|
|
154479
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
154480
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
154481
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
154482
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
154483
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
154484
|
+
/** Indicates whether the credential is valid. */
|
|
154485
|
+
is_valid?: boolean | undefined;
|
|
154486
|
+
/** 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. */
|
|
154487
|
+
auto_join?: boolean | undefined;
|
|
154488
|
+
/** ID of the card in the Visionline access system. */
|
|
154489
|
+
card_id?: string | undefined;
|
|
154490
|
+
/** ID of the credential in the Visionline access system. */
|
|
154491
|
+
credential_id?: string | undefined;
|
|
154492
|
+
} | undefined;
|
|
154493
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154494
|
+
assa_abloy_vostio_metadata?: {
|
|
154495
|
+
/** 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. */
|
|
154496
|
+
auto_join?: boolean | undefined;
|
|
154497
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
154498
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
154499
|
+
/** Key ID in the Vostio access system. */
|
|
154500
|
+
key_id?: string | undefined;
|
|
154501
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
154502
|
+
key_issuing_request_id?: string | undefined;
|
|
154503
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
154504
|
+
door_names?: string[] | undefined;
|
|
154505
|
+
/** Endpoint ID in the Vostio access system. */
|
|
154506
|
+
endpoint_id?: string | undefined;
|
|
154507
|
+
} | undefined;
|
|
154508
|
+
is_managed: true;
|
|
154509
|
+
} | {
|
|
154510
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154511
|
+
acs_credential_id: string;
|
|
154512
|
+
/** 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. */
|
|
154513
|
+
acs_user_id?: string | undefined;
|
|
154514
|
+
/** 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. */
|
|
154515
|
+
user_identity_id?: string | undefined;
|
|
154516
|
+
/** 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. */
|
|
154517
|
+
connected_account_id: string;
|
|
154518
|
+
acs_credential_pool_id?: string | undefined;
|
|
154519
|
+
/** 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). */
|
|
154520
|
+
acs_system_id: string;
|
|
154521
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154522
|
+
parent_acs_credential_id?: string | undefined;
|
|
154523
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154524
|
+
display_name: string;
|
|
154525
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154526
|
+
code?: (string | undefined) | null;
|
|
154527
|
+
/** 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. */
|
|
154528
|
+
is_one_time_use?: boolean | undefined;
|
|
154529
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154530
|
+
card_number?: (string | undefined) | null;
|
|
154531
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
154532
|
+
is_issued?: boolean | undefined;
|
|
154533
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
154534
|
+
issued_at?: (string | undefined) | null;
|
|
154535
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
154536
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
154537
|
+
/** 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`. */
|
|
154538
|
+
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;
|
|
154539
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
154540
|
+
external_type_display_name?: string | undefined;
|
|
154541
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
154542
|
+
created_at: string;
|
|
154543
|
+
/** 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). */
|
|
154544
|
+
workspace_id: string;
|
|
154545
|
+
/** 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. */
|
|
154546
|
+
starts_at?: string | undefined;
|
|
154547
|
+
/** 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`. */
|
|
154548
|
+
ends_at?: string | undefined;
|
|
154549
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154550
|
+
errors: {
|
|
154551
|
+
error_code: string;
|
|
154552
|
+
message: string;
|
|
154553
|
+
}[];
|
|
154554
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154555
|
+
warnings: ({
|
|
154556
|
+
/** Date and time at which Seam created the warning. */
|
|
154557
|
+
created_at: string;
|
|
154558
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154559
|
+
message: string;
|
|
154560
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154561
|
+
warning_code: 'waiting_to_be_issued';
|
|
154562
|
+
} | {
|
|
154563
|
+
/** Date and time at which Seam created the warning. */
|
|
154564
|
+
created_at: string;
|
|
154565
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154566
|
+
message: string;
|
|
154567
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154568
|
+
warning_code: 'schedule_externally_modified';
|
|
154569
|
+
} | {
|
|
154570
|
+
/** Date and time at which Seam created the warning. */
|
|
154571
|
+
created_at: string;
|
|
154572
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154573
|
+
message: string;
|
|
154574
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154575
|
+
warning_code: 'schedule_modified';
|
|
154576
|
+
} | {
|
|
154577
|
+
/** Date and time at which Seam created the warning. */
|
|
154578
|
+
created_at: string;
|
|
154579
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154580
|
+
message: string;
|
|
154581
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154582
|
+
warning_code: 'being_deleted';
|
|
154583
|
+
} | {
|
|
154584
|
+
/** Date and time at which Seam created the warning. */
|
|
154585
|
+
created_at: string;
|
|
154586
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154587
|
+
message: string;
|
|
154588
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154589
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
154590
|
+
} | {
|
|
154591
|
+
/** Date and time at which Seam created the warning. */
|
|
154592
|
+
created_at: string;
|
|
154593
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
154594
|
+
message: string;
|
|
154595
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
154596
|
+
warning_code: 'needs_to_be_reissued';
|
|
154597
|
+
})[];
|
|
154598
|
+
/** 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). */
|
|
154599
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
154600
|
+
/** 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. */
|
|
154601
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
154602
|
+
/** 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. */
|
|
154603
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
154604
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154605
|
+
visionline_metadata?: {
|
|
154606
|
+
/** Card function type in the Visionline access system. */
|
|
154607
|
+
card_function_type: 'guest' | 'staff';
|
|
154608
|
+
/** IDs of the credentials to which you want to join. */
|
|
154609
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
154610
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
154611
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
154612
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
154613
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
154614
|
+
/** Indicates whether the credential is valid. */
|
|
154615
|
+
is_valid?: boolean | undefined;
|
|
154616
|
+
/** 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. */
|
|
154617
|
+
auto_join?: boolean | undefined;
|
|
154618
|
+
/** ID of the card in the Visionline access system. */
|
|
154619
|
+
card_id?: string | undefined;
|
|
154620
|
+
/** ID of the credential in the Visionline access system. */
|
|
154621
|
+
credential_id?: string | undefined;
|
|
154622
|
+
} | undefined;
|
|
154623
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
154624
|
+
assa_abloy_vostio_metadata?: {
|
|
154625
|
+
/** 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. */
|
|
154626
|
+
auto_join?: boolean | undefined;
|
|
154627
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
154628
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
154629
|
+
/** Key ID in the Vostio access system. */
|
|
154630
|
+
key_id?: string | undefined;
|
|
154631
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
154632
|
+
key_issuing_request_id?: string | undefined;
|
|
154633
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
154634
|
+
door_names?: string[] | undefined;
|
|
154635
|
+
/** Endpoint ID in the Vostio access system. */
|
|
154636
|
+
endpoint_id?: string | undefined;
|
|
154637
|
+
} | undefined;
|
|
154638
|
+
is_managed: false;
|
|
154639
|
+
};
|
|
154640
|
+
} | {
|
|
154641
|
+
/** ID of the action attempt. */
|
|
154642
|
+
action_attempt_id: string;
|
|
154643
|
+
status: 'error';
|
|
154644
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154645
|
+
result: null;
|
|
154646
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
154647
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
154648
|
+
error: {
|
|
154649
|
+
/** Type of the error associated with the action attempt. */
|
|
154650
|
+
type: 'uncategorized_error';
|
|
154651
|
+
/** Message for the error associated with the action attempt. */
|
|
154652
|
+
message: string;
|
|
154653
|
+
} | {
|
|
154654
|
+
/** Type of the error associated with the action attempt. */
|
|
154655
|
+
type: 'action_attempt_expired';
|
|
154656
|
+
/** Message for the error associated with the action attempt. */
|
|
154657
|
+
message: string;
|
|
154658
|
+
} | {
|
|
154659
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
154660
|
+
type: 'no_credential_on_encoder';
|
|
154661
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154662
|
+
message: string;
|
|
154663
|
+
} | {
|
|
154664
|
+
/** Error type to indicate an incompatible card format. */
|
|
154665
|
+
type: 'incompatible_card_format';
|
|
154666
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154667
|
+
message: string;
|
|
154668
|
+
} | {
|
|
154669
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
154670
|
+
type: 'credential_cannot_be_reissued';
|
|
154671
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154672
|
+
message: string;
|
|
154673
|
+
} | {
|
|
154674
|
+
/** Error type to indicate that the encoder is not online. */
|
|
154675
|
+
type: 'encoder_not_online';
|
|
154676
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154677
|
+
message: string;
|
|
154678
|
+
};
|
|
154679
|
+
} | {
|
|
154680
|
+
/** ID of the action attempt. */
|
|
154681
|
+
action_attempt_id: string;
|
|
154682
|
+
status: 'pending';
|
|
154683
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154684
|
+
result: null;
|
|
154685
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154686
|
+
error: null;
|
|
154687
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
154688
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
154689
|
+
} | {
|
|
154690
|
+
/** ID of the action attempt. */
|
|
154691
|
+
action_attempt_id: string;
|
|
154692
|
+
status: 'success';
|
|
154693
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154694
|
+
error: null;
|
|
154695
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
154696
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
154697
|
+
/** Result of the action. */
|
|
154698
|
+
result: {};
|
|
154699
|
+
} | {
|
|
154700
|
+
/** ID of the action attempt. */
|
|
154701
|
+
action_attempt_id: string;
|
|
154702
|
+
status: 'error';
|
|
154703
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154704
|
+
result: null;
|
|
154705
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
154706
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
154707
|
+
/** Error associated with the action. */
|
|
154708
|
+
error: {
|
|
154709
|
+
/** Type of the error. */
|
|
154710
|
+
type: string;
|
|
154711
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154712
|
+
message: string;
|
|
154713
|
+
};
|
|
154714
|
+
} | {
|
|
154715
|
+
/** ID of the action attempt. */
|
|
154716
|
+
action_attempt_id: string;
|
|
154717
|
+
status: 'pending';
|
|
154718
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154719
|
+
result: null;
|
|
154720
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154721
|
+
error: null;
|
|
154722
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
154723
|
+
action_type: 'SET_FAN_MODE';
|
|
154724
|
+
} | {
|
|
154725
|
+
/** ID of the action attempt. */
|
|
154726
|
+
action_attempt_id: string;
|
|
154727
|
+
status: 'success';
|
|
154728
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154729
|
+
error: null;
|
|
154730
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
154731
|
+
action_type: 'SET_FAN_MODE';
|
|
154732
|
+
/** Result of the action. */
|
|
154733
|
+
result: {};
|
|
154734
|
+
} | {
|
|
154735
|
+
/** ID of the action attempt. */
|
|
154736
|
+
action_attempt_id: string;
|
|
154737
|
+
status: 'error';
|
|
154738
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154739
|
+
result: null;
|
|
154740
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
154741
|
+
action_type: 'SET_FAN_MODE';
|
|
154742
|
+
/** Error associated with the action. */
|
|
154743
|
+
error: {
|
|
154744
|
+
/** Type of the error. */
|
|
154745
|
+
type: string;
|
|
154746
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154747
|
+
message: string;
|
|
154748
|
+
};
|
|
154749
|
+
} | {
|
|
154750
|
+
/** ID of the action attempt. */
|
|
154751
|
+
action_attempt_id: string;
|
|
154752
|
+
status: 'pending';
|
|
154753
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154754
|
+
result: null;
|
|
154755
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154756
|
+
error: null;
|
|
154757
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
154758
|
+
action_type: 'SET_HVAC_MODE';
|
|
154759
|
+
} | {
|
|
154760
|
+
/** ID of the action attempt. */
|
|
154761
|
+
action_attempt_id: string;
|
|
154762
|
+
status: 'success';
|
|
154763
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154764
|
+
error: null;
|
|
154765
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
154766
|
+
action_type: 'SET_HVAC_MODE';
|
|
154767
|
+
/** Result of the action. */
|
|
154768
|
+
result: {};
|
|
154769
|
+
} | {
|
|
154770
|
+
/** ID of the action attempt. */
|
|
154771
|
+
action_attempt_id: string;
|
|
154772
|
+
status: 'error';
|
|
154773
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154774
|
+
result: null;
|
|
154775
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
154776
|
+
action_type: 'SET_HVAC_MODE';
|
|
154777
|
+
/** Error associated with the action. */
|
|
154778
|
+
error: {
|
|
154779
|
+
/** Type of the error. */
|
|
154780
|
+
type: string;
|
|
154781
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154782
|
+
message: string;
|
|
154783
|
+
};
|
|
154784
|
+
} | {
|
|
154785
|
+
/** ID of the action attempt. */
|
|
154786
|
+
action_attempt_id: string;
|
|
154787
|
+
status: 'pending';
|
|
154788
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154789
|
+
result: null;
|
|
154790
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154791
|
+
error: null;
|
|
154792
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
154793
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
154794
|
+
} | {
|
|
154795
|
+
/** ID of the action attempt. */
|
|
154796
|
+
action_attempt_id: string;
|
|
154797
|
+
status: 'success';
|
|
154798
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154799
|
+
error: null;
|
|
154800
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
154801
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
154802
|
+
/** Result of the action. */
|
|
154803
|
+
result: {};
|
|
154804
|
+
} | {
|
|
154805
|
+
/** ID of the action attempt. */
|
|
154806
|
+
action_attempt_id: string;
|
|
154807
|
+
status: 'error';
|
|
154808
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154809
|
+
result: null;
|
|
154810
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
154811
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
154812
|
+
/** Error associated with the action. */
|
|
154813
|
+
error: {
|
|
154814
|
+
/** Type of the error. */
|
|
154815
|
+
type: string;
|
|
154816
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154817
|
+
message: string;
|
|
154818
|
+
};
|
|
154819
|
+
} | {
|
|
154820
|
+
/** ID of the action attempt. */
|
|
154821
|
+
action_attempt_id: string;
|
|
154822
|
+
status: 'pending';
|
|
154823
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154824
|
+
result: null;
|
|
154825
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154826
|
+
error: null;
|
|
154827
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
154828
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
154829
|
+
} | {
|
|
154830
|
+
/** ID of the action attempt. */
|
|
154831
|
+
action_attempt_id: string;
|
|
154832
|
+
status: 'success';
|
|
154833
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154834
|
+
error: null;
|
|
154835
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
154836
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
154837
|
+
/** Result of the action. */
|
|
154838
|
+
result: {};
|
|
154839
|
+
} | {
|
|
154840
|
+
/** ID of the action attempt. */
|
|
154841
|
+
action_attempt_id: string;
|
|
154842
|
+
status: 'error';
|
|
154843
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154844
|
+
result: null;
|
|
154845
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
154846
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
154847
|
+
/** Error associated with the action. */
|
|
154848
|
+
error: {
|
|
154849
|
+
/** Type of the error. */
|
|
154850
|
+
type: string;
|
|
154851
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154852
|
+
message: string;
|
|
154853
|
+
};
|
|
154854
|
+
} | {
|
|
154855
|
+
/** ID of the action attempt. */
|
|
154856
|
+
action_attempt_id: string;
|
|
154857
|
+
status: 'pending';
|
|
154858
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154859
|
+
result: null;
|
|
154860
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154861
|
+
error: null;
|
|
154862
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
154863
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
154864
|
+
} | {
|
|
154865
|
+
/** ID of the action attempt. */
|
|
154866
|
+
action_attempt_id: string;
|
|
154867
|
+
status: 'success';
|
|
154868
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154869
|
+
error: null;
|
|
154870
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
154871
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
154872
|
+
/** Result of the action. */
|
|
154873
|
+
result: {};
|
|
154874
|
+
} | {
|
|
154875
|
+
/** ID of the action attempt. */
|
|
154876
|
+
action_attempt_id: string;
|
|
154877
|
+
status: 'error';
|
|
154878
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154879
|
+
result: null;
|
|
154880
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
154881
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
154882
|
+
/** Error associated with the action. */
|
|
154883
|
+
error: {
|
|
154884
|
+
/** Type of the error. */
|
|
154885
|
+
type: string;
|
|
154886
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154887
|
+
message: string;
|
|
154888
|
+
};
|
|
154889
|
+
} | {
|
|
154890
|
+
/** ID of the action attempt. */
|
|
154891
|
+
action_attempt_id: string;
|
|
154892
|
+
status: 'pending';
|
|
154893
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154894
|
+
result: null;
|
|
154895
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154896
|
+
error: null;
|
|
154897
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
154898
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
154899
|
+
} | {
|
|
154900
|
+
/** ID of the action attempt. */
|
|
154901
|
+
action_attempt_id: string;
|
|
154902
|
+
status: 'success';
|
|
154903
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154904
|
+
error: null;
|
|
154905
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
154906
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
154907
|
+
/** Result of the action. */
|
|
154908
|
+
result: {};
|
|
154909
|
+
} | {
|
|
154910
|
+
/** ID of the action attempt. */
|
|
154911
|
+
action_attempt_id: string;
|
|
154912
|
+
status: 'error';
|
|
154913
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154914
|
+
result: null;
|
|
154915
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
154916
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
154917
|
+
/** Error associated with the action. */
|
|
154918
|
+
error: {
|
|
154919
|
+
/** Type of the error. */
|
|
154920
|
+
type: string;
|
|
154921
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154922
|
+
message: string;
|
|
154923
|
+
};
|
|
154924
|
+
} | {
|
|
154925
|
+
/** ID of the action attempt. */
|
|
154926
|
+
action_attempt_id: string;
|
|
154927
|
+
status: 'pending';
|
|
154928
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154929
|
+
result: null;
|
|
154930
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154931
|
+
error: null;
|
|
154932
|
+
/** Syncing access codes is pending. */
|
|
154933
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
154934
|
+
} | {
|
|
154935
|
+
/** ID of the action attempt. */
|
|
154936
|
+
action_attempt_id: string;
|
|
154937
|
+
status: 'success';
|
|
154938
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154939
|
+
error: null;
|
|
154940
|
+
/** Syncing access codes succeeded. */
|
|
154941
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
154942
|
+
/** Result of the action. */
|
|
154943
|
+
result: {};
|
|
154944
|
+
} | {
|
|
154945
|
+
/** ID of the action attempt. */
|
|
154946
|
+
action_attempt_id: string;
|
|
154947
|
+
status: 'error';
|
|
154948
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154949
|
+
result: null;
|
|
154950
|
+
/** Syncing access codes failed. */
|
|
154951
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
154952
|
+
/** Error associated with the action. */
|
|
154953
|
+
error: {
|
|
154954
|
+
/** Type of the error. */
|
|
154955
|
+
type: string;
|
|
154956
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154957
|
+
message: string;
|
|
154958
|
+
};
|
|
154959
|
+
} | {
|
|
154960
|
+
/** ID of the action attempt. */
|
|
154961
|
+
action_attempt_id: string;
|
|
154962
|
+
status: 'pending';
|
|
154963
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
154964
|
+
result: null;
|
|
154965
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
154966
|
+
error: null;
|
|
154967
|
+
/** Creating an access code is pending. */
|
|
154968
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
154969
|
+
} | {
|
|
154970
|
+
/** ID of the action attempt. */
|
|
154971
|
+
action_attempt_id: string;
|
|
154972
|
+
status: 'success';
|
|
154973
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
154974
|
+
error: null;
|
|
154975
|
+
/** Creating an access code succeeded. */
|
|
154976
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
154977
|
+
/** Result of the action. */
|
|
154978
|
+
result: {
|
|
154979
|
+
/** Created access code. */
|
|
154980
|
+
access_code?: any;
|
|
154981
|
+
};
|
|
154982
|
+
} | {
|
|
154983
|
+
/** ID of the action attempt. */
|
|
154984
|
+
action_attempt_id: string;
|
|
154985
|
+
status: 'error';
|
|
154986
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
154987
|
+
result: null;
|
|
154988
|
+
/** Creating an access code failed. */
|
|
154989
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
154990
|
+
/** Error associated with the action. */
|
|
154991
|
+
error: {
|
|
154992
|
+
/** Type of the error. */
|
|
154993
|
+
type: string;
|
|
154994
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
154995
|
+
message: string;
|
|
154996
|
+
};
|
|
154997
|
+
} | {
|
|
154998
|
+
/** ID of the action attempt. */
|
|
154999
|
+
action_attempt_id: string;
|
|
155000
|
+
status: 'pending';
|
|
155001
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155002
|
+
result: null;
|
|
155003
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155004
|
+
error: null;
|
|
155005
|
+
/** Deleting an access code is pending. */
|
|
155006
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
155007
|
+
} | {
|
|
155008
|
+
/** ID of the action attempt. */
|
|
155009
|
+
action_attempt_id: string;
|
|
155010
|
+
status: 'success';
|
|
155011
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155012
|
+
error: null;
|
|
155013
|
+
/** Deleting an access code succeeded. */
|
|
155014
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
155015
|
+
/** Result of the action. */
|
|
155016
|
+
result: {};
|
|
155017
|
+
} | {
|
|
155018
|
+
/** ID of the action attempt. */
|
|
155019
|
+
action_attempt_id: string;
|
|
155020
|
+
status: 'error';
|
|
155021
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155022
|
+
result: null;
|
|
155023
|
+
/** Deleting an access code failed. */
|
|
155024
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
155025
|
+
/** Error associated with the action. */
|
|
155026
|
+
error: {
|
|
155027
|
+
/** Type of the error. */
|
|
155028
|
+
type: string;
|
|
155029
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155030
|
+
message: string;
|
|
155031
|
+
};
|
|
155032
|
+
} | {
|
|
155033
|
+
/** ID of the action attempt. */
|
|
155034
|
+
action_attempt_id: string;
|
|
155035
|
+
status: 'pending';
|
|
155036
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155037
|
+
result: null;
|
|
155038
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155039
|
+
error: null;
|
|
155040
|
+
/** Updating an access code is pending. */
|
|
155041
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
155042
|
+
} | {
|
|
155043
|
+
/** ID of the action attempt. */
|
|
155044
|
+
action_attempt_id: string;
|
|
155045
|
+
status: 'success';
|
|
155046
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155047
|
+
error: null;
|
|
155048
|
+
/** Updating an access code succeeded. */
|
|
155049
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
155050
|
+
/** Result of the action. */
|
|
155051
|
+
result: {
|
|
155052
|
+
/** Updated access code. */
|
|
155053
|
+
access_code?: any;
|
|
155054
|
+
};
|
|
155055
|
+
} | {
|
|
155056
|
+
/** ID of the action attempt. */
|
|
155057
|
+
action_attempt_id: string;
|
|
155058
|
+
status: 'error';
|
|
155059
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155060
|
+
result: null;
|
|
155061
|
+
/** Updating an access code failed. */
|
|
155062
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
155063
|
+
/** Error associated with the action. */
|
|
155064
|
+
error: {
|
|
155065
|
+
/** Type of the error. */
|
|
155066
|
+
type: string;
|
|
155067
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155068
|
+
message: string;
|
|
155069
|
+
};
|
|
155070
|
+
} | {
|
|
155071
|
+
/** ID of the action attempt. */
|
|
155072
|
+
action_attempt_id: string;
|
|
155073
|
+
status: 'pending';
|
|
155074
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155075
|
+
result: null;
|
|
155076
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155077
|
+
error: null;
|
|
155078
|
+
/** Creating a noise threshold is pending. */
|
|
155079
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
155080
|
+
} | {
|
|
155081
|
+
/** ID of the action attempt. */
|
|
155082
|
+
action_attempt_id: string;
|
|
155083
|
+
status: 'success';
|
|
155084
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155085
|
+
error: null;
|
|
155086
|
+
/** Creating a noise threshold succeeded. */
|
|
155087
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
155088
|
+
/** Result of the action. */
|
|
155089
|
+
result: {
|
|
155090
|
+
/** Created noise threshold. */
|
|
155091
|
+
noise_threshold?: any;
|
|
155092
|
+
};
|
|
155093
|
+
} | {
|
|
155094
|
+
/** ID of the action attempt. */
|
|
155095
|
+
action_attempt_id: string;
|
|
155096
|
+
status: 'error';
|
|
155097
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155098
|
+
result: null;
|
|
155099
|
+
/** Creating a noise threshold failed. */
|
|
155100
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
155101
|
+
/** Error associated with the action. */
|
|
155102
|
+
error: {
|
|
155103
|
+
/** Type of the error. */
|
|
155104
|
+
type: string;
|
|
155105
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155106
|
+
message: string;
|
|
155107
|
+
};
|
|
155108
|
+
} | {
|
|
155109
|
+
/** ID of the action attempt. */
|
|
155110
|
+
action_attempt_id: string;
|
|
155111
|
+
status: 'pending';
|
|
155112
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155113
|
+
result: null;
|
|
155114
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155115
|
+
error: null;
|
|
155116
|
+
/** Deleting a noise threshold is pending. */
|
|
155117
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
155118
|
+
} | {
|
|
155119
|
+
/** ID of the action attempt. */
|
|
155120
|
+
action_attempt_id: string;
|
|
155121
|
+
status: 'success';
|
|
155122
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155123
|
+
error: null;
|
|
155124
|
+
/** Deleting a noise threshold succeeded. */
|
|
155125
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
155126
|
+
/** Result of the action. */
|
|
155127
|
+
result: {};
|
|
155128
|
+
} | {
|
|
155129
|
+
/** ID of the action attempt. */
|
|
155130
|
+
action_attempt_id: string;
|
|
155131
|
+
status: 'error';
|
|
155132
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155133
|
+
result: null;
|
|
155134
|
+
/** Deleting a noise threshold failed. */
|
|
155135
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
155136
|
+
/** Error associated with the action. */
|
|
155137
|
+
error: {
|
|
155138
|
+
/** Type of the error. */
|
|
155139
|
+
type: string;
|
|
155140
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155141
|
+
message: string;
|
|
155142
|
+
};
|
|
155143
|
+
} | {
|
|
155144
|
+
/** ID of the action attempt. */
|
|
155145
|
+
action_attempt_id: string;
|
|
155146
|
+
status: 'pending';
|
|
155147
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155148
|
+
result: null;
|
|
155149
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155150
|
+
error: null;
|
|
155151
|
+
/** Updating a noise threshold is pending. */
|
|
155152
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
155153
|
+
} | {
|
|
155154
|
+
/** ID of the action attempt. */
|
|
155155
|
+
action_attempt_id: string;
|
|
155156
|
+
status: 'success';
|
|
155157
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155158
|
+
error: null;
|
|
155159
|
+
/** Updating a noise threshold succeeded. */
|
|
155160
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
155161
|
+
/** Result of the action. */
|
|
155162
|
+
result: {
|
|
155163
|
+
/** Updated noise threshold. */
|
|
155164
|
+
noise_threshold?: any;
|
|
155165
|
+
};
|
|
155166
|
+
} | {
|
|
155167
|
+
/** ID of the action attempt. */
|
|
155168
|
+
action_attempt_id: string;
|
|
155169
|
+
status: 'error';
|
|
155170
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155171
|
+
result: null;
|
|
155172
|
+
/** Updating a noise threshold failed. */
|
|
155173
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
155174
|
+
/** Error associated with the action. */
|
|
155175
|
+
error: {
|
|
155176
|
+
/** Type of the error. */
|
|
155177
|
+
type: string;
|
|
155178
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155179
|
+
message: string;
|
|
155180
|
+
};
|
|
155181
|
+
};
|
|
155182
|
+
};
|
|
155183
|
+
maxDuration: undefined;
|
|
155184
|
+
};
|
|
155185
|
+
'/acs/encoders/simulate/next_credential_encode_will_fail': {
|
|
155186
|
+
route: '/acs/encoders/simulate/next_credential_encode_will_fail';
|
|
155187
|
+
method: 'POST';
|
|
155188
|
+
queryParams: {};
|
|
155189
|
+
jsonBody: {
|
|
155190
|
+
/** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
|
|
155191
|
+
acs_encoder_id: string;
|
|
155192
|
+
/** Code of the error to simulate. */
|
|
155193
|
+
error_code?: 'no_credential_on_encoder';
|
|
155194
|
+
} | {
|
|
155195
|
+
/** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
|
|
155196
|
+
acs_encoder_id: string;
|
|
155197
|
+
/** Code of the error to simulate. */
|
|
155198
|
+
error_code: 'uncategorized_error' | 'action_attempt_expired';
|
|
155199
|
+
/** ID of the `acs_credential` that will fail to be encoded onto a card in the next request. */
|
|
155200
|
+
acs_credential_id?: string | undefined;
|
|
155201
|
+
};
|
|
155202
|
+
commonParams: {};
|
|
155203
|
+
formData: {};
|
|
155204
|
+
jsonResponse: {};
|
|
155205
|
+
maxDuration: undefined;
|
|
155206
|
+
};
|
|
155207
|
+
'/acs/encoders/simulate/next_credential_encode_will_succeed': {
|
|
155208
|
+
route: '/acs/encoders/simulate/next_credential_encode_will_succeed';
|
|
155209
|
+
method: 'POST';
|
|
155210
|
+
queryParams: {};
|
|
155211
|
+
jsonBody: {
|
|
155212
|
+
/** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
|
|
155213
|
+
acs_encoder_id: string;
|
|
155214
|
+
/** Scenario to simulate. */
|
|
155215
|
+
scenario?: 'credential_is_issued';
|
|
155216
|
+
};
|
|
155217
|
+
commonParams: {};
|
|
155218
|
+
formData: {};
|
|
155219
|
+
jsonResponse: {};
|
|
155220
|
+
maxDuration: undefined;
|
|
155221
|
+
};
|
|
155222
|
+
'/acs/encoders/simulate/next_credential_scan_will_fail': {
|
|
155223
|
+
route: '/acs/encoders/simulate/next_credential_scan_will_fail';
|
|
155224
|
+
method: 'POST';
|
|
155225
|
+
queryParams: {};
|
|
155226
|
+
jsonBody: {
|
|
155227
|
+
/** ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. */
|
|
155228
|
+
acs_encoder_id: string;
|
|
155229
|
+
error_code?: 'no_credential_on_encoder';
|
|
155230
|
+
} | {
|
|
155231
|
+
/** ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. */
|
|
155232
|
+
acs_encoder_id: string;
|
|
155233
|
+
error_code: 'uncategorized_error' | 'action_attempt_expired';
|
|
155234
|
+
acs_credential_id_on_seam?: string | undefined;
|
|
155235
|
+
};
|
|
155236
|
+
commonParams: {};
|
|
155237
|
+
formData: {};
|
|
155238
|
+
jsonResponse: {};
|
|
155239
|
+
maxDuration: undefined;
|
|
155240
|
+
};
|
|
155241
|
+
'/acs/encoders/simulate/next_credential_scan_will_succeed': {
|
|
155242
|
+
route: '/acs/encoders/simulate/next_credential_scan_will_succeed';
|
|
155243
|
+
method: 'POST';
|
|
155244
|
+
queryParams: {};
|
|
155245
|
+
jsonBody: {
|
|
155246
|
+
/** ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. */
|
|
155247
|
+
acs_encoder_id: string;
|
|
155248
|
+
/** Scenario to simulate. */
|
|
155249
|
+
scenario?: 'credential_exists_on_seam' | 'credential_on_encoder_needs_update';
|
|
155250
|
+
/** ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. */
|
|
155251
|
+
acs_credential_id_on_seam?: string | undefined;
|
|
155252
|
+
} | {
|
|
155253
|
+
/** ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. */
|
|
155254
|
+
acs_encoder_id: string;
|
|
155255
|
+
/** Scenario to simulate. */
|
|
155256
|
+
scenario: 'credential_does_not_exist_on_seam';
|
|
155257
|
+
} | {
|
|
155258
|
+
/** ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. */
|
|
155259
|
+
acs_encoder_id: string;
|
|
155260
|
+
/** Scenario to simulate. */
|
|
155261
|
+
scenario: 'credential_on_encoder_is_empty';
|
|
155262
|
+
};
|
|
155263
|
+
commonParams: {};
|
|
155264
|
+
formData: {};
|
|
155265
|
+
jsonResponse: {};
|
|
155266
|
+
maxDuration: undefined;
|
|
155267
|
+
};
|
|
155268
|
+
'/acs/entrances/get': {
|
|
155269
|
+
route: '/acs/entrances/get';
|
|
153704
155270
|
method: 'GET' | 'POST';
|
|
153705
155271
|
queryParams: {};
|
|
153706
155272
|
jsonBody: {};
|
|
153707
155273
|
commonParams: {
|
|
153708
|
-
/** ID of the
|
|
153709
|
-
|
|
155274
|
+
/** ID of the entrance that you want to get. */
|
|
155275
|
+
acs_entrance_id: string;
|
|
153710
155276
|
};
|
|
153711
155277
|
formData: {};
|
|
153712
155278
|
jsonResponse: {
|
|
153713
|
-
/** Represents
|
|
153714
|
-
|
|
153715
|
-
Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
|
|
153716
|
-
|
|
153717
|
-
1. Credential creation
|
|
153718
|
-
Configure the access parameters for the credential.
|
|
153719
|
-
2. Card encoding
|
|
153720
|
-
Write the credential data onto the card using a compatible card encoder.
|
|
153721
|
-
|
|
153722
|
-
Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
|
|
153723
|
-
|
|
153724
|
-
See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
|
|
155279
|
+
/** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
153725
155280
|
|
|
153726
|
-
|
|
153727
|
-
|
|
153728
|
-
/** ID of the [
|
|
153729
|
-
acs_encoder_id: string;
|
|
153730
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
155281
|
+
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */
|
|
155282
|
+
acs_entrance: {
|
|
155283
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
153731
155284
|
acs_system_id: string;
|
|
153732
|
-
/** ID of the [
|
|
155285
|
+
/** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155286
|
+
acs_entrance_id: string;
|
|
155287
|
+
/** IDs of the spaces that the entrance is in. */
|
|
155288
|
+
space_ids: string[];
|
|
155289
|
+
/** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
|
|
155290
|
+
created_at: string;
|
|
155291
|
+
/** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155292
|
+
display_name: string;
|
|
155293
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
153733
155294
|
connected_account_id: string;
|
|
153734
|
-
/**
|
|
153735
|
-
workspace_id: string;
|
|
153736
|
-
/** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
155295
|
+
/** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
153737
155296
|
errors: {
|
|
153738
|
-
/**
|
|
153739
|
-
|
|
155297
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
155298
|
+
error_code: string;
|
|
153740
155299
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
153741
155300
|
message: string;
|
|
153742
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
153743
|
-
error_code: 'acs_encoder_removed';
|
|
153744
155301
|
}[];
|
|
153745
|
-
/**
|
|
153746
|
-
|
|
153747
|
-
|
|
153748
|
-
|
|
155302
|
+
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155303
|
+
latch_metadata?: {
|
|
155304
|
+
/** Accessibility type in the Latch access system. */
|
|
155305
|
+
accessibility_type: string;
|
|
155306
|
+
/** Name of the door in the Latch access system. */
|
|
155307
|
+
door_name: string;
|
|
155308
|
+
/** Type of the door in the Latch access system. */
|
|
155309
|
+
door_type: string;
|
|
155310
|
+
/** Indicates whether the entrance is connected. */
|
|
155311
|
+
is_connected: boolean;
|
|
155312
|
+
} | undefined;
|
|
155313
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155314
|
+
hotek_metadata?: {
|
|
155315
|
+
/** Room number of the entrance. */
|
|
155316
|
+
room_number?: string | undefined;
|
|
155317
|
+
/** Display name of the entrance. */
|
|
155318
|
+
common_area_number?: string | undefined;
|
|
155319
|
+
/** Display name of the entrance. */
|
|
155320
|
+
common_area_name?: string | undefined;
|
|
155321
|
+
} | undefined;
|
|
155322
|
+
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155323
|
+
visionline_metadata?: {
|
|
155324
|
+
/** Name of the door in the Visionline access system. */
|
|
155325
|
+
door_name: string;
|
|
155326
|
+
/** Category of the door in the Visionline access system. */
|
|
155327
|
+
door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
|
|
155328
|
+
/** Profile for the door in the Visionline access system. */
|
|
155329
|
+
profiles?: {
|
|
155330
|
+
/** Door profile ID in the Visionline access system. */
|
|
155331
|
+
visionline_door_profile_id: string;
|
|
155332
|
+
/** Door profile type in the Visionline access system. */
|
|
155333
|
+
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
|
|
155334
|
+
}[] | undefined;
|
|
155335
|
+
} | undefined;
|
|
155336
|
+
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155337
|
+
salto_ks_metadata?: {
|
|
155338
|
+
/** Name of the door in the Salto KS access system. */
|
|
155339
|
+
door_name: string;
|
|
155340
|
+
/** Locked state of the door in the Salto KS access system. */
|
|
155341
|
+
locked_state: string;
|
|
155342
|
+
/** Type of the lock in the Salto KS access system. */
|
|
155343
|
+
lock_type: string;
|
|
155344
|
+
/** Indicates whether the door access device is online. */
|
|
155345
|
+
online?: boolean | undefined;
|
|
155346
|
+
/** Battery level of the door access device. */
|
|
155347
|
+
battery_level: string;
|
|
155348
|
+
/** Indicates whether the door is left open. */
|
|
155349
|
+
left_open_alarm?: boolean | undefined;
|
|
155350
|
+
/** Indicates whether an intrusion alarm is active on the door. */
|
|
155351
|
+
intrusion_alarm?: boolean | undefined;
|
|
155352
|
+
/** Indicates whether privacy mode is enabled for the lock. */
|
|
155353
|
+
privacy_mode?: boolean | undefined;
|
|
155354
|
+
} | undefined;
|
|
155355
|
+
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155356
|
+
dormakaba_community_metadata?: {
|
|
155357
|
+
/** Type of access point profile in the dormakaba Community access system. */
|
|
155358
|
+
access_point_profile: string;
|
|
155359
|
+
} | undefined;
|
|
155360
|
+
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155361
|
+
assa_abloy_vostio_metadata?: {
|
|
155362
|
+
/** Type of the door in the Vostio access system. */
|
|
155363
|
+
door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
|
|
155364
|
+
/** Name of the door in the Vostio access system. */
|
|
155365
|
+
door_name: string;
|
|
155366
|
+
/** Number of the door in the Vostio access system. */
|
|
155367
|
+
door_number?: number | undefined;
|
|
155368
|
+
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
155369
|
+
stand_open?: boolean | undefined;
|
|
155370
|
+
/** PMS ID of the door in the Vostio access system. */
|
|
155371
|
+
pms_id?: string | undefined;
|
|
155372
|
+
} | undefined;
|
|
155373
|
+
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155374
|
+
salto_space_metadata?: {
|
|
155375
|
+
/** Door ID in the Salto Space access system. */
|
|
155376
|
+
door_id?: string | undefined;
|
|
155377
|
+
/** Name of the door in the Salto Space access system. */
|
|
155378
|
+
door_name?: string | undefined;
|
|
155379
|
+
/** Description of the door in the Salto Space access system. */
|
|
155380
|
+
door_description?: string | undefined;
|
|
155381
|
+
/** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
|
|
155382
|
+
audit_on_keys?: boolean | undefined;
|
|
155383
|
+
/** Name of the room in the Salto Space access system. */
|
|
155384
|
+
room_name?: string | undefined;
|
|
155385
|
+
/** Description of the room in the Salto Space access system. */
|
|
155386
|
+
room_description?: string | undefined;
|
|
155387
|
+
} | undefined;
|
|
155388
|
+
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155389
|
+
dormakaba_ambiance_metadata?: {
|
|
155390
|
+
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
155391
|
+
access_point_name: string;
|
|
155392
|
+
} | undefined;
|
|
155393
|
+
/** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155394
|
+
brivo_metadata?: {
|
|
155395
|
+
/** ID of the access point in the Brivo access system. */
|
|
155396
|
+
access_point_id: string;
|
|
155397
|
+
/** ID of the site that the access point belongs to. */
|
|
155398
|
+
site_id: number;
|
|
155399
|
+
/** Name of the site that the access point belongs to. */
|
|
155400
|
+
site_name: string;
|
|
155401
|
+
} | undefined;
|
|
155402
|
+
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
155403
|
+
can_unlock_with_mobile_key?: boolean | undefined;
|
|
155404
|
+
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
155405
|
+
can_unlock_with_card?: boolean | undefined;
|
|
155406
|
+
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
155407
|
+
can_unlock_with_code?: boolean | undefined;
|
|
155408
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
155409
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
155410
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
155411
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
153749
155412
|
};
|
|
153750
155413
|
};
|
|
153751
155414
|
maxDuration: undefined;
|
|
153752
155415
|
};
|
|
153753
|
-
'/acs/
|
|
153754
|
-
route: '/acs/
|
|
155416
|
+
'/acs/entrances/grant_access': {
|
|
155417
|
+
route: '/acs/entrances/grant_access';
|
|
155418
|
+
method: 'POST';
|
|
155419
|
+
queryParams: {};
|
|
155420
|
+
jsonBody: {
|
|
155421
|
+
/** ID of the entrance to which you want to grant an access system user access. */
|
|
155422
|
+
acs_entrance_id: string;
|
|
155423
|
+
/** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
|
|
155424
|
+
user_identity_id?: string | undefined;
|
|
155425
|
+
/** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
|
|
155426
|
+
acs_user_id?: string | undefined;
|
|
155427
|
+
};
|
|
155428
|
+
commonParams: {};
|
|
155429
|
+
formData: {};
|
|
155430
|
+
jsonResponse: {};
|
|
155431
|
+
maxDuration: undefined;
|
|
155432
|
+
};
|
|
155433
|
+
'/acs/entrances/list': {
|
|
155434
|
+
route: '/acs/entrances/list';
|
|
153755
155435
|
method: 'GET' | 'POST';
|
|
153756
155436
|
queryParams: {};
|
|
153757
155437
|
jsonBody: {};
|
|
153758
|
-
commonParams:
|
|
153759
|
-
/**
|
|
153760
|
-
|
|
153761
|
-
|
|
153762
|
-
|
|
153763
|
-
|
|
153764
|
-
|
|
153765
|
-
/**
|
|
153766
|
-
|
|
153767
|
-
|
|
153768
|
-
/**
|
|
155438
|
+
commonParams: {
|
|
155439
|
+
/** Customer key for which you want to list entrances. */
|
|
155440
|
+
customer_key?: string | undefined;
|
|
155441
|
+
/** ID of the access system for which you want to retrieve all entrances. */
|
|
155442
|
+
acs_system_id?: string | undefined;
|
|
155443
|
+
/** ID of the credential for which you want to retrieve all entrances. */
|
|
155444
|
+
acs_credential_id?: string | undefined;
|
|
155445
|
+
/**
|
|
155446
|
+
* @deprecated Use `space_id`.*/
|
|
155447
|
+
location_id?: (string | null) | undefined;
|
|
155448
|
+
/** ID of the space for which you want to list entrances. */
|
|
155449
|
+
space_id?: string | undefined;
|
|
155450
|
+
/** ID of the connected account for which you want to retrieve all entrances. */
|
|
155451
|
+
connected_account_id?: string | undefined;
|
|
155452
|
+
/** IDs of the entrances for which you want to retrieve all entrances. */
|
|
155453
|
+
acs_entrance_ids?: string[] | undefined;
|
|
155454
|
+
/** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
|
|
155455
|
+
search?: string | undefined;
|
|
155456
|
+
/** Maximum number of records to return per page. */
|
|
153769
155457
|
limit?: number;
|
|
153770
155458
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
153771
155459
|
page_cursor?: (string | undefined) | null;
|
|
153772
155460
|
};
|
|
153773
155461
|
formData: {};
|
|
153774
155462
|
jsonResponse: {
|
|
153775
|
-
|
|
153776
|
-
/** ID of the [
|
|
153777
|
-
acs_encoder_id: string;
|
|
153778
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
155463
|
+
acs_entrances: {
|
|
155464
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
153779
155465
|
acs_system_id: string;
|
|
153780
|
-
/** ID of the [
|
|
155466
|
+
/** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155467
|
+
acs_entrance_id: string;
|
|
155468
|
+
/** IDs of the spaces that the entrance is in. */
|
|
155469
|
+
space_ids: string[];
|
|
155470
|
+
/** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
|
|
155471
|
+
created_at: string;
|
|
155472
|
+
/** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155473
|
+
display_name: string;
|
|
155474
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
153781
155475
|
connected_account_id: string;
|
|
153782
|
-
/**
|
|
153783
|
-
workspace_id: string;
|
|
153784
|
-
/** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
|
|
155476
|
+
/** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
153785
155477
|
errors: {
|
|
153786
|
-
/**
|
|
153787
|
-
|
|
155478
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
155479
|
+
error_code: string;
|
|
153788
155480
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
153789
155481
|
message: string;
|
|
153790
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
153791
|
-
error_code: 'acs_encoder_removed';
|
|
153792
155482
|
}[];
|
|
153793
|
-
/**
|
|
153794
|
-
|
|
153795
|
-
|
|
153796
|
-
|
|
155483
|
+
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155484
|
+
latch_metadata?: {
|
|
155485
|
+
/** Accessibility type in the Latch access system. */
|
|
155486
|
+
accessibility_type: string;
|
|
155487
|
+
/** Name of the door in the Latch access system. */
|
|
155488
|
+
door_name: string;
|
|
155489
|
+
/** Type of the door in the Latch access system. */
|
|
155490
|
+
door_type: string;
|
|
155491
|
+
/** Indicates whether the entrance is connected. */
|
|
155492
|
+
is_connected: boolean;
|
|
155493
|
+
} | undefined;
|
|
155494
|
+
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155495
|
+
hotek_metadata?: {
|
|
155496
|
+
/** Room number of the entrance. */
|
|
155497
|
+
room_number?: string | undefined;
|
|
155498
|
+
/** Display name of the entrance. */
|
|
155499
|
+
common_area_number?: string | undefined;
|
|
155500
|
+
/** Display name of the entrance. */
|
|
155501
|
+
common_area_name?: string | undefined;
|
|
155502
|
+
} | undefined;
|
|
155503
|
+
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155504
|
+
visionline_metadata?: {
|
|
155505
|
+
/** Name of the door in the Visionline access system. */
|
|
155506
|
+
door_name: string;
|
|
155507
|
+
/** Category of the door in the Visionline access system. */
|
|
155508
|
+
door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
|
|
155509
|
+
/** Profile for the door in the Visionline access system. */
|
|
155510
|
+
profiles?: {
|
|
155511
|
+
/** Door profile ID in the Visionline access system. */
|
|
155512
|
+
visionline_door_profile_id: string;
|
|
155513
|
+
/** Door profile type in the Visionline access system. */
|
|
155514
|
+
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
|
|
155515
|
+
}[] | undefined;
|
|
155516
|
+
} | undefined;
|
|
155517
|
+
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155518
|
+
salto_ks_metadata?: {
|
|
155519
|
+
/** Name of the door in the Salto KS access system. */
|
|
155520
|
+
door_name: string;
|
|
155521
|
+
/** Locked state of the door in the Salto KS access system. */
|
|
155522
|
+
locked_state: string;
|
|
155523
|
+
/** Type of the lock in the Salto KS access system. */
|
|
155524
|
+
lock_type: string;
|
|
155525
|
+
/** Indicates whether the door access device is online. */
|
|
155526
|
+
online?: boolean | undefined;
|
|
155527
|
+
/** Battery level of the door access device. */
|
|
155528
|
+
battery_level: string;
|
|
155529
|
+
/** Indicates whether the door is left open. */
|
|
155530
|
+
left_open_alarm?: boolean | undefined;
|
|
155531
|
+
/** Indicates whether an intrusion alarm is active on the door. */
|
|
155532
|
+
intrusion_alarm?: boolean | undefined;
|
|
155533
|
+
/** Indicates whether privacy mode is enabled for the lock. */
|
|
155534
|
+
privacy_mode?: boolean | undefined;
|
|
155535
|
+
} | undefined;
|
|
155536
|
+
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155537
|
+
dormakaba_community_metadata?: {
|
|
155538
|
+
/** Type of access point profile in the dormakaba Community access system. */
|
|
155539
|
+
access_point_profile: string;
|
|
155540
|
+
} | undefined;
|
|
155541
|
+
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155542
|
+
assa_abloy_vostio_metadata?: {
|
|
155543
|
+
/** Type of the door in the Vostio access system. */
|
|
155544
|
+
door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
|
|
155545
|
+
/** Name of the door in the Vostio access system. */
|
|
155546
|
+
door_name: string;
|
|
155547
|
+
/** Number of the door in the Vostio access system. */
|
|
155548
|
+
door_number?: number | undefined;
|
|
155549
|
+
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
155550
|
+
stand_open?: boolean | undefined;
|
|
155551
|
+
/** PMS ID of the door in the Vostio access system. */
|
|
155552
|
+
pms_id?: string | undefined;
|
|
155553
|
+
} | undefined;
|
|
155554
|
+
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155555
|
+
salto_space_metadata?: {
|
|
155556
|
+
/** Door ID in the Salto Space access system. */
|
|
155557
|
+
door_id?: string | undefined;
|
|
155558
|
+
/** Name of the door in the Salto Space access system. */
|
|
155559
|
+
door_name?: string | undefined;
|
|
155560
|
+
/** Description of the door in the Salto Space access system. */
|
|
155561
|
+
door_description?: string | undefined;
|
|
155562
|
+
/** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
|
|
155563
|
+
audit_on_keys?: boolean | undefined;
|
|
155564
|
+
/** Name of the room in the Salto Space access system. */
|
|
155565
|
+
room_name?: string | undefined;
|
|
155566
|
+
/** Description of the room in the Salto Space access system. */
|
|
155567
|
+
room_description?: string | undefined;
|
|
155568
|
+
} | undefined;
|
|
155569
|
+
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155570
|
+
dormakaba_ambiance_metadata?: {
|
|
155571
|
+
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
155572
|
+
access_point_name: string;
|
|
155573
|
+
} | undefined;
|
|
155574
|
+
/** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155575
|
+
brivo_metadata?: {
|
|
155576
|
+
/** ID of the access point in the Brivo access system. */
|
|
155577
|
+
access_point_id: string;
|
|
155578
|
+
/** ID of the site that the access point belongs to. */
|
|
155579
|
+
site_id: number;
|
|
155580
|
+
/** Name of the site that the access point belongs to. */
|
|
155581
|
+
site_name: string;
|
|
155582
|
+
} | undefined;
|
|
155583
|
+
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
155584
|
+
can_unlock_with_mobile_key?: boolean | undefined;
|
|
155585
|
+
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
155586
|
+
can_unlock_with_card?: boolean | undefined;
|
|
155587
|
+
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
155588
|
+
can_unlock_with_code?: boolean | undefined;
|
|
155589
|
+
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
155590
|
+
can_belong_to_reservation?: boolean | undefined;
|
|
155591
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
155592
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
153797
155593
|
}[];
|
|
153798
155594
|
/** Information about the current page of results. */
|
|
153799
155595
|
pagination: {
|
|
@@ -153807,14 +155603,163 @@ type Routes = {
|
|
|
153807
155603
|
};
|
|
153808
155604
|
maxDuration: undefined;
|
|
153809
155605
|
};
|
|
153810
|
-
'/acs/
|
|
153811
|
-
route: '/acs/
|
|
155606
|
+
'/acs/entrances/list_credentials_with_access': {
|
|
155607
|
+
route: '/acs/entrances/list_credentials_with_access';
|
|
155608
|
+
method: 'GET' | 'POST';
|
|
155609
|
+
queryParams: {};
|
|
155610
|
+
jsonBody: {};
|
|
155611
|
+
commonParams: {
|
|
155612
|
+
/** ID of the entrance for which you want to list all credentials that grant access. */
|
|
155613
|
+
acs_entrance_id: string;
|
|
155614
|
+
/** Conditions that credentials must meet to be included in the returned list. */
|
|
155615
|
+
include_if?: 'visionline_metadata.is_valid'[] | undefined;
|
|
155616
|
+
};
|
|
155617
|
+
formData: {};
|
|
155618
|
+
jsonResponse: {
|
|
155619
|
+
acs_credentials: {
|
|
155620
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155621
|
+
acs_credential_id: string;
|
|
155622
|
+
/** 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. */
|
|
155623
|
+
acs_user_id?: string | undefined;
|
|
155624
|
+
/** 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. */
|
|
155625
|
+
user_identity_id?: string | undefined;
|
|
155626
|
+
/** 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. */
|
|
155627
|
+
connected_account_id: string;
|
|
155628
|
+
acs_credential_pool_id?: string | undefined;
|
|
155629
|
+
/** 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). */
|
|
155630
|
+
acs_system_id: string;
|
|
155631
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155632
|
+
parent_acs_credential_id?: string | undefined;
|
|
155633
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
155634
|
+
display_name: string;
|
|
155635
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155636
|
+
code?: (string | undefined) | null;
|
|
155637
|
+
/** 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. */
|
|
155638
|
+
is_one_time_use?: boolean | undefined;
|
|
155639
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155640
|
+
card_number?: (string | undefined) | null;
|
|
155641
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
155642
|
+
is_issued?: boolean | undefined;
|
|
155643
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
155644
|
+
issued_at?: (string | undefined) | null;
|
|
155645
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
155646
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
155647
|
+
/** 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`. */
|
|
155648
|
+
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;
|
|
155649
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
155650
|
+
external_type_display_name?: string | undefined;
|
|
155651
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
155652
|
+
created_at: string;
|
|
155653
|
+
/** 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). */
|
|
155654
|
+
workspace_id: string;
|
|
155655
|
+
/** 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. */
|
|
155656
|
+
starts_at?: string | undefined;
|
|
155657
|
+
/** 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`. */
|
|
155658
|
+
ends_at?: string | undefined;
|
|
155659
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155660
|
+
errors: {
|
|
155661
|
+
error_code: string;
|
|
155662
|
+
message: string;
|
|
155663
|
+
}[];
|
|
155664
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155665
|
+
warnings: ({
|
|
155666
|
+
/** Date and time at which Seam created the warning. */
|
|
155667
|
+
created_at: string;
|
|
155668
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155669
|
+
message: string;
|
|
155670
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155671
|
+
warning_code: 'waiting_to_be_issued';
|
|
155672
|
+
} | {
|
|
155673
|
+
/** Date and time at which Seam created the warning. */
|
|
155674
|
+
created_at: string;
|
|
155675
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155676
|
+
message: string;
|
|
155677
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155678
|
+
warning_code: 'schedule_externally_modified';
|
|
155679
|
+
} | {
|
|
155680
|
+
/** Date and time at which Seam created the warning. */
|
|
155681
|
+
created_at: string;
|
|
155682
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155683
|
+
message: string;
|
|
155684
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155685
|
+
warning_code: 'schedule_modified';
|
|
155686
|
+
} | {
|
|
155687
|
+
/** Date and time at which Seam created the warning. */
|
|
155688
|
+
created_at: string;
|
|
155689
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155690
|
+
message: string;
|
|
155691
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155692
|
+
warning_code: 'being_deleted';
|
|
155693
|
+
} | {
|
|
155694
|
+
/** Date and time at which Seam created the warning. */
|
|
155695
|
+
created_at: string;
|
|
155696
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155697
|
+
message: string;
|
|
155698
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155699
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
155700
|
+
} | {
|
|
155701
|
+
/** Date and time at which Seam created the warning. */
|
|
155702
|
+
created_at: string;
|
|
155703
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155704
|
+
message: string;
|
|
155705
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155706
|
+
warning_code: 'needs_to_be_reissued';
|
|
155707
|
+
})[];
|
|
155708
|
+
/** 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). */
|
|
155709
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
155710
|
+
/** 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. */
|
|
155711
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
155712
|
+
/** 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. */
|
|
155713
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
155714
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155715
|
+
visionline_metadata?: {
|
|
155716
|
+
/** Card function type in the Visionline access system. */
|
|
155717
|
+
card_function_type: 'guest' | 'staff';
|
|
155718
|
+
/** IDs of the credentials to which you want to join. */
|
|
155719
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
155720
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
155721
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
155722
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
155723
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
155724
|
+
/** Indicates whether the credential is valid. */
|
|
155725
|
+
is_valid?: boolean | undefined;
|
|
155726
|
+
/** 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. */
|
|
155727
|
+
auto_join?: boolean | undefined;
|
|
155728
|
+
/** ID of the card in the Visionline access system. */
|
|
155729
|
+
card_id?: string | undefined;
|
|
155730
|
+
/** ID of the credential in the Visionline access system. */
|
|
155731
|
+
credential_id?: string | undefined;
|
|
155732
|
+
} | undefined;
|
|
155733
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155734
|
+
assa_abloy_vostio_metadata?: {
|
|
155735
|
+
/** 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. */
|
|
155736
|
+
auto_join?: boolean | undefined;
|
|
155737
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
155738
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
155739
|
+
/** Key ID in the Vostio access system. */
|
|
155740
|
+
key_id?: string | undefined;
|
|
155741
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
155742
|
+
key_issuing_request_id?: string | undefined;
|
|
155743
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
155744
|
+
door_names?: string[] | undefined;
|
|
155745
|
+
/** Endpoint ID in the Vostio access system. */
|
|
155746
|
+
endpoint_id?: string | undefined;
|
|
155747
|
+
} | undefined;
|
|
155748
|
+
is_managed: true;
|
|
155749
|
+
}[];
|
|
155750
|
+
};
|
|
155751
|
+
maxDuration: undefined;
|
|
155752
|
+
};
|
|
155753
|
+
'/acs/entrances/unlock': {
|
|
155754
|
+
route: '/acs/entrances/unlock';
|
|
153812
155755
|
method: 'POST';
|
|
153813
155756
|
queryParams: {};
|
|
153814
155757
|
jsonBody: {};
|
|
153815
155758
|
commonParams: {
|
|
153816
|
-
/** ID of the
|
|
153817
|
-
|
|
155759
|
+
/** ID of the entrance to unlock. */
|
|
155760
|
+
acs_entrance_id: string;
|
|
155761
|
+
/** ID of the cloud_key credential to use for the unlock operation. */
|
|
155762
|
+
acs_credential_id: string;
|
|
153818
155763
|
};
|
|
153819
155764
|
formData: {};
|
|
153820
155765
|
jsonResponse: {
|
|
@@ -155082,570 +157027,6 @@ type Routes = {
|
|
|
155082
157027
|
};
|
|
155083
157028
|
maxDuration: undefined;
|
|
155084
157029
|
};
|
|
155085
|
-
'/acs/encoders/simulate/next_credential_encode_will_fail': {
|
|
155086
|
-
route: '/acs/encoders/simulate/next_credential_encode_will_fail';
|
|
155087
|
-
method: 'POST';
|
|
155088
|
-
queryParams: {};
|
|
155089
|
-
jsonBody: {
|
|
155090
|
-
/** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
|
|
155091
|
-
acs_encoder_id: string;
|
|
155092
|
-
/** Code of the error to simulate. */
|
|
155093
|
-
error_code?: 'no_credential_on_encoder';
|
|
155094
|
-
} | {
|
|
155095
|
-
/** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
|
|
155096
|
-
acs_encoder_id: string;
|
|
155097
|
-
/** Code of the error to simulate. */
|
|
155098
|
-
error_code: 'uncategorized_error' | 'action_attempt_expired';
|
|
155099
|
-
/** ID of the `acs_credential` that will fail to be encoded onto a card in the next request. */
|
|
155100
|
-
acs_credential_id?: string | undefined;
|
|
155101
|
-
};
|
|
155102
|
-
commonParams: {};
|
|
155103
|
-
formData: {};
|
|
155104
|
-
jsonResponse: {};
|
|
155105
|
-
maxDuration: undefined;
|
|
155106
|
-
};
|
|
155107
|
-
'/acs/encoders/simulate/next_credential_encode_will_succeed': {
|
|
155108
|
-
route: '/acs/encoders/simulate/next_credential_encode_will_succeed';
|
|
155109
|
-
method: 'POST';
|
|
155110
|
-
queryParams: {};
|
|
155111
|
-
jsonBody: {
|
|
155112
|
-
/** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
|
|
155113
|
-
acs_encoder_id: string;
|
|
155114
|
-
/** Scenario to simulate. */
|
|
155115
|
-
scenario?: 'credential_is_issued';
|
|
155116
|
-
};
|
|
155117
|
-
commonParams: {};
|
|
155118
|
-
formData: {};
|
|
155119
|
-
jsonResponse: {};
|
|
155120
|
-
maxDuration: undefined;
|
|
155121
|
-
};
|
|
155122
|
-
'/acs/encoders/simulate/next_credential_scan_will_fail': {
|
|
155123
|
-
route: '/acs/encoders/simulate/next_credential_scan_will_fail';
|
|
155124
|
-
method: 'POST';
|
|
155125
|
-
queryParams: {};
|
|
155126
|
-
jsonBody: {
|
|
155127
|
-
/** ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. */
|
|
155128
|
-
acs_encoder_id: string;
|
|
155129
|
-
error_code?: 'no_credential_on_encoder';
|
|
155130
|
-
} | {
|
|
155131
|
-
/** ID of the `acs_encoder` that will fail to scan the `acs_credential` in the next request. */
|
|
155132
|
-
acs_encoder_id: string;
|
|
155133
|
-
error_code: 'uncategorized_error' | 'action_attempt_expired';
|
|
155134
|
-
acs_credential_id_on_seam?: string | undefined;
|
|
155135
|
-
};
|
|
155136
|
-
commonParams: {};
|
|
155137
|
-
formData: {};
|
|
155138
|
-
jsonResponse: {};
|
|
155139
|
-
maxDuration: undefined;
|
|
155140
|
-
};
|
|
155141
|
-
'/acs/encoders/simulate/next_credential_scan_will_succeed': {
|
|
155142
|
-
route: '/acs/encoders/simulate/next_credential_scan_will_succeed';
|
|
155143
|
-
method: 'POST';
|
|
155144
|
-
queryParams: {};
|
|
155145
|
-
jsonBody: {
|
|
155146
|
-
/** ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. */
|
|
155147
|
-
acs_encoder_id: string;
|
|
155148
|
-
/** Scenario to simulate. */
|
|
155149
|
-
scenario?: 'credential_exists_on_seam' | 'credential_on_encoder_needs_update';
|
|
155150
|
-
/** ID of the Seam `acs_credential` that matches the `acs_credential` on the encoder in this simulation. */
|
|
155151
|
-
acs_credential_id_on_seam?: string | undefined;
|
|
155152
|
-
} | {
|
|
155153
|
-
/** ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. */
|
|
155154
|
-
acs_encoder_id: string;
|
|
155155
|
-
/** Scenario to simulate. */
|
|
155156
|
-
scenario: 'credential_does_not_exist_on_seam';
|
|
155157
|
-
} | {
|
|
155158
|
-
/** ID of the `acs_encoder` that will be used in the next request to scan the `acs_credential`. */
|
|
155159
|
-
acs_encoder_id: string;
|
|
155160
|
-
/** Scenario to simulate. */
|
|
155161
|
-
scenario: 'credential_on_encoder_is_empty';
|
|
155162
|
-
};
|
|
155163
|
-
commonParams: {};
|
|
155164
|
-
formData: {};
|
|
155165
|
-
jsonResponse: {};
|
|
155166
|
-
maxDuration: undefined;
|
|
155167
|
-
};
|
|
155168
|
-
'/acs/entrances/get': {
|
|
155169
|
-
route: '/acs/entrances/get';
|
|
155170
|
-
method: 'GET' | 'POST';
|
|
155171
|
-
queryParams: {};
|
|
155172
|
-
jsonBody: {};
|
|
155173
|
-
commonParams: {
|
|
155174
|
-
/** ID of the entrance that you want to get. */
|
|
155175
|
-
acs_entrance_id: string;
|
|
155176
|
-
};
|
|
155177
|
-
formData: {};
|
|
155178
|
-
jsonResponse: {
|
|
155179
|
-
/** Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
|
|
155180
|
-
|
|
155181
|
-
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance. */
|
|
155182
|
-
acs_entrance: {
|
|
155183
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155184
|
-
acs_system_id: string;
|
|
155185
|
-
/** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155186
|
-
acs_entrance_id: string;
|
|
155187
|
-
/** IDs of the spaces that the entrance is in. */
|
|
155188
|
-
space_ids: string[];
|
|
155189
|
-
/** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
|
|
155190
|
-
created_at: string;
|
|
155191
|
-
/** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155192
|
-
display_name: string;
|
|
155193
|
-
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155194
|
-
connected_account_id: string;
|
|
155195
|
-
/** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155196
|
-
errors: {
|
|
155197
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
155198
|
-
error_code: string;
|
|
155199
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155200
|
-
message: string;
|
|
155201
|
-
}[];
|
|
155202
|
-
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155203
|
-
latch_metadata?: {
|
|
155204
|
-
/** Accessibility type in the Latch access system. */
|
|
155205
|
-
accessibility_type: string;
|
|
155206
|
-
/** Name of the door in the Latch access system. */
|
|
155207
|
-
door_name: string;
|
|
155208
|
-
/** Type of the door in the Latch access system. */
|
|
155209
|
-
door_type: string;
|
|
155210
|
-
/** Indicates whether the entrance is connected. */
|
|
155211
|
-
is_connected: boolean;
|
|
155212
|
-
} | undefined;
|
|
155213
|
-
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155214
|
-
hotek_metadata?: {
|
|
155215
|
-
/** Room number of the entrance. */
|
|
155216
|
-
room_number?: string | undefined;
|
|
155217
|
-
/** Display name of the entrance. */
|
|
155218
|
-
common_area_number?: string | undefined;
|
|
155219
|
-
/** Display name of the entrance. */
|
|
155220
|
-
common_area_name?: string | undefined;
|
|
155221
|
-
} | undefined;
|
|
155222
|
-
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155223
|
-
visionline_metadata?: {
|
|
155224
|
-
/** Name of the door in the Visionline access system. */
|
|
155225
|
-
door_name: string;
|
|
155226
|
-
/** Category of the door in the Visionline access system. */
|
|
155227
|
-
door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
|
|
155228
|
-
/** Profile for the door in the Visionline access system. */
|
|
155229
|
-
profiles?: {
|
|
155230
|
-
/** Door profile ID in the Visionline access system. */
|
|
155231
|
-
visionline_door_profile_id: string;
|
|
155232
|
-
/** Door profile type in the Visionline access system. */
|
|
155233
|
-
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
|
|
155234
|
-
}[] | undefined;
|
|
155235
|
-
} | undefined;
|
|
155236
|
-
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155237
|
-
salto_ks_metadata?: {
|
|
155238
|
-
/** Name of the door in the Salto KS access system. */
|
|
155239
|
-
door_name: string;
|
|
155240
|
-
/** Locked state of the door in the Salto KS access system. */
|
|
155241
|
-
locked_state: string;
|
|
155242
|
-
/** Type of the lock in the Salto KS access system. */
|
|
155243
|
-
lock_type: string;
|
|
155244
|
-
/** Indicates whether the door access device is online. */
|
|
155245
|
-
online?: boolean | undefined;
|
|
155246
|
-
/** Battery level of the door access device. */
|
|
155247
|
-
battery_level: string;
|
|
155248
|
-
/** Indicates whether the door is left open. */
|
|
155249
|
-
left_open_alarm?: boolean | undefined;
|
|
155250
|
-
/** Indicates whether an intrusion alarm is active on the door. */
|
|
155251
|
-
intrusion_alarm?: boolean | undefined;
|
|
155252
|
-
/** Indicates whether privacy mode is enabled for the lock. */
|
|
155253
|
-
privacy_mode?: boolean | undefined;
|
|
155254
|
-
} | undefined;
|
|
155255
|
-
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155256
|
-
dormakaba_community_metadata?: {
|
|
155257
|
-
/** Type of access point profile in the dormakaba Community access system. */
|
|
155258
|
-
access_point_profile: string;
|
|
155259
|
-
} | undefined;
|
|
155260
|
-
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155261
|
-
assa_abloy_vostio_metadata?: {
|
|
155262
|
-
/** Type of the door in the Vostio access system. */
|
|
155263
|
-
door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
|
|
155264
|
-
/** Name of the door in the Vostio access system. */
|
|
155265
|
-
door_name: string;
|
|
155266
|
-
/** Number of the door in the Vostio access system. */
|
|
155267
|
-
door_number?: number | undefined;
|
|
155268
|
-
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
155269
|
-
stand_open?: boolean | undefined;
|
|
155270
|
-
/** PMS ID of the door in the Vostio access system. */
|
|
155271
|
-
pms_id?: string | undefined;
|
|
155272
|
-
} | undefined;
|
|
155273
|
-
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155274
|
-
salto_space_metadata?: {
|
|
155275
|
-
/** Door ID in the Salto Space access system. */
|
|
155276
|
-
door_id?: string | undefined;
|
|
155277
|
-
/** Name of the door in the Salto Space access system. */
|
|
155278
|
-
door_name?: string | undefined;
|
|
155279
|
-
/** Description of the door in the Salto Space access system. */
|
|
155280
|
-
door_description?: string | undefined;
|
|
155281
|
-
/** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
|
|
155282
|
-
audit_on_keys?: boolean | undefined;
|
|
155283
|
-
/** Name of the room in the Salto Space access system. */
|
|
155284
|
-
room_name?: string | undefined;
|
|
155285
|
-
/** Description of the room in the Salto Space access system. */
|
|
155286
|
-
room_description?: string | undefined;
|
|
155287
|
-
} | undefined;
|
|
155288
|
-
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155289
|
-
dormakaba_ambiance_metadata?: {
|
|
155290
|
-
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
155291
|
-
access_point_name: string;
|
|
155292
|
-
} | undefined;
|
|
155293
|
-
/** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155294
|
-
brivo_metadata?: {
|
|
155295
|
-
/** ID of the access point in the Brivo access system. */
|
|
155296
|
-
access_point_id: string;
|
|
155297
|
-
/** ID of the site that the access point belongs to. */
|
|
155298
|
-
site_id: number;
|
|
155299
|
-
/** Name of the site that the access point belongs to. */
|
|
155300
|
-
site_name: string;
|
|
155301
|
-
} | undefined;
|
|
155302
|
-
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
155303
|
-
can_unlock_with_mobile_key?: boolean | undefined;
|
|
155304
|
-
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
155305
|
-
can_unlock_with_card?: boolean | undefined;
|
|
155306
|
-
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
155307
|
-
can_unlock_with_code?: boolean | undefined;
|
|
155308
|
-
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
155309
|
-
can_belong_to_reservation?: boolean | undefined;
|
|
155310
|
-
};
|
|
155311
|
-
};
|
|
155312
|
-
maxDuration: undefined;
|
|
155313
|
-
};
|
|
155314
|
-
'/acs/entrances/grant_access': {
|
|
155315
|
-
route: '/acs/entrances/grant_access';
|
|
155316
|
-
method: 'POST';
|
|
155317
|
-
queryParams: {};
|
|
155318
|
-
jsonBody: {
|
|
155319
|
-
/** ID of the entrance to which you want to grant an access system user access. */
|
|
155320
|
-
acs_entrance_id: string;
|
|
155321
|
-
/** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
|
|
155322
|
-
user_identity_id?: string | undefined;
|
|
155323
|
-
/** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
|
|
155324
|
-
acs_user_id?: string | undefined;
|
|
155325
|
-
};
|
|
155326
|
-
commonParams: {};
|
|
155327
|
-
formData: {};
|
|
155328
|
-
jsonResponse: {};
|
|
155329
|
-
maxDuration: undefined;
|
|
155330
|
-
};
|
|
155331
|
-
'/acs/entrances/list': {
|
|
155332
|
-
route: '/acs/entrances/list';
|
|
155333
|
-
method: 'GET' | 'POST';
|
|
155334
|
-
queryParams: {};
|
|
155335
|
-
jsonBody: {};
|
|
155336
|
-
commonParams: {
|
|
155337
|
-
/** Customer key for which you want to list entrances. */
|
|
155338
|
-
customer_key?: string | undefined;
|
|
155339
|
-
/** ID of the access system for which you want to retrieve all entrances. */
|
|
155340
|
-
acs_system_id?: string | undefined;
|
|
155341
|
-
/** ID of the credential for which you want to retrieve all entrances. */
|
|
155342
|
-
acs_credential_id?: string | undefined;
|
|
155343
|
-
/**
|
|
155344
|
-
* @deprecated Use `space_id`.*/
|
|
155345
|
-
location_id?: (string | null) | undefined;
|
|
155346
|
-
/** ID of the space for which you want to list entrances. */
|
|
155347
|
-
space_id?: string | undefined;
|
|
155348
|
-
/** ID of the connected account for which you want to retrieve all entrances. */
|
|
155349
|
-
connected_account_id?: string | undefined;
|
|
155350
|
-
/** IDs of the entrances for which you want to retrieve all entrances. */
|
|
155351
|
-
acs_entrance_ids?: string[] | undefined;
|
|
155352
|
-
/** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
|
|
155353
|
-
search?: string | undefined;
|
|
155354
|
-
/** Maximum number of records to return per page. */
|
|
155355
|
-
limit?: number;
|
|
155356
|
-
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
155357
|
-
page_cursor?: (string | undefined) | null;
|
|
155358
|
-
};
|
|
155359
|
-
formData: {};
|
|
155360
|
-
jsonResponse: {
|
|
155361
|
-
acs_entrances: {
|
|
155362
|
-
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155363
|
-
acs_system_id: string;
|
|
155364
|
-
/** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155365
|
-
acs_entrance_id: string;
|
|
155366
|
-
/** IDs of the spaces that the entrance is in. */
|
|
155367
|
-
space_ids: string[];
|
|
155368
|
-
/** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
|
|
155369
|
-
created_at: string;
|
|
155370
|
-
/** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155371
|
-
display_name: string;
|
|
155372
|
-
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155373
|
-
connected_account_id: string;
|
|
155374
|
-
/** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155375
|
-
errors: {
|
|
155376
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
155377
|
-
error_code: string;
|
|
155378
|
-
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155379
|
-
message: string;
|
|
155380
|
-
}[];
|
|
155381
|
-
/** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155382
|
-
latch_metadata?: {
|
|
155383
|
-
/** Accessibility type in the Latch access system. */
|
|
155384
|
-
accessibility_type: string;
|
|
155385
|
-
/** Name of the door in the Latch access system. */
|
|
155386
|
-
door_name: string;
|
|
155387
|
-
/** Type of the door in the Latch access system. */
|
|
155388
|
-
door_type: string;
|
|
155389
|
-
/** Indicates whether the entrance is connected. */
|
|
155390
|
-
is_connected: boolean;
|
|
155391
|
-
} | undefined;
|
|
155392
|
-
/** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155393
|
-
hotek_metadata?: {
|
|
155394
|
-
/** Room number of the entrance. */
|
|
155395
|
-
room_number?: string | undefined;
|
|
155396
|
-
/** Display name of the entrance. */
|
|
155397
|
-
common_area_number?: string | undefined;
|
|
155398
|
-
/** Display name of the entrance. */
|
|
155399
|
-
common_area_name?: string | undefined;
|
|
155400
|
-
} | undefined;
|
|
155401
|
-
/** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155402
|
-
visionline_metadata?: {
|
|
155403
|
-
/** Name of the door in the Visionline access system. */
|
|
155404
|
-
door_name: string;
|
|
155405
|
-
/** Category of the door in the Visionline access system. */
|
|
155406
|
-
door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
|
|
155407
|
-
/** Profile for the door in the Visionline access system. */
|
|
155408
|
-
profiles?: {
|
|
155409
|
-
/** Door profile ID in the Visionline access system. */
|
|
155410
|
-
visionline_door_profile_id: string;
|
|
155411
|
-
/** Door profile type in the Visionline access system. */
|
|
155412
|
-
visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
|
|
155413
|
-
}[] | undefined;
|
|
155414
|
-
} | undefined;
|
|
155415
|
-
/** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155416
|
-
salto_ks_metadata?: {
|
|
155417
|
-
/** Name of the door in the Salto KS access system. */
|
|
155418
|
-
door_name: string;
|
|
155419
|
-
/** Locked state of the door in the Salto KS access system. */
|
|
155420
|
-
locked_state: string;
|
|
155421
|
-
/** Type of the lock in the Salto KS access system. */
|
|
155422
|
-
lock_type: string;
|
|
155423
|
-
/** Indicates whether the door access device is online. */
|
|
155424
|
-
online?: boolean | undefined;
|
|
155425
|
-
/** Battery level of the door access device. */
|
|
155426
|
-
battery_level: string;
|
|
155427
|
-
/** Indicates whether the door is left open. */
|
|
155428
|
-
left_open_alarm?: boolean | undefined;
|
|
155429
|
-
/** Indicates whether an intrusion alarm is active on the door. */
|
|
155430
|
-
intrusion_alarm?: boolean | undefined;
|
|
155431
|
-
/** Indicates whether privacy mode is enabled for the lock. */
|
|
155432
|
-
privacy_mode?: boolean | undefined;
|
|
155433
|
-
} | undefined;
|
|
155434
|
-
/** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155435
|
-
dormakaba_community_metadata?: {
|
|
155436
|
-
/** Type of access point profile in the dormakaba Community access system. */
|
|
155437
|
-
access_point_profile: string;
|
|
155438
|
-
} | undefined;
|
|
155439
|
-
/** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155440
|
-
assa_abloy_vostio_metadata?: {
|
|
155441
|
-
/** Type of the door in the Vostio access system. */
|
|
155442
|
-
door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
|
|
155443
|
-
/** Name of the door in the Vostio access system. */
|
|
155444
|
-
door_name: string;
|
|
155445
|
-
/** Number of the door in the Vostio access system. */
|
|
155446
|
-
door_number?: number | undefined;
|
|
155447
|
-
/** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
|
|
155448
|
-
stand_open?: boolean | undefined;
|
|
155449
|
-
/** PMS ID of the door in the Vostio access system. */
|
|
155450
|
-
pms_id?: string | undefined;
|
|
155451
|
-
} | undefined;
|
|
155452
|
-
/** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155453
|
-
salto_space_metadata?: {
|
|
155454
|
-
/** Door ID in the Salto Space access system. */
|
|
155455
|
-
door_id?: string | undefined;
|
|
155456
|
-
/** Name of the door in the Salto Space access system. */
|
|
155457
|
-
door_name?: string | undefined;
|
|
155458
|
-
/** Description of the door in the Salto Space access system. */
|
|
155459
|
-
door_description?: string | undefined;
|
|
155460
|
-
/** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
|
|
155461
|
-
audit_on_keys?: boolean | undefined;
|
|
155462
|
-
/** Name of the room in the Salto Space access system. */
|
|
155463
|
-
room_name?: string | undefined;
|
|
155464
|
-
/** Description of the room in the Salto Space access system. */
|
|
155465
|
-
room_description?: string | undefined;
|
|
155466
|
-
} | undefined;
|
|
155467
|
-
/** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155468
|
-
dormakaba_ambiance_metadata?: {
|
|
155469
|
-
/** Name of the access point in the dormakaba Ambiance access system. */
|
|
155470
|
-
access_point_name: string;
|
|
155471
|
-
} | undefined;
|
|
155472
|
-
/** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
|
|
155473
|
-
brivo_metadata?: {
|
|
155474
|
-
/** ID of the access point in the Brivo access system. */
|
|
155475
|
-
access_point_id: string;
|
|
155476
|
-
/** ID of the site that the access point belongs to. */
|
|
155477
|
-
site_id: number;
|
|
155478
|
-
/** Name of the site that the access point belongs to. */
|
|
155479
|
-
site_name: string;
|
|
155480
|
-
} | undefined;
|
|
155481
|
-
/** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
|
|
155482
|
-
can_unlock_with_mobile_key?: boolean | undefined;
|
|
155483
|
-
/** Indicates whether the ACS entrance can be unlocked with card credentials. */
|
|
155484
|
-
can_unlock_with_card?: boolean | undefined;
|
|
155485
|
-
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
155486
|
-
can_unlock_with_code?: boolean | undefined;
|
|
155487
|
-
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
155488
|
-
can_belong_to_reservation?: boolean | undefined;
|
|
155489
|
-
}[];
|
|
155490
|
-
/** Information about the current page of results. */
|
|
155491
|
-
pagination: {
|
|
155492
|
-
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
155493
|
-
next_page_cursor: string | null;
|
|
155494
|
-
/** Indicates whether there is another page of results after this one. */
|
|
155495
|
-
has_next_page: boolean;
|
|
155496
|
-
/** URL to get the next page of results. */
|
|
155497
|
-
next_page_url: string | null;
|
|
155498
|
-
};
|
|
155499
|
-
};
|
|
155500
|
-
maxDuration: undefined;
|
|
155501
|
-
};
|
|
155502
|
-
'/acs/entrances/list_credentials_with_access': {
|
|
155503
|
-
route: '/acs/entrances/list_credentials_with_access';
|
|
155504
|
-
method: 'GET' | 'POST';
|
|
155505
|
-
queryParams: {};
|
|
155506
|
-
jsonBody: {};
|
|
155507
|
-
commonParams: {
|
|
155508
|
-
/** ID of the entrance for which you want to list all credentials that grant access. */
|
|
155509
|
-
acs_entrance_id: string;
|
|
155510
|
-
/** Conditions that credentials must meet to be included in the returned list. */
|
|
155511
|
-
include_if?: 'visionline_metadata.is_valid'[] | undefined;
|
|
155512
|
-
};
|
|
155513
|
-
formData: {};
|
|
155514
|
-
jsonResponse: {
|
|
155515
|
-
acs_credentials: {
|
|
155516
|
-
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155517
|
-
acs_credential_id: string;
|
|
155518
|
-
/** 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. */
|
|
155519
|
-
acs_user_id?: string | undefined;
|
|
155520
|
-
/** 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. */
|
|
155521
|
-
user_identity_id?: string | undefined;
|
|
155522
|
-
/** 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. */
|
|
155523
|
-
connected_account_id: string;
|
|
155524
|
-
acs_credential_pool_id?: string | undefined;
|
|
155525
|
-
/** 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). */
|
|
155526
|
-
acs_system_id: string;
|
|
155527
|
-
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155528
|
-
parent_acs_credential_id?: string | undefined;
|
|
155529
|
-
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
155530
|
-
display_name: string;
|
|
155531
|
-
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155532
|
-
code?: (string | undefined) | null;
|
|
155533
|
-
/** 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. */
|
|
155534
|
-
is_one_time_use?: boolean | undefined;
|
|
155535
|
-
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155536
|
-
card_number?: (string | undefined) | null;
|
|
155537
|
-
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
155538
|
-
is_issued?: boolean | undefined;
|
|
155539
|
-
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
155540
|
-
issued_at?: (string | undefined) | null;
|
|
155541
|
-
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
155542
|
-
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
155543
|
-
/** 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`. */
|
|
155544
|
-
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;
|
|
155545
|
-
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
155546
|
-
external_type_display_name?: string | undefined;
|
|
155547
|
-
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
155548
|
-
created_at: string;
|
|
155549
|
-
/** 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). */
|
|
155550
|
-
workspace_id: string;
|
|
155551
|
-
/** 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. */
|
|
155552
|
-
starts_at?: string | undefined;
|
|
155553
|
-
/** 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`. */
|
|
155554
|
-
ends_at?: string | undefined;
|
|
155555
|
-
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155556
|
-
errors: {
|
|
155557
|
-
error_code: string;
|
|
155558
|
-
message: string;
|
|
155559
|
-
}[];
|
|
155560
|
-
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155561
|
-
warnings: ({
|
|
155562
|
-
/** Date and time at which Seam created the warning. */
|
|
155563
|
-
created_at: string;
|
|
155564
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155565
|
-
message: string;
|
|
155566
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155567
|
-
warning_code: 'waiting_to_be_issued';
|
|
155568
|
-
} | {
|
|
155569
|
-
/** Date and time at which Seam created the warning. */
|
|
155570
|
-
created_at: string;
|
|
155571
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155572
|
-
message: string;
|
|
155573
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155574
|
-
warning_code: 'schedule_externally_modified';
|
|
155575
|
-
} | {
|
|
155576
|
-
/** Date and time at which Seam created the warning. */
|
|
155577
|
-
created_at: string;
|
|
155578
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155579
|
-
message: string;
|
|
155580
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155581
|
-
warning_code: 'schedule_modified';
|
|
155582
|
-
} | {
|
|
155583
|
-
/** Date and time at which Seam created the warning. */
|
|
155584
|
-
created_at: string;
|
|
155585
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155586
|
-
message: string;
|
|
155587
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155588
|
-
warning_code: 'being_deleted';
|
|
155589
|
-
} | {
|
|
155590
|
-
/** Date and time at which Seam created the warning. */
|
|
155591
|
-
created_at: string;
|
|
155592
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155593
|
-
message: string;
|
|
155594
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155595
|
-
warning_code: 'unknown_issue_with_acs_credential';
|
|
155596
|
-
} | {
|
|
155597
|
-
/** Date and time at which Seam created the warning. */
|
|
155598
|
-
created_at: string;
|
|
155599
|
-
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155600
|
-
message: string;
|
|
155601
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155602
|
-
warning_code: 'needs_to_be_reissued';
|
|
155603
|
-
})[];
|
|
155604
|
-
/** 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). */
|
|
155605
|
-
is_multi_phone_sync_credential?: boolean | undefined;
|
|
155606
|
-
/** 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. */
|
|
155607
|
-
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
155608
|
-
/** 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. */
|
|
155609
|
-
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
155610
|
-
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155611
|
-
visionline_metadata?: {
|
|
155612
|
-
/** Card function type in the Visionline access system. */
|
|
155613
|
-
card_function_type: 'guest' | 'staff';
|
|
155614
|
-
/** IDs of the credentials to which you want to join. */
|
|
155615
|
-
joiner_acs_credential_ids?: string[] | undefined;
|
|
155616
|
-
/** Guest entrance IDs in the Visionline access system. */
|
|
155617
|
-
guest_acs_entrance_ids?: string[] | undefined;
|
|
155618
|
-
/** Common entrance IDs in the Visionline access system. */
|
|
155619
|
-
common_acs_entrance_ids?: string[] | undefined;
|
|
155620
|
-
/** Indicates whether the credential is valid. */
|
|
155621
|
-
is_valid?: boolean | undefined;
|
|
155622
|
-
/** 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. */
|
|
155623
|
-
auto_join?: boolean | undefined;
|
|
155624
|
-
/** ID of the card in the Visionline access system. */
|
|
155625
|
-
card_id?: string | undefined;
|
|
155626
|
-
/** ID of the credential in the Visionline access system. */
|
|
155627
|
-
credential_id?: string | undefined;
|
|
155628
|
-
} | undefined;
|
|
155629
|
-
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155630
|
-
assa_abloy_vostio_metadata?: {
|
|
155631
|
-
/** 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. */
|
|
155632
|
-
auto_join?: boolean | undefined;
|
|
155633
|
-
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
155634
|
-
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
155635
|
-
/** Key ID in the Vostio access system. */
|
|
155636
|
-
key_id?: string | undefined;
|
|
155637
|
-
/** Key issuing request ID in the Vostio access system. */
|
|
155638
|
-
key_issuing_request_id?: string | undefined;
|
|
155639
|
-
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
155640
|
-
door_names?: string[] | undefined;
|
|
155641
|
-
/** Endpoint ID in the Vostio access system. */
|
|
155642
|
-
endpoint_id?: string | undefined;
|
|
155643
|
-
} | undefined;
|
|
155644
|
-
is_managed: true;
|
|
155645
|
-
}[];
|
|
155646
|
-
};
|
|
155647
|
-
maxDuration: undefined;
|
|
155648
|
-
};
|
|
155649
157030
|
'/acs/systems/get': {
|
|
155650
157031
|
route: '/acs/systems/get';
|
|
155651
157032
|
method: 'GET' | 'POST';
|
|
@@ -157066,6 +158447,8 @@ type Routes = {
|
|
|
157066
158447
|
can_unlock_with_code?: boolean | undefined;
|
|
157067
158448
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
157068
158449
|
can_belong_to_reservation?: boolean | undefined;
|
|
158450
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
158451
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
157069
158452
|
}[];
|
|
157070
158453
|
};
|
|
157071
158454
|
maxDuration: undefined;
|
|
@@ -195732,6 +197115,8 @@ type Routes = {
|
|
|
195732
197115
|
can_unlock_with_code?: boolean | undefined;
|
|
195733
197116
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
195734
197117
|
can_belong_to_reservation?: boolean | undefined;
|
|
197118
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
197119
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
195735
197120
|
}[];
|
|
195736
197121
|
}[];
|
|
195737
197122
|
}[];
|
|
@@ -197441,6 +198826,8 @@ type Routes = {
|
|
|
197441
198826
|
can_unlock_with_code?: boolean | undefined;
|
|
197442
198827
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
197443
198828
|
can_belong_to_reservation?: boolean | undefined;
|
|
198829
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
198830
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
197444
198831
|
}[] | undefined;
|
|
197445
198832
|
connected_accounts?: {
|
|
197446
198833
|
/** ID of the connected account. */
|
|
@@ -219506,6 +220893,8 @@ type Routes = {
|
|
|
219506
220893
|
can_unlock_with_code?: boolean | undefined;
|
|
219507
220894
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
219508
220895
|
can_belong_to_reservation?: boolean | undefined;
|
|
220896
|
+
/** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
|
|
220897
|
+
can_unlock_with_cloud_key?: boolean | undefined;
|
|
219509
220898
|
}[] | undefined;
|
|
219510
220899
|
acs_systems?: {
|
|
219511
220900
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
@@ -219922,6 +221311,13 @@ type Routes = {
|
|
|
219922
221311
|
message: string;
|
|
219923
221312
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
219924
221313
|
mutation_code: 'deleting';
|
|
221314
|
+
} | {
|
|
221315
|
+
/** Date and time at which the mutation was created. */
|
|
221316
|
+
created_at: string;
|
|
221317
|
+
/** Detailed description of the mutation. */
|
|
221318
|
+
message: string;
|
|
221319
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
221320
|
+
mutation_code: 'deferring_deletion';
|
|
219925
221321
|
} | {
|
|
219926
221322
|
/** Date and time at which the mutation was created. */
|
|
219927
221323
|
created_at: string;
|
|
@@ -220005,13 +221401,6 @@ type Routes = {
|
|
|
220005
221401
|
acs_user_id: string;
|
|
220006
221402
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
220007
221403
|
variant: 'adding' | 'removing';
|
|
220008
|
-
} | {
|
|
220009
|
-
/** Date and time at which the mutation was created. */
|
|
220010
|
-
created_at: string;
|
|
220011
|
-
/** Detailed description of the mutation. */
|
|
220012
|
-
message: string;
|
|
220013
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
220014
|
-
mutation_code: 'deferring_deletion';
|
|
220015
221404
|
})[];
|
|
220016
221405
|
is_managed: true;
|
|
220017
221406
|
}[] | undefined;
|
|
@@ -221618,6 +223007,13 @@ type Routes = {
|
|
|
221618
223007
|
message: string;
|
|
221619
223008
|
/** Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system. */
|
|
221620
223009
|
mutation_code: 'deleting';
|
|
223010
|
+
} | {
|
|
223011
|
+
/** Date and time at which the mutation was created. */
|
|
223012
|
+
created_at: string;
|
|
223013
|
+
/** Detailed description of the mutation. */
|
|
223014
|
+
message: string;
|
|
223015
|
+
/** Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires. */
|
|
223016
|
+
mutation_code: 'deferring_deletion';
|
|
221621
223017
|
} | {
|
|
221622
223018
|
/** Date and time at which the mutation was created. */
|
|
221623
223019
|
created_at: string;
|
|
@@ -221701,13 +223097,6 @@ type Routes = {
|
|
|
221701
223097
|
acs_user_id: string;
|
|
221702
223098
|
/** Whether the user is scheduled to be added to or removed from this access group. */
|
|
221703
223099
|
variant: 'adding' | 'removing';
|
|
221704
|
-
} | {
|
|
221705
|
-
/** Date and time at which the mutation was created. */
|
|
221706
|
-
created_at: string;
|
|
221707
|
-
/** Detailed description of the mutation. */
|
|
221708
|
-
message: string;
|
|
221709
|
-
/** Mutation code to indicate that this access group is scheduled for deletion when its ends_at time passes. */
|
|
221710
|
-
mutation_code: 'deferring_deletion';
|
|
221711
223100
|
})[];
|
|
221712
223101
|
is_managed: false;
|
|
221713
223102
|
}[] | undefined;
|