@seamapi/types 1.749.0 → 1.751.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 +114 -48
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1979 -614
- package/dist/index.cjs +114 -48
- package/dist/index.cjs.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 +5 -0
- package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
- package/lib/seam/connect/openapi.d.ts +121 -63
- package/lib/seam/connect/openapi.js +111 -48
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1304 -5
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
- package/src/lib/seam/connect/openapi.ts +118 -48
- package/src/lib/seam/connect/route-types.ts +1507 -5
package/dist/connect.d.cts
CHANGED
|
@@ -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;
|
|
@@ -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;
|
|
@@ -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;
|
|
@@ -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,68 +94742,7 @@ declare const _default: {
|
|
|
94726
94742
|
'x-title': string;
|
|
94727
94743
|
};
|
|
94728
94744
|
};
|
|
94729
|
-
'/acs/
|
|
94730
|
-
get: {
|
|
94731
|
-
description: string;
|
|
94732
|
-
operationId: string;
|
|
94733
|
-
parameters: {
|
|
94734
|
-
in: string;
|
|
94735
|
-
name: string;
|
|
94736
|
-
required: boolean;
|
|
94737
|
-
schema: {
|
|
94738
|
-
description: string;
|
|
94739
|
-
format: string;
|
|
94740
|
-
type: string;
|
|
94741
|
-
};
|
|
94742
|
-
}[];
|
|
94743
|
-
responses: {
|
|
94744
|
-
200: {
|
|
94745
|
-
content: {
|
|
94746
|
-
'application/json': {
|
|
94747
|
-
schema: {
|
|
94748
|
-
properties: {
|
|
94749
|
-
acs_system: {
|
|
94750
|
-
$ref: string;
|
|
94751
|
-
};
|
|
94752
|
-
ok: {
|
|
94753
|
-
type: string;
|
|
94754
|
-
};
|
|
94755
|
-
};
|
|
94756
|
-
required: string[];
|
|
94757
|
-
type: string;
|
|
94758
|
-
};
|
|
94759
|
-
};
|
|
94760
|
-
};
|
|
94761
|
-
description: string;
|
|
94762
|
-
};
|
|
94763
|
-
400: {
|
|
94764
|
-
description: string;
|
|
94765
|
-
};
|
|
94766
|
-
401: {
|
|
94767
|
-
description: string;
|
|
94768
|
-
};
|
|
94769
|
-
};
|
|
94770
|
-
security: ({
|
|
94771
|
-
pat_with_workspace: never[];
|
|
94772
|
-
console_session_with_workspace?: never;
|
|
94773
|
-
api_key?: never;
|
|
94774
|
-
} | {
|
|
94775
|
-
console_session_with_workspace: never[];
|
|
94776
|
-
pat_with_workspace?: never;
|
|
94777
|
-
api_key?: never;
|
|
94778
|
-
} | {
|
|
94779
|
-
api_key: never[];
|
|
94780
|
-
pat_with_workspace?: never;
|
|
94781
|
-
console_session_with_workspace?: never;
|
|
94782
|
-
})[];
|
|
94783
|
-
summary: string;
|
|
94784
|
-
tags: string[];
|
|
94785
|
-
'x-fern-sdk-group-name': string[];
|
|
94786
|
-
'x-fern-sdk-method-name': string;
|
|
94787
|
-
'x-fern-sdk-return-value': string;
|
|
94788
|
-
'x-response-key': string;
|
|
94789
|
-
'x-title': string;
|
|
94790
|
-
};
|
|
94745
|
+
'/acs/entrances/unlock': {
|
|
94791
94746
|
post: {
|
|
94792
94747
|
description: string;
|
|
94793
94748
|
operationId: string;
|
|
@@ -94796,191 +94751,18 @@ declare const _default: {
|
|
|
94796
94751
|
'application/json': {
|
|
94797
94752
|
schema: {
|
|
94798
94753
|
properties: {
|
|
94799
|
-
|
|
94754
|
+
acs_credential_id: {
|
|
94800
94755
|
description: string;
|
|
94801
94756
|
format: string;
|
|
94802
94757
|
type: string;
|
|
94803
94758
|
};
|
|
94804
|
-
|
|
94805
|
-
required: string[];
|
|
94806
|
-
type: string;
|
|
94807
|
-
};
|
|
94808
|
-
};
|
|
94809
|
-
};
|
|
94810
|
-
};
|
|
94811
|
-
responses: {
|
|
94812
|
-
200: {
|
|
94813
|
-
content: {
|
|
94814
|
-
'application/json': {
|
|
94815
|
-
schema: {
|
|
94816
|
-
properties: {
|
|
94817
|
-
acs_system: {
|
|
94818
|
-
$ref: string;
|
|
94819
|
-
};
|
|
94820
|
-
ok: {
|
|
94821
|
-
type: string;
|
|
94822
|
-
};
|
|
94823
|
-
};
|
|
94824
|
-
required: string[];
|
|
94825
|
-
type: string;
|
|
94826
|
-
};
|
|
94827
|
-
};
|
|
94828
|
-
};
|
|
94829
|
-
description: string;
|
|
94830
|
-
};
|
|
94831
|
-
400: {
|
|
94832
|
-
description: string;
|
|
94833
|
-
};
|
|
94834
|
-
401: {
|
|
94835
|
-
description: string;
|
|
94836
|
-
};
|
|
94837
|
-
};
|
|
94838
|
-
security: ({
|
|
94839
|
-
pat_with_workspace: never[];
|
|
94840
|
-
console_session_with_workspace?: never;
|
|
94841
|
-
api_key?: never;
|
|
94842
|
-
} | {
|
|
94843
|
-
console_session_with_workspace: never[];
|
|
94844
|
-
pat_with_workspace?: never;
|
|
94845
|
-
api_key?: never;
|
|
94846
|
-
} | {
|
|
94847
|
-
api_key: never[];
|
|
94848
|
-
pat_with_workspace?: never;
|
|
94849
|
-
console_session_with_workspace?: never;
|
|
94850
|
-
})[];
|
|
94851
|
-
summary: string;
|
|
94852
|
-
tags: string[];
|
|
94853
|
-
'x-fern-sdk-group-name': string[];
|
|
94854
|
-
'x-fern-sdk-method-name': string;
|
|
94855
|
-
'x-fern-sdk-return-value': string;
|
|
94856
|
-
'x-response-key': string;
|
|
94857
|
-
'x-title': string;
|
|
94858
|
-
};
|
|
94859
|
-
};
|
|
94860
|
-
'/acs/systems/list': {
|
|
94861
|
-
get: {
|
|
94862
|
-
description: string;
|
|
94863
|
-
operationId: string;
|
|
94864
|
-
parameters: ({
|
|
94865
|
-
in: string;
|
|
94866
|
-
name: string;
|
|
94867
|
-
schema: {
|
|
94868
|
-
description: string;
|
|
94869
|
-
type: string;
|
|
94870
|
-
format?: never;
|
|
94871
|
-
minLength?: never;
|
|
94872
|
-
};
|
|
94873
|
-
} | {
|
|
94874
|
-
in: string;
|
|
94875
|
-
name: string;
|
|
94876
|
-
schema: {
|
|
94877
|
-
description: string;
|
|
94878
|
-
format: string;
|
|
94879
|
-
type: string;
|
|
94880
|
-
minLength?: never;
|
|
94881
|
-
};
|
|
94882
|
-
} | {
|
|
94883
|
-
in: string;
|
|
94884
|
-
name: string;
|
|
94885
|
-
schema: {
|
|
94886
|
-
description: string;
|
|
94887
|
-
minLength: number;
|
|
94888
|
-
type: string;
|
|
94889
|
-
format?: never;
|
|
94890
|
-
};
|
|
94891
|
-
})[];
|
|
94892
|
-
responses: {
|
|
94893
|
-
200: {
|
|
94894
|
-
content: {
|
|
94895
|
-
'application/json': {
|
|
94896
|
-
schema: {
|
|
94897
|
-
properties: {
|
|
94898
|
-
acs_systems: {
|
|
94899
|
-
items: {
|
|
94900
|
-
$ref: string;
|
|
94901
|
-
};
|
|
94902
|
-
type: string;
|
|
94903
|
-
};
|
|
94904
|
-
ok: {
|
|
94905
|
-
type: string;
|
|
94906
|
-
};
|
|
94907
|
-
};
|
|
94908
|
-
required: string[];
|
|
94909
|
-
type: string;
|
|
94910
|
-
};
|
|
94911
|
-
};
|
|
94912
|
-
};
|
|
94913
|
-
description: string;
|
|
94914
|
-
};
|
|
94915
|
-
400: {
|
|
94916
|
-
description: string;
|
|
94917
|
-
};
|
|
94918
|
-
401: {
|
|
94919
|
-
description: string;
|
|
94920
|
-
};
|
|
94921
|
-
};
|
|
94922
|
-
security: ({
|
|
94923
|
-
client_session: never[];
|
|
94924
|
-
pat_with_workspace?: never;
|
|
94925
|
-
console_session_with_workspace?: never;
|
|
94926
|
-
client_session_with_customer?: never;
|
|
94927
|
-
api_key?: never;
|
|
94928
|
-
} | {
|
|
94929
|
-
pat_with_workspace: never[];
|
|
94930
|
-
client_session?: never;
|
|
94931
|
-
console_session_with_workspace?: never;
|
|
94932
|
-
client_session_with_customer?: never;
|
|
94933
|
-
api_key?: never;
|
|
94934
|
-
} | {
|
|
94935
|
-
console_session_with_workspace: never[];
|
|
94936
|
-
client_session?: never;
|
|
94937
|
-
pat_with_workspace?: never;
|
|
94938
|
-
client_session_with_customer?: never;
|
|
94939
|
-
api_key?: never;
|
|
94940
|
-
} | {
|
|
94941
|
-
client_session_with_customer: never[];
|
|
94942
|
-
client_session?: never;
|
|
94943
|
-
pat_with_workspace?: never;
|
|
94944
|
-
console_session_with_workspace?: never;
|
|
94945
|
-
api_key?: never;
|
|
94946
|
-
} | {
|
|
94947
|
-
api_key: never[];
|
|
94948
|
-
client_session?: never;
|
|
94949
|
-
pat_with_workspace?: never;
|
|
94950
|
-
console_session_with_workspace?: never;
|
|
94951
|
-
client_session_with_customer?: never;
|
|
94952
|
-
})[];
|
|
94953
|
-
summary: string;
|
|
94954
|
-
tags: string[];
|
|
94955
|
-
'x-fern-sdk-group-name': string[];
|
|
94956
|
-
'x-fern-sdk-method-name': string;
|
|
94957
|
-
'x-fern-sdk-return-value': string;
|
|
94958
|
-
'x-response-key': string;
|
|
94959
|
-
'x-title': string;
|
|
94960
|
-
};
|
|
94961
|
-
post: {
|
|
94962
|
-
description: string;
|
|
94963
|
-
operationId: string;
|
|
94964
|
-
requestBody: {
|
|
94965
|
-
content: {
|
|
94966
|
-
'application/json': {
|
|
94967
|
-
schema: {
|
|
94968
|
-
properties: {
|
|
94969
|
-
connected_account_id: {
|
|
94759
|
+
acs_entrance_id: {
|
|
94970
94760
|
description: string;
|
|
94971
94761
|
format: string;
|
|
94972
94762
|
type: string;
|
|
94973
94763
|
};
|
|
94974
|
-
customer_key: {
|
|
94975
|
-
description: string;
|
|
94976
|
-
type: string;
|
|
94977
|
-
};
|
|
94978
|
-
search: {
|
|
94979
|
-
description: string;
|
|
94980
|
-
minLength: number;
|
|
94981
|
-
type: string;
|
|
94982
|
-
};
|
|
94983
94764
|
};
|
|
94765
|
+
required: string[];
|
|
94984
94766
|
type: string;
|
|
94985
94767
|
};
|
|
94986
94768
|
};
|
|
@@ -94992,11 +94774,8 @@ declare const _default: {
|
|
|
94992
94774
|
'application/json': {
|
|
94993
94775
|
schema: {
|
|
94994
94776
|
properties: {
|
|
94995
|
-
|
|
94996
|
-
|
|
94997
|
-
$ref: string;
|
|
94998
|
-
};
|
|
94999
|
-
type: string;
|
|
94777
|
+
action_attempt: {
|
|
94778
|
+
$ref: string;
|
|
95000
94779
|
};
|
|
95001
94780
|
ok: {
|
|
95002
94781
|
type: string;
|
|
@@ -95017,38 +94796,21 @@ declare const _default: {
|
|
|
95017
94796
|
};
|
|
95018
94797
|
};
|
|
95019
94798
|
security: ({
|
|
95020
|
-
client_session: never[];
|
|
95021
|
-
pat_with_workspace?: never;
|
|
95022
|
-
console_session_with_workspace?: never;
|
|
95023
|
-
client_session_with_customer?: never;
|
|
95024
|
-
api_key?: never;
|
|
95025
|
-
} | {
|
|
95026
94799
|
pat_with_workspace: never[];
|
|
95027
|
-
client_session?: never;
|
|
95028
94800
|
console_session_with_workspace?: never;
|
|
95029
|
-
client_session_with_customer?: never;
|
|
95030
94801
|
api_key?: never;
|
|
95031
94802
|
} | {
|
|
95032
94803
|
console_session_with_workspace: never[];
|
|
95033
|
-
client_session?: never;
|
|
95034
94804
|
pat_with_workspace?: never;
|
|
95035
|
-
client_session_with_customer?: never;
|
|
95036
|
-
api_key?: never;
|
|
95037
|
-
} | {
|
|
95038
|
-
client_session_with_customer: never[];
|
|
95039
|
-
client_session?: never;
|
|
95040
|
-
pat_with_workspace?: never;
|
|
95041
|
-
console_session_with_workspace?: never;
|
|
95042
94805
|
api_key?: never;
|
|
95043
94806
|
} | {
|
|
95044
94807
|
api_key: never[];
|
|
95045
|
-
client_session?: never;
|
|
95046
94808
|
pat_with_workspace?: never;
|
|
95047
94809
|
console_session_with_workspace?: never;
|
|
95048
|
-
client_session_with_customer?: never;
|
|
95049
94810
|
})[];
|
|
95050
94811
|
summary: string;
|
|
95051
94812
|
tags: string[];
|
|
94813
|
+
'x-action-attempt-type': string;
|
|
95052
94814
|
'x-fern-sdk-group-name': string[];
|
|
95053
94815
|
'x-fern-sdk-method-name': string;
|
|
95054
94816
|
'x-fern-sdk-return-value': string;
|
|
@@ -95056,7 +94818,7 @@ declare const _default: {
|
|
|
95056
94818
|
'x-title': string;
|
|
95057
94819
|
};
|
|
95058
94820
|
};
|
|
95059
|
-
'/acs/systems/
|
|
94821
|
+
'/acs/systems/get': {
|
|
95060
94822
|
get: {
|
|
95061
94823
|
description: string;
|
|
95062
94824
|
operationId: string;
|
|
@@ -95076,11 +94838,341 @@ declare const _default: {
|
|
|
95076
94838
|
'application/json': {
|
|
95077
94839
|
schema: {
|
|
95078
94840
|
properties: {
|
|
95079
|
-
|
|
95080
|
-
|
|
95081
|
-
|
|
95082
|
-
|
|
95083
|
-
type: string;
|
|
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
|
+
};
|
|
94903
|
+
responses: {
|
|
94904
|
+
200: {
|
|
94905
|
+
content: {
|
|
94906
|
+
'application/json': {
|
|
94907
|
+
schema: {
|
|
94908
|
+
properties: {
|
|
94909
|
+
acs_system: {
|
|
94910
|
+
$ref: string;
|
|
94911
|
+
};
|
|
94912
|
+
ok: {
|
|
94913
|
+
type: string;
|
|
94914
|
+
};
|
|
94915
|
+
};
|
|
94916
|
+
required: string[];
|
|
94917
|
+
type: string;
|
|
94918
|
+
};
|
|
94919
|
+
};
|
|
94920
|
+
};
|
|
94921
|
+
description: string;
|
|
94922
|
+
};
|
|
94923
|
+
400: {
|
|
94924
|
+
description: string;
|
|
94925
|
+
};
|
|
94926
|
+
401: {
|
|
94927
|
+
description: string;
|
|
94928
|
+
};
|
|
94929
|
+
};
|
|
94930
|
+
security: ({
|
|
94931
|
+
pat_with_workspace: never[];
|
|
94932
|
+
console_session_with_workspace?: never;
|
|
94933
|
+
api_key?: never;
|
|
94934
|
+
} | {
|
|
94935
|
+
console_session_with_workspace: never[];
|
|
94936
|
+
pat_with_workspace?: never;
|
|
94937
|
+
api_key?: never;
|
|
94938
|
+
} | {
|
|
94939
|
+
api_key: never[];
|
|
94940
|
+
pat_with_workspace?: never;
|
|
94941
|
+
console_session_with_workspace?: never;
|
|
94942
|
+
})[];
|
|
94943
|
+
summary: string;
|
|
94944
|
+
tags: string[];
|
|
94945
|
+
'x-fern-sdk-group-name': string[];
|
|
94946
|
+
'x-fern-sdk-method-name': string;
|
|
94947
|
+
'x-fern-sdk-return-value': string;
|
|
94948
|
+
'x-response-key': string;
|
|
94949
|
+
'x-title': string;
|
|
94950
|
+
};
|
|
94951
|
+
};
|
|
94952
|
+
'/acs/systems/list': {
|
|
94953
|
+
get: {
|
|
94954
|
+
description: string;
|
|
94955
|
+
operationId: string;
|
|
94956
|
+
parameters: ({
|
|
94957
|
+
in: string;
|
|
94958
|
+
name: string;
|
|
94959
|
+
schema: {
|
|
94960
|
+
description: string;
|
|
94961
|
+
type: string;
|
|
94962
|
+
format?: never;
|
|
94963
|
+
minLength?: never;
|
|
94964
|
+
};
|
|
94965
|
+
} | {
|
|
94966
|
+
in: string;
|
|
94967
|
+
name: string;
|
|
94968
|
+
schema: {
|
|
94969
|
+
description: string;
|
|
94970
|
+
format: string;
|
|
94971
|
+
type: string;
|
|
94972
|
+
minLength?: never;
|
|
94973
|
+
};
|
|
94974
|
+
} | {
|
|
94975
|
+
in: string;
|
|
94976
|
+
name: string;
|
|
94977
|
+
schema: {
|
|
94978
|
+
description: string;
|
|
94979
|
+
minLength: number;
|
|
94980
|
+
type: string;
|
|
94981
|
+
format?: never;
|
|
94982
|
+
};
|
|
94983
|
+
})[];
|
|
94984
|
+
responses: {
|
|
94985
|
+
200: {
|
|
94986
|
+
content: {
|
|
94987
|
+
'application/json': {
|
|
94988
|
+
schema: {
|
|
94989
|
+
properties: {
|
|
94990
|
+
acs_systems: {
|
|
94991
|
+
items: {
|
|
94992
|
+
$ref: string;
|
|
94993
|
+
};
|
|
94994
|
+
type: string;
|
|
94995
|
+
};
|
|
94996
|
+
ok: {
|
|
94997
|
+
type: string;
|
|
94998
|
+
};
|
|
94999
|
+
};
|
|
95000
|
+
required: string[];
|
|
95001
|
+
type: string;
|
|
95002
|
+
};
|
|
95003
|
+
};
|
|
95004
|
+
};
|
|
95005
|
+
description: string;
|
|
95006
|
+
};
|
|
95007
|
+
400: {
|
|
95008
|
+
description: string;
|
|
95009
|
+
};
|
|
95010
|
+
401: {
|
|
95011
|
+
description: string;
|
|
95012
|
+
};
|
|
95013
|
+
};
|
|
95014
|
+
security: ({
|
|
95015
|
+
client_session: never[];
|
|
95016
|
+
pat_with_workspace?: never;
|
|
95017
|
+
console_session_with_workspace?: never;
|
|
95018
|
+
client_session_with_customer?: never;
|
|
95019
|
+
api_key?: never;
|
|
95020
|
+
} | {
|
|
95021
|
+
pat_with_workspace: never[];
|
|
95022
|
+
client_session?: never;
|
|
95023
|
+
console_session_with_workspace?: never;
|
|
95024
|
+
client_session_with_customer?: never;
|
|
95025
|
+
api_key?: never;
|
|
95026
|
+
} | {
|
|
95027
|
+
console_session_with_workspace: never[];
|
|
95028
|
+
client_session?: never;
|
|
95029
|
+
pat_with_workspace?: never;
|
|
95030
|
+
client_session_with_customer?: never;
|
|
95031
|
+
api_key?: never;
|
|
95032
|
+
} | {
|
|
95033
|
+
client_session_with_customer: never[];
|
|
95034
|
+
client_session?: never;
|
|
95035
|
+
pat_with_workspace?: never;
|
|
95036
|
+
console_session_with_workspace?: never;
|
|
95037
|
+
api_key?: never;
|
|
95038
|
+
} | {
|
|
95039
|
+
api_key: never[];
|
|
95040
|
+
client_session?: never;
|
|
95041
|
+
pat_with_workspace?: never;
|
|
95042
|
+
console_session_with_workspace?: never;
|
|
95043
|
+
client_session_with_customer?: never;
|
|
95044
|
+
})[];
|
|
95045
|
+
summary: string;
|
|
95046
|
+
tags: string[];
|
|
95047
|
+
'x-fern-sdk-group-name': string[];
|
|
95048
|
+
'x-fern-sdk-method-name': string;
|
|
95049
|
+
'x-fern-sdk-return-value': string;
|
|
95050
|
+
'x-response-key': string;
|
|
95051
|
+
'x-title': string;
|
|
95052
|
+
};
|
|
95053
|
+
post: {
|
|
95054
|
+
description: string;
|
|
95055
|
+
operationId: string;
|
|
95056
|
+
requestBody: {
|
|
95057
|
+
content: {
|
|
95058
|
+
'application/json': {
|
|
95059
|
+
schema: {
|
|
95060
|
+
properties: {
|
|
95061
|
+
connected_account_id: {
|
|
95062
|
+
description: string;
|
|
95063
|
+
format: string;
|
|
95064
|
+
type: string;
|
|
95065
|
+
};
|
|
95066
|
+
customer_key: {
|
|
95067
|
+
description: string;
|
|
95068
|
+
type: string;
|
|
95069
|
+
};
|
|
95070
|
+
search: {
|
|
95071
|
+
description: string;
|
|
95072
|
+
minLength: number;
|
|
95073
|
+
type: string;
|
|
95074
|
+
};
|
|
95075
|
+
};
|
|
95076
|
+
type: string;
|
|
95077
|
+
};
|
|
95078
|
+
};
|
|
95079
|
+
};
|
|
95080
|
+
};
|
|
95081
|
+
responses: {
|
|
95082
|
+
200: {
|
|
95083
|
+
content: {
|
|
95084
|
+
'application/json': {
|
|
95085
|
+
schema: {
|
|
95086
|
+
properties: {
|
|
95087
|
+
acs_systems: {
|
|
95088
|
+
items: {
|
|
95089
|
+
$ref: string;
|
|
95090
|
+
};
|
|
95091
|
+
type: string;
|
|
95092
|
+
};
|
|
95093
|
+
ok: {
|
|
95094
|
+
type: string;
|
|
95095
|
+
};
|
|
95096
|
+
};
|
|
95097
|
+
required: string[];
|
|
95098
|
+
type: string;
|
|
95099
|
+
};
|
|
95100
|
+
};
|
|
95101
|
+
};
|
|
95102
|
+
description: string;
|
|
95103
|
+
};
|
|
95104
|
+
400: {
|
|
95105
|
+
description: string;
|
|
95106
|
+
};
|
|
95107
|
+
401: {
|
|
95108
|
+
description: string;
|
|
95109
|
+
};
|
|
95110
|
+
};
|
|
95111
|
+
security: ({
|
|
95112
|
+
client_session: never[];
|
|
95113
|
+
pat_with_workspace?: never;
|
|
95114
|
+
console_session_with_workspace?: never;
|
|
95115
|
+
client_session_with_customer?: never;
|
|
95116
|
+
api_key?: never;
|
|
95117
|
+
} | {
|
|
95118
|
+
pat_with_workspace: never[];
|
|
95119
|
+
client_session?: never;
|
|
95120
|
+
console_session_with_workspace?: never;
|
|
95121
|
+
client_session_with_customer?: never;
|
|
95122
|
+
api_key?: never;
|
|
95123
|
+
} | {
|
|
95124
|
+
console_session_with_workspace: never[];
|
|
95125
|
+
client_session?: never;
|
|
95126
|
+
pat_with_workspace?: never;
|
|
95127
|
+
client_session_with_customer?: never;
|
|
95128
|
+
api_key?: never;
|
|
95129
|
+
} | {
|
|
95130
|
+
client_session_with_customer: never[];
|
|
95131
|
+
client_session?: never;
|
|
95132
|
+
pat_with_workspace?: never;
|
|
95133
|
+
console_session_with_workspace?: never;
|
|
95134
|
+
api_key?: never;
|
|
95135
|
+
} | {
|
|
95136
|
+
api_key: never[];
|
|
95137
|
+
client_session?: never;
|
|
95138
|
+
pat_with_workspace?: never;
|
|
95139
|
+
console_session_with_workspace?: never;
|
|
95140
|
+
client_session_with_customer?: never;
|
|
95141
|
+
})[];
|
|
95142
|
+
summary: string;
|
|
95143
|
+
tags: string[];
|
|
95144
|
+
'x-fern-sdk-group-name': string[];
|
|
95145
|
+
'x-fern-sdk-method-name': string;
|
|
95146
|
+
'x-fern-sdk-return-value': string;
|
|
95147
|
+
'x-response-key': string;
|
|
95148
|
+
'x-title': string;
|
|
95149
|
+
};
|
|
95150
|
+
};
|
|
95151
|
+
'/acs/systems/list_compatible_credential_manager_acs_systems': {
|
|
95152
|
+
get: {
|
|
95153
|
+
description: string;
|
|
95154
|
+
operationId: string;
|
|
95155
|
+
parameters: {
|
|
95156
|
+
in: string;
|
|
95157
|
+
name: string;
|
|
95158
|
+
required: boolean;
|
|
95159
|
+
schema: {
|
|
95160
|
+
description: string;
|
|
95161
|
+
format: string;
|
|
95162
|
+
type: string;
|
|
95163
|
+
};
|
|
95164
|
+
}[];
|
|
95165
|
+
responses: {
|
|
95166
|
+
200: {
|
|
95167
|
+
content: {
|
|
95168
|
+
'application/json': {
|
|
95169
|
+
schema: {
|
|
95170
|
+
properties: {
|
|
95171
|
+
acs_systems: {
|
|
95172
|
+
items: {
|
|
95173
|
+
$ref: string;
|
|
95174
|
+
};
|
|
95175
|
+
type: string;
|
|
95084
95176
|
};
|
|
95085
95177
|
ok: {
|
|
95086
95178
|
type: string;
|
|
@@ -111970,6 +112062,14 @@ declare const _default: {
|
|
|
111970
112062
|
get: {
|
|
111971
112063
|
description: string;
|
|
111972
112064
|
operationId: string;
|
|
112065
|
+
parameters: {
|
|
112066
|
+
in: string;
|
|
112067
|
+
name: string;
|
|
112068
|
+
schema: {
|
|
112069
|
+
description: string;
|
|
112070
|
+
type: string;
|
|
112071
|
+
};
|
|
112072
|
+
}[];
|
|
111973
112073
|
responses: {
|
|
111974
112074
|
200: {
|
|
111975
112075
|
content: {
|
|
@@ -112239,15 +112339,9 @@ declare const _default: {
|
|
|
112239
112339
|
security: ({
|
|
112240
112340
|
console_session_with_workspace: never[];
|
|
112241
112341
|
api_key?: never;
|
|
112242
|
-
client_session_with_customer?: never;
|
|
112243
112342
|
} | {
|
|
112244
112343
|
api_key: never[];
|
|
112245
112344
|
console_session_with_workspace?: never;
|
|
112246
|
-
client_session_with_customer?: never;
|
|
112247
|
-
} | {
|
|
112248
|
-
client_session_with_customer: never[];
|
|
112249
|
-
console_session_with_workspace?: never;
|
|
112250
|
-
api_key?: never;
|
|
112251
112345
|
})[];
|
|
112252
112346
|
summary: string;
|
|
112253
112347
|
tags: never[];
|
|
@@ -112260,6 +112354,21 @@ declare const _default: {
|
|
|
112260
112354
|
post: {
|
|
112261
112355
|
description: string;
|
|
112262
112356
|
operationId: string;
|
|
112357
|
+
requestBody: {
|
|
112358
|
+
content: {
|
|
112359
|
+
'application/json': {
|
|
112360
|
+
schema: {
|
|
112361
|
+
properties: {
|
|
112362
|
+
customer_key: {
|
|
112363
|
+
description: string;
|
|
112364
|
+
type: string;
|
|
112365
|
+
};
|
|
112366
|
+
};
|
|
112367
|
+
type: string;
|
|
112368
|
+
};
|
|
112369
|
+
};
|
|
112370
|
+
};
|
|
112371
|
+
};
|
|
112263
112372
|
responses: {
|
|
112264
112373
|
200: {
|
|
112265
112374
|
content: {
|
|
@@ -112529,15 +112638,9 @@ declare const _default: {
|
|
|
112529
112638
|
security: ({
|
|
112530
112639
|
console_session_with_workspace: never[];
|
|
112531
112640
|
api_key?: never;
|
|
112532
|
-
client_session_with_customer?: never;
|
|
112533
112641
|
} | {
|
|
112534
112642
|
api_key: never[];
|
|
112535
112643
|
console_session_with_workspace?: never;
|
|
112536
|
-
client_session_with_customer?: never;
|
|
112537
|
-
} | {
|
|
112538
|
-
client_session_with_customer: never[];
|
|
112539
|
-
console_session_with_workspace?: never;
|
|
112540
|
-
api_key?: never;
|
|
112541
112644
|
})[];
|
|
112542
112645
|
summary: string;
|
|
112543
112646
|
tags: never[];
|
|
@@ -112809,6 +112912,10 @@ declare const _default: {
|
|
|
112809
112912
|
};
|
|
112810
112913
|
type: string;
|
|
112811
112914
|
};
|
|
112915
|
+
customer_key: {
|
|
112916
|
+
description: string;
|
|
112917
|
+
type: string;
|
|
112918
|
+
};
|
|
112812
112919
|
};
|
|
112813
112920
|
type: string;
|
|
112814
112921
|
};
|
|
@@ -113114,6 +113221,10 @@ declare const _default: {
|
|
|
113114
113221
|
};
|
|
113115
113222
|
type: string;
|
|
113116
113223
|
};
|
|
113224
|
+
customer_key: {
|
|
113225
|
+
description: string;
|
|
113226
|
+
type: string;
|
|
113227
|
+
};
|
|
113117
113228
|
};
|
|
113118
113229
|
type: string;
|
|
113119
113230
|
};
|
|
@@ -114289,15 +114400,291 @@ declare const _default: {
|
|
|
114289
114400
|
get: {
|
|
114290
114401
|
description: string;
|
|
114291
114402
|
operationId: string;
|
|
114292
|
-
|
|
114293
|
-
|
|
114294
|
-
|
|
114295
|
-
|
|
114296
|
-
|
|
114403
|
+
responses: {
|
|
114404
|
+
200: {
|
|
114405
|
+
content: {
|
|
114406
|
+
'application/json': {
|
|
114407
|
+
schema: {
|
|
114408
|
+
properties: {
|
|
114409
|
+
automation: {
|
|
114410
|
+
properties: {
|
|
114411
|
+
access_rules: {
|
|
114412
|
+
properties: {
|
|
114413
|
+
reservation_created: {
|
|
114414
|
+
properties: {
|
|
114415
|
+
config: {
|
|
114416
|
+
properties: {
|
|
114417
|
+
access_methods: {
|
|
114418
|
+
items: {
|
|
114419
|
+
enum: string[];
|
|
114420
|
+
type: string;
|
|
114421
|
+
};
|
|
114422
|
+
minItems: number;
|
|
114423
|
+
type: string;
|
|
114424
|
+
};
|
|
114425
|
+
card_count_on_reservation_create: {
|
|
114426
|
+
minimum: number;
|
|
114427
|
+
type: string;
|
|
114428
|
+
};
|
|
114429
|
+
code_count_on_reservation_create: {
|
|
114430
|
+
minimum: number;
|
|
114431
|
+
type: string;
|
|
114432
|
+
};
|
|
114433
|
+
instant_key_max_use_count: {
|
|
114434
|
+
minimum: number;
|
|
114435
|
+
type: string;
|
|
114436
|
+
};
|
|
114437
|
+
method_issuance_strategy: {
|
|
114438
|
+
enum: string[];
|
|
114439
|
+
type: string;
|
|
114440
|
+
};
|
|
114441
|
+
};
|
|
114442
|
+
required: string[];
|
|
114443
|
+
type: string;
|
|
114444
|
+
};
|
|
114445
|
+
rule: {
|
|
114446
|
+
enum: string[];
|
|
114447
|
+
type: string;
|
|
114448
|
+
};
|
|
114449
|
+
};
|
|
114450
|
+
required: string[];
|
|
114451
|
+
type: string;
|
|
114452
|
+
};
|
|
114453
|
+
reservation_deleted: {
|
|
114454
|
+
properties: {
|
|
114455
|
+
config: {
|
|
114456
|
+
$ref: string;
|
|
114457
|
+
};
|
|
114458
|
+
rule: {
|
|
114459
|
+
enum: string[];
|
|
114460
|
+
type: string;
|
|
114461
|
+
};
|
|
114462
|
+
};
|
|
114463
|
+
required: string[];
|
|
114464
|
+
type: string;
|
|
114465
|
+
};
|
|
114466
|
+
reservation_spaces_updated: {
|
|
114467
|
+
properties: {
|
|
114468
|
+
config: {
|
|
114469
|
+
$ref: string;
|
|
114470
|
+
};
|
|
114471
|
+
rule: {
|
|
114472
|
+
enum: string[];
|
|
114473
|
+
type: string;
|
|
114474
|
+
};
|
|
114475
|
+
};
|
|
114476
|
+
required: string[];
|
|
114477
|
+
type: string;
|
|
114478
|
+
};
|
|
114479
|
+
reservation_time_updated: {
|
|
114480
|
+
properties: {
|
|
114481
|
+
config: {
|
|
114482
|
+
$ref: string;
|
|
114483
|
+
};
|
|
114484
|
+
rule: {
|
|
114485
|
+
enum: string[];
|
|
114486
|
+
type: string;
|
|
114487
|
+
};
|
|
114488
|
+
};
|
|
114489
|
+
required: string[];
|
|
114490
|
+
type: string;
|
|
114491
|
+
};
|
|
114492
|
+
space_name_updated: {
|
|
114493
|
+
properties: {
|
|
114494
|
+
config: {
|
|
114495
|
+
$ref: string;
|
|
114496
|
+
};
|
|
114497
|
+
rule: {
|
|
114498
|
+
enum: string[];
|
|
114499
|
+
type: string;
|
|
114500
|
+
};
|
|
114501
|
+
};
|
|
114502
|
+
required: string[];
|
|
114503
|
+
type: string;
|
|
114504
|
+
};
|
|
114505
|
+
staff_member_created: {
|
|
114506
|
+
properties: {
|
|
114507
|
+
config: {
|
|
114508
|
+
$ref: string;
|
|
114509
|
+
};
|
|
114510
|
+
rule: {
|
|
114511
|
+
enum: string[];
|
|
114512
|
+
type: string;
|
|
114513
|
+
};
|
|
114514
|
+
};
|
|
114515
|
+
required: string[];
|
|
114516
|
+
type: string;
|
|
114517
|
+
};
|
|
114518
|
+
staff_member_name_updated: {
|
|
114519
|
+
properties: {
|
|
114520
|
+
config: {
|
|
114521
|
+
$ref: string;
|
|
114522
|
+
};
|
|
114523
|
+
rule: {
|
|
114524
|
+
enum: string[];
|
|
114525
|
+
type: string;
|
|
114526
|
+
};
|
|
114527
|
+
};
|
|
114528
|
+
required: string[];
|
|
114529
|
+
type: string;
|
|
114530
|
+
};
|
|
114531
|
+
user_identity_name_updated: {
|
|
114532
|
+
properties: {
|
|
114533
|
+
config: {
|
|
114534
|
+
$ref: string;
|
|
114535
|
+
};
|
|
114536
|
+
rule: {
|
|
114537
|
+
enum: string[];
|
|
114538
|
+
type: string;
|
|
114539
|
+
};
|
|
114540
|
+
};
|
|
114541
|
+
required: string[];
|
|
114542
|
+
type: string;
|
|
114543
|
+
};
|
|
114544
|
+
};
|
|
114545
|
+
type: string;
|
|
114546
|
+
};
|
|
114547
|
+
climate_rules: {
|
|
114548
|
+
properties: {
|
|
114549
|
+
rules: {
|
|
114550
|
+
properties: {
|
|
114551
|
+
reservation_created: {
|
|
114552
|
+
properties: {
|
|
114553
|
+
automated_occupied_preset: {
|
|
114554
|
+
properties: {
|
|
114555
|
+
cooling_set_point_celsius: {
|
|
114556
|
+
format: string;
|
|
114557
|
+
type: string;
|
|
114558
|
+
};
|
|
114559
|
+
cooling_set_point_fahrenheit: {
|
|
114560
|
+
format: string;
|
|
114561
|
+
type: string;
|
|
114562
|
+
};
|
|
114563
|
+
fan_mode: {
|
|
114564
|
+
enum: string[];
|
|
114565
|
+
type: string;
|
|
114566
|
+
};
|
|
114567
|
+
heating_set_point_celsius: {
|
|
114568
|
+
format: string;
|
|
114569
|
+
type: string;
|
|
114570
|
+
};
|
|
114571
|
+
heating_set_point_fahrenheit: {
|
|
114572
|
+
format: string;
|
|
114573
|
+
type: string;
|
|
114574
|
+
};
|
|
114575
|
+
is_override_allowed: {
|
|
114576
|
+
type: string;
|
|
114577
|
+
};
|
|
114578
|
+
max_override_period_minutes: {
|
|
114579
|
+
format: string;
|
|
114580
|
+
type: string;
|
|
114581
|
+
};
|
|
114582
|
+
mode: {
|
|
114583
|
+
enum: string[];
|
|
114584
|
+
type: string;
|
|
114585
|
+
};
|
|
114586
|
+
};
|
|
114587
|
+
required: string[];
|
|
114588
|
+
type: string;
|
|
114589
|
+
};
|
|
114590
|
+
automated_unoccupied_preset: {
|
|
114591
|
+
properties: {
|
|
114592
|
+
cooling_set_point_celsius: {
|
|
114593
|
+
format: string;
|
|
114594
|
+
type: string;
|
|
114595
|
+
};
|
|
114596
|
+
cooling_set_point_fahrenheit: {
|
|
114597
|
+
format: string;
|
|
114598
|
+
type: string;
|
|
114599
|
+
};
|
|
114600
|
+
fan_mode: {
|
|
114601
|
+
enum: string[];
|
|
114602
|
+
type: string;
|
|
114603
|
+
};
|
|
114604
|
+
heating_set_point_celsius: {
|
|
114605
|
+
format: string;
|
|
114606
|
+
type: string;
|
|
114607
|
+
};
|
|
114608
|
+
heating_set_point_fahrenheit: {
|
|
114609
|
+
format: string;
|
|
114610
|
+
type: string;
|
|
114611
|
+
};
|
|
114612
|
+
is_override_allowed: {
|
|
114613
|
+
type: string;
|
|
114614
|
+
};
|
|
114615
|
+
max_override_period_minutes: {
|
|
114616
|
+
format: string;
|
|
114617
|
+
type: string;
|
|
114618
|
+
};
|
|
114619
|
+
mode: {
|
|
114620
|
+
enum: string[];
|
|
114621
|
+
type: string;
|
|
114622
|
+
};
|
|
114623
|
+
};
|
|
114624
|
+
required: string[];
|
|
114625
|
+
type: string;
|
|
114626
|
+
};
|
|
114627
|
+
occupied_preset_key: {
|
|
114628
|
+
type: string;
|
|
114629
|
+
};
|
|
114630
|
+
precondition_minutes_before_reservation: {
|
|
114631
|
+
format: string;
|
|
114632
|
+
type: string;
|
|
114633
|
+
};
|
|
114634
|
+
unoccupied_preset_key: {
|
|
114635
|
+
type: string;
|
|
114636
|
+
};
|
|
114637
|
+
};
|
|
114638
|
+
type: string;
|
|
114639
|
+
};
|
|
114640
|
+
reservation_deleted: {
|
|
114641
|
+
$ref: string;
|
|
114642
|
+
};
|
|
114643
|
+
reservation_time_updated: {
|
|
114644
|
+
$ref: string;
|
|
114645
|
+
};
|
|
114646
|
+
};
|
|
114647
|
+
type: string;
|
|
114648
|
+
};
|
|
114649
|
+
};
|
|
114650
|
+
required: string[];
|
|
114651
|
+
type: string;
|
|
114652
|
+
};
|
|
114653
|
+
};
|
|
114654
|
+
type: string;
|
|
114655
|
+
};
|
|
114656
|
+
ok: {
|
|
114657
|
+
type: string;
|
|
114658
|
+
};
|
|
114659
|
+
};
|
|
114660
|
+
required: string[];
|
|
114661
|
+
type: string;
|
|
114662
|
+
};
|
|
114663
|
+
};
|
|
114664
|
+
};
|
|
114297
114665
|
description: string;
|
|
114298
|
-
type: string;
|
|
114299
114666
|
};
|
|
114667
|
+
400: {
|
|
114668
|
+
description: string;
|
|
114669
|
+
};
|
|
114670
|
+
401: {
|
|
114671
|
+
description: string;
|
|
114672
|
+
};
|
|
114673
|
+
};
|
|
114674
|
+
security: {
|
|
114675
|
+
client_session_with_customer: never[];
|
|
114300
114676
|
}[];
|
|
114677
|
+
summary: string;
|
|
114678
|
+
tags: never[];
|
|
114679
|
+
'x-fern-sdk-group-name': string[];
|
|
114680
|
+
'x-fern-sdk-method-name': string;
|
|
114681
|
+
'x-fern-sdk-return-value': string;
|
|
114682
|
+
'x-response-key': string;
|
|
114683
|
+
'x-title': string;
|
|
114684
|
+
};
|
|
114685
|
+
post: {
|
|
114686
|
+
description: string;
|
|
114687
|
+
operationId: string;
|
|
114301
114688
|
responses: {
|
|
114302
114689
|
200: {
|
|
114303
114690
|
content: {
|
|
@@ -114569,330 +114956,9 @@ declare const _default: {
|
|
|
114569
114956
|
description: string;
|
|
114570
114957
|
};
|
|
114571
114958
|
};
|
|
114572
|
-
security:
|
|
114573
|
-
|
|
114574
|
-
|
|
114575
|
-
api_key?: never;
|
|
114576
|
-
} | {
|
|
114577
|
-
console_session_with_workspace: never[];
|
|
114578
|
-
pat_with_workspace?: never;
|
|
114579
|
-
api_key?: never;
|
|
114580
|
-
} | {
|
|
114581
|
-
api_key: never[];
|
|
114582
|
-
pat_with_workspace?: never;
|
|
114583
|
-
console_session_with_workspace?: never;
|
|
114584
|
-
})[];
|
|
114585
|
-
summary: string;
|
|
114586
|
-
tags: never[];
|
|
114587
|
-
'x-fern-sdk-group-name': string[];
|
|
114588
|
-
'x-fern-sdk-method-name': string;
|
|
114589
|
-
'x-fern-sdk-return-value': string;
|
|
114590
|
-
'x-response-key': string;
|
|
114591
|
-
'x-title': string;
|
|
114592
|
-
};
|
|
114593
|
-
post: {
|
|
114594
|
-
description: string;
|
|
114595
|
-
operationId: string;
|
|
114596
|
-
requestBody: {
|
|
114597
|
-
content: {
|
|
114598
|
-
'application/json': {
|
|
114599
|
-
schema: {
|
|
114600
|
-
properties: {
|
|
114601
|
-
customer_key: {
|
|
114602
|
-
description: string;
|
|
114603
|
-
type: string;
|
|
114604
|
-
};
|
|
114605
|
-
};
|
|
114606
|
-
required: string[];
|
|
114607
|
-
type: string;
|
|
114608
|
-
};
|
|
114609
|
-
};
|
|
114610
|
-
};
|
|
114611
|
-
};
|
|
114612
|
-
responses: {
|
|
114613
|
-
200: {
|
|
114614
|
-
content: {
|
|
114615
|
-
'application/json': {
|
|
114616
|
-
schema: {
|
|
114617
|
-
properties: {
|
|
114618
|
-
automation: {
|
|
114619
|
-
properties: {
|
|
114620
|
-
access_rules: {
|
|
114621
|
-
properties: {
|
|
114622
|
-
reservation_created: {
|
|
114623
|
-
properties: {
|
|
114624
|
-
config: {
|
|
114625
|
-
properties: {
|
|
114626
|
-
access_methods: {
|
|
114627
|
-
items: {
|
|
114628
|
-
enum: string[];
|
|
114629
|
-
type: string;
|
|
114630
|
-
};
|
|
114631
|
-
minItems: number;
|
|
114632
|
-
type: string;
|
|
114633
|
-
};
|
|
114634
|
-
card_count_on_reservation_create: {
|
|
114635
|
-
minimum: number;
|
|
114636
|
-
type: string;
|
|
114637
|
-
};
|
|
114638
|
-
code_count_on_reservation_create: {
|
|
114639
|
-
minimum: number;
|
|
114640
|
-
type: string;
|
|
114641
|
-
};
|
|
114642
|
-
instant_key_max_use_count: {
|
|
114643
|
-
minimum: number;
|
|
114644
|
-
type: string;
|
|
114645
|
-
};
|
|
114646
|
-
method_issuance_strategy: {
|
|
114647
|
-
enum: string[];
|
|
114648
|
-
type: string;
|
|
114649
|
-
};
|
|
114650
|
-
};
|
|
114651
|
-
required: string[];
|
|
114652
|
-
type: string;
|
|
114653
|
-
};
|
|
114654
|
-
rule: {
|
|
114655
|
-
enum: string[];
|
|
114656
|
-
type: string;
|
|
114657
|
-
};
|
|
114658
|
-
};
|
|
114659
|
-
required: string[];
|
|
114660
|
-
type: string;
|
|
114661
|
-
};
|
|
114662
|
-
reservation_deleted: {
|
|
114663
|
-
properties: {
|
|
114664
|
-
config: {
|
|
114665
|
-
$ref: string;
|
|
114666
|
-
};
|
|
114667
|
-
rule: {
|
|
114668
|
-
enum: string[];
|
|
114669
|
-
type: string;
|
|
114670
|
-
};
|
|
114671
|
-
};
|
|
114672
|
-
required: string[];
|
|
114673
|
-
type: string;
|
|
114674
|
-
};
|
|
114675
|
-
reservation_spaces_updated: {
|
|
114676
|
-
properties: {
|
|
114677
|
-
config: {
|
|
114678
|
-
$ref: string;
|
|
114679
|
-
};
|
|
114680
|
-
rule: {
|
|
114681
|
-
enum: string[];
|
|
114682
|
-
type: string;
|
|
114683
|
-
};
|
|
114684
|
-
};
|
|
114685
|
-
required: string[];
|
|
114686
|
-
type: string;
|
|
114687
|
-
};
|
|
114688
|
-
reservation_time_updated: {
|
|
114689
|
-
properties: {
|
|
114690
|
-
config: {
|
|
114691
|
-
$ref: string;
|
|
114692
|
-
};
|
|
114693
|
-
rule: {
|
|
114694
|
-
enum: string[];
|
|
114695
|
-
type: string;
|
|
114696
|
-
};
|
|
114697
|
-
};
|
|
114698
|
-
required: string[];
|
|
114699
|
-
type: string;
|
|
114700
|
-
};
|
|
114701
|
-
space_name_updated: {
|
|
114702
|
-
properties: {
|
|
114703
|
-
config: {
|
|
114704
|
-
$ref: string;
|
|
114705
|
-
};
|
|
114706
|
-
rule: {
|
|
114707
|
-
enum: string[];
|
|
114708
|
-
type: string;
|
|
114709
|
-
};
|
|
114710
|
-
};
|
|
114711
|
-
required: string[];
|
|
114712
|
-
type: string;
|
|
114713
|
-
};
|
|
114714
|
-
staff_member_created: {
|
|
114715
|
-
properties: {
|
|
114716
|
-
config: {
|
|
114717
|
-
$ref: string;
|
|
114718
|
-
};
|
|
114719
|
-
rule: {
|
|
114720
|
-
enum: string[];
|
|
114721
|
-
type: string;
|
|
114722
|
-
};
|
|
114723
|
-
};
|
|
114724
|
-
required: string[];
|
|
114725
|
-
type: string;
|
|
114726
|
-
};
|
|
114727
|
-
staff_member_name_updated: {
|
|
114728
|
-
properties: {
|
|
114729
|
-
config: {
|
|
114730
|
-
$ref: string;
|
|
114731
|
-
};
|
|
114732
|
-
rule: {
|
|
114733
|
-
enum: string[];
|
|
114734
|
-
type: string;
|
|
114735
|
-
};
|
|
114736
|
-
};
|
|
114737
|
-
required: string[];
|
|
114738
|
-
type: string;
|
|
114739
|
-
};
|
|
114740
|
-
user_identity_name_updated: {
|
|
114741
|
-
properties: {
|
|
114742
|
-
config: {
|
|
114743
|
-
$ref: string;
|
|
114744
|
-
};
|
|
114745
|
-
rule: {
|
|
114746
|
-
enum: string[];
|
|
114747
|
-
type: string;
|
|
114748
|
-
};
|
|
114749
|
-
};
|
|
114750
|
-
required: string[];
|
|
114751
|
-
type: string;
|
|
114752
|
-
};
|
|
114753
|
-
};
|
|
114754
|
-
type: string;
|
|
114755
|
-
};
|
|
114756
|
-
climate_rules: {
|
|
114757
|
-
properties: {
|
|
114758
|
-
rules: {
|
|
114759
|
-
properties: {
|
|
114760
|
-
reservation_created: {
|
|
114761
|
-
properties: {
|
|
114762
|
-
automated_occupied_preset: {
|
|
114763
|
-
properties: {
|
|
114764
|
-
cooling_set_point_celsius: {
|
|
114765
|
-
format: string;
|
|
114766
|
-
type: string;
|
|
114767
|
-
};
|
|
114768
|
-
cooling_set_point_fahrenheit: {
|
|
114769
|
-
format: string;
|
|
114770
|
-
type: string;
|
|
114771
|
-
};
|
|
114772
|
-
fan_mode: {
|
|
114773
|
-
enum: string[];
|
|
114774
|
-
type: string;
|
|
114775
|
-
};
|
|
114776
|
-
heating_set_point_celsius: {
|
|
114777
|
-
format: string;
|
|
114778
|
-
type: string;
|
|
114779
|
-
};
|
|
114780
|
-
heating_set_point_fahrenheit: {
|
|
114781
|
-
format: string;
|
|
114782
|
-
type: string;
|
|
114783
|
-
};
|
|
114784
|
-
is_override_allowed: {
|
|
114785
|
-
type: string;
|
|
114786
|
-
};
|
|
114787
|
-
max_override_period_minutes: {
|
|
114788
|
-
format: string;
|
|
114789
|
-
type: string;
|
|
114790
|
-
};
|
|
114791
|
-
mode: {
|
|
114792
|
-
enum: string[];
|
|
114793
|
-
type: string;
|
|
114794
|
-
};
|
|
114795
|
-
};
|
|
114796
|
-
required: string[];
|
|
114797
|
-
type: string;
|
|
114798
|
-
};
|
|
114799
|
-
automated_unoccupied_preset: {
|
|
114800
|
-
properties: {
|
|
114801
|
-
cooling_set_point_celsius: {
|
|
114802
|
-
format: string;
|
|
114803
|
-
type: string;
|
|
114804
|
-
};
|
|
114805
|
-
cooling_set_point_fahrenheit: {
|
|
114806
|
-
format: string;
|
|
114807
|
-
type: string;
|
|
114808
|
-
};
|
|
114809
|
-
fan_mode: {
|
|
114810
|
-
enum: string[];
|
|
114811
|
-
type: string;
|
|
114812
|
-
};
|
|
114813
|
-
heating_set_point_celsius: {
|
|
114814
|
-
format: string;
|
|
114815
|
-
type: string;
|
|
114816
|
-
};
|
|
114817
|
-
heating_set_point_fahrenheit: {
|
|
114818
|
-
format: string;
|
|
114819
|
-
type: string;
|
|
114820
|
-
};
|
|
114821
|
-
is_override_allowed: {
|
|
114822
|
-
type: string;
|
|
114823
|
-
};
|
|
114824
|
-
max_override_period_minutes: {
|
|
114825
|
-
format: string;
|
|
114826
|
-
type: string;
|
|
114827
|
-
};
|
|
114828
|
-
mode: {
|
|
114829
|
-
enum: string[];
|
|
114830
|
-
type: string;
|
|
114831
|
-
};
|
|
114832
|
-
};
|
|
114833
|
-
required: string[];
|
|
114834
|
-
type: string;
|
|
114835
|
-
};
|
|
114836
|
-
occupied_preset_key: {
|
|
114837
|
-
type: string;
|
|
114838
|
-
};
|
|
114839
|
-
precondition_minutes_before_reservation: {
|
|
114840
|
-
format: string;
|
|
114841
|
-
type: string;
|
|
114842
|
-
};
|
|
114843
|
-
unoccupied_preset_key: {
|
|
114844
|
-
type: string;
|
|
114845
|
-
};
|
|
114846
|
-
};
|
|
114847
|
-
type: string;
|
|
114848
|
-
};
|
|
114849
|
-
reservation_deleted: {
|
|
114850
|
-
$ref: string;
|
|
114851
|
-
};
|
|
114852
|
-
reservation_time_updated: {
|
|
114853
|
-
$ref: string;
|
|
114854
|
-
};
|
|
114855
|
-
};
|
|
114856
|
-
type: string;
|
|
114857
|
-
};
|
|
114858
|
-
};
|
|
114859
|
-
required: string[];
|
|
114860
|
-
type: string;
|
|
114861
|
-
};
|
|
114862
|
-
};
|
|
114863
|
-
type: string;
|
|
114864
|
-
};
|
|
114865
|
-
ok: {
|
|
114866
|
-
type: string;
|
|
114867
|
-
};
|
|
114868
|
-
};
|
|
114869
|
-
required: string[];
|
|
114870
|
-
type: string;
|
|
114871
|
-
};
|
|
114872
|
-
};
|
|
114873
|
-
};
|
|
114874
|
-
description: string;
|
|
114875
|
-
};
|
|
114876
|
-
400: {
|
|
114877
|
-
description: string;
|
|
114878
|
-
};
|
|
114879
|
-
401: {
|
|
114880
|
-
description: string;
|
|
114881
|
-
};
|
|
114882
|
-
};
|
|
114883
|
-
security: ({
|
|
114884
|
-
pat_with_workspace: never[];
|
|
114885
|
-
console_session_with_workspace?: never;
|
|
114886
|
-
api_key?: never;
|
|
114887
|
-
} | {
|
|
114888
|
-
console_session_with_workspace: never[];
|
|
114889
|
-
pat_with_workspace?: never;
|
|
114890
|
-
api_key?: never;
|
|
114891
|
-
} | {
|
|
114892
|
-
api_key: never[];
|
|
114893
|
-
pat_with_workspace?: never;
|
|
114894
|
-
console_session_with_workspace?: never;
|
|
114895
|
-
})[];
|
|
114959
|
+
security: {
|
|
114960
|
+
client_session_with_customer: never[];
|
|
114961
|
+
}[];
|
|
114896
114962
|
summary: string;
|
|
114897
114963
|
tags: never[];
|
|
114898
114964
|
'x-fern-sdk-group-name': string[];
|
|
@@ -144620,6 +144686,8 @@ type Routes = {
|
|
|
144620
144686
|
can_unlock_with_code?: boolean | undefined;
|
|
144621
144687
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
144622
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;
|
|
144623
144691
|
}[] | undefined;
|
|
144624
144692
|
connected_accounts?: {
|
|
144625
144693
|
/** ID of the connected account. */
|
|
@@ -148831,6 +148899,8 @@ type Routes = {
|
|
|
148831
148899
|
can_unlock_with_code?: boolean | undefined;
|
|
148832
148900
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
148833
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;
|
|
148834
148904
|
}[] | undefined;
|
|
148835
148905
|
access_grants?: {
|
|
148836
148906
|
/** ID of the Seam workspace associated with the Access Grant. */
|
|
@@ -150171,6 +150241,8 @@ type Routes = {
|
|
|
150171
150241
|
can_unlock_with_code?: boolean | undefined;
|
|
150172
150242
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
150173
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;
|
|
150174
150246
|
}[];
|
|
150175
150247
|
};
|
|
150176
150248
|
maxDuration: undefined;
|
|
@@ -151829,6 +151901,8 @@ type Routes = {
|
|
|
151829
151901
|
can_unlock_with_code?: boolean | undefined;
|
|
151830
151902
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
151831
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;
|
|
151832
151906
|
}[];
|
|
151833
151907
|
};
|
|
151834
151908
|
maxDuration: undefined;
|
|
@@ -155333,6 +155407,8 @@ type Routes = {
|
|
|
155333
155407
|
can_unlock_with_code?: boolean | undefined;
|
|
155334
155408
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
155335
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;
|
|
155336
155412
|
};
|
|
155337
155413
|
};
|
|
155338
155414
|
maxDuration: undefined;
|
|
@@ -155512,6 +155588,8 @@ type Routes = {
|
|
|
155512
155588
|
can_unlock_with_code?: boolean | undefined;
|
|
155513
155589
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
155514
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;
|
|
155515
155593
|
}[];
|
|
155516
155594
|
/** Information about the current page of results. */
|
|
155517
155595
|
pagination: {
|
|
@@ -155672,6 +155750,1283 @@ type Routes = {
|
|
|
155672
155750
|
};
|
|
155673
155751
|
maxDuration: undefined;
|
|
155674
155752
|
};
|
|
155753
|
+
'/acs/entrances/unlock': {
|
|
155754
|
+
route: '/acs/entrances/unlock';
|
|
155755
|
+
method: 'POST';
|
|
155756
|
+
queryParams: {};
|
|
155757
|
+
jsonBody: {};
|
|
155758
|
+
commonParams: {
|
|
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;
|
|
155763
|
+
};
|
|
155764
|
+
formData: {};
|
|
155765
|
+
jsonResponse: {
|
|
155766
|
+
/** 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.
|
|
155767
|
+
|
|
155768
|
+
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.
|
|
155769
|
+
|
|
155770
|
+
See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
|
|
155771
|
+
action_attempt: {
|
|
155772
|
+
/** ID of the action attempt. */
|
|
155773
|
+
action_attempt_id: string;
|
|
155774
|
+
status: 'pending';
|
|
155775
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155776
|
+
result: null;
|
|
155777
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155778
|
+
error: null;
|
|
155779
|
+
/** Action attempt to track the status of locking a door. */
|
|
155780
|
+
action_type: 'LOCK_DOOR';
|
|
155781
|
+
} | {
|
|
155782
|
+
/** ID of the action attempt. */
|
|
155783
|
+
action_attempt_id: string;
|
|
155784
|
+
status: 'success';
|
|
155785
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155786
|
+
error: null;
|
|
155787
|
+
/** Action attempt to track the status of locking a door. */
|
|
155788
|
+
action_type: 'LOCK_DOOR';
|
|
155789
|
+
/** Result of the action. */
|
|
155790
|
+
result: {
|
|
155791
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
155792
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
155793
|
+
};
|
|
155794
|
+
} | {
|
|
155795
|
+
/** ID of the action attempt. */
|
|
155796
|
+
action_attempt_id: string;
|
|
155797
|
+
status: 'error';
|
|
155798
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155799
|
+
result: null;
|
|
155800
|
+
/** Action attempt to track the status of locking a door. */
|
|
155801
|
+
action_type: 'LOCK_DOOR';
|
|
155802
|
+
/** Error associated with the action. */
|
|
155803
|
+
error: {
|
|
155804
|
+
/** Type of the error. */
|
|
155805
|
+
type: string;
|
|
155806
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155807
|
+
message: string;
|
|
155808
|
+
};
|
|
155809
|
+
} | {
|
|
155810
|
+
/** ID of the action attempt. */
|
|
155811
|
+
action_attempt_id: string;
|
|
155812
|
+
status: 'pending';
|
|
155813
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155814
|
+
result: null;
|
|
155815
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155816
|
+
error: null;
|
|
155817
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
155818
|
+
action_type: 'UNLOCK_DOOR';
|
|
155819
|
+
} | {
|
|
155820
|
+
/** ID of the action attempt. */
|
|
155821
|
+
action_attempt_id: string;
|
|
155822
|
+
status: 'success';
|
|
155823
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155824
|
+
error: null;
|
|
155825
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
155826
|
+
action_type: 'UNLOCK_DOOR';
|
|
155827
|
+
/** Result of the action. */
|
|
155828
|
+
result: {
|
|
155829
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
155830
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
155831
|
+
};
|
|
155832
|
+
} | {
|
|
155833
|
+
/** ID of the action attempt. */
|
|
155834
|
+
action_attempt_id: string;
|
|
155835
|
+
status: 'error';
|
|
155836
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
155837
|
+
result: null;
|
|
155838
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
155839
|
+
action_type: 'UNLOCK_DOOR';
|
|
155840
|
+
/** Error associated with the action. */
|
|
155841
|
+
error: {
|
|
155842
|
+
/** Type of the error. */
|
|
155843
|
+
type: string;
|
|
155844
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
155845
|
+
message: string;
|
|
155846
|
+
};
|
|
155847
|
+
} | {
|
|
155848
|
+
/** ID of the action attempt. */
|
|
155849
|
+
action_attempt_id: string;
|
|
155850
|
+
status: 'pending';
|
|
155851
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
155852
|
+
result: null;
|
|
155853
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
155854
|
+
error: null;
|
|
155855
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
155856
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
155857
|
+
} | {
|
|
155858
|
+
/** ID of the action attempt. */
|
|
155859
|
+
action_attempt_id: string;
|
|
155860
|
+
status: 'success';
|
|
155861
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
155862
|
+
error: null;
|
|
155863
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
155864
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
155865
|
+
/** 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. */
|
|
155866
|
+
result: {
|
|
155867
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
155868
|
+
acs_credential_on_encoder: {
|
|
155869
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
155870
|
+
created_at: string | null;
|
|
155871
|
+
is_issued: boolean | null;
|
|
155872
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
155873
|
+
starts_at: string | null;
|
|
155874
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
155875
|
+
ends_at: string | null;
|
|
155876
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155877
|
+
card_number: string | null;
|
|
155878
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155879
|
+
visionline_metadata?: {
|
|
155880
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155881
|
+
card_id: string;
|
|
155882
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
155883
|
+
cancelled: boolean;
|
|
155884
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
155885
|
+
discarded: boolean;
|
|
155886
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
155887
|
+
expired: boolean;
|
|
155888
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
155889
|
+
overwritten: boolean;
|
|
155890
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
155891
|
+
overridden?: boolean | undefined;
|
|
155892
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
155893
|
+
pending_auto_update: boolean;
|
|
155894
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155895
|
+
card_format: 'TLCode' | 'rfid48';
|
|
155896
|
+
/** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155897
|
+
card_holder?: string | undefined;
|
|
155898
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155899
|
+
number_of_issued_cards: number;
|
|
155900
|
+
/** 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). */
|
|
155901
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
155902
|
+
/** 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). */
|
|
155903
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
155904
|
+
} | undefined;
|
|
155905
|
+
} | null;
|
|
155906
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
155907
|
+
acs_credential_on_seam: ({
|
|
155908
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155909
|
+
acs_credential_id: string;
|
|
155910
|
+
/** 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. */
|
|
155911
|
+
acs_user_id?: string | undefined;
|
|
155912
|
+
/** 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. */
|
|
155913
|
+
user_identity_id?: string | undefined;
|
|
155914
|
+
/** 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. */
|
|
155915
|
+
connected_account_id: string;
|
|
155916
|
+
acs_credential_pool_id?: string | undefined;
|
|
155917
|
+
/** 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). */
|
|
155918
|
+
acs_system_id: string;
|
|
155919
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155920
|
+
parent_acs_credential_id?: string | undefined;
|
|
155921
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
155922
|
+
display_name: string;
|
|
155923
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155924
|
+
code?: (string | undefined) | null;
|
|
155925
|
+
/** 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. */
|
|
155926
|
+
is_one_time_use?: boolean | undefined;
|
|
155927
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155928
|
+
card_number?: (string | undefined) | null;
|
|
155929
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
155930
|
+
is_issued?: boolean | undefined;
|
|
155931
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
155932
|
+
issued_at?: (string | undefined) | null;
|
|
155933
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
155934
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
155935
|
+
/** 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`. */
|
|
155936
|
+
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;
|
|
155937
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
155938
|
+
external_type_display_name?: string | undefined;
|
|
155939
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
155940
|
+
created_at: string;
|
|
155941
|
+
/** 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). */
|
|
155942
|
+
workspace_id: string;
|
|
155943
|
+
/** 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. */
|
|
155944
|
+
starts_at?: string | undefined;
|
|
155945
|
+
/** 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`. */
|
|
155946
|
+
ends_at?: string | undefined;
|
|
155947
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155948
|
+
errors: {
|
|
155949
|
+
error_code: string;
|
|
155950
|
+
message: string;
|
|
155951
|
+
}[];
|
|
155952
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
155953
|
+
warnings: ({
|
|
155954
|
+
/** Date and time at which Seam created the warning. */
|
|
155955
|
+
created_at: string;
|
|
155956
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155957
|
+
message: string;
|
|
155958
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155959
|
+
warning_code: 'waiting_to_be_issued';
|
|
155960
|
+
} | {
|
|
155961
|
+
/** Date and time at which Seam created the warning. */
|
|
155962
|
+
created_at: string;
|
|
155963
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155964
|
+
message: string;
|
|
155965
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155966
|
+
warning_code: 'schedule_externally_modified';
|
|
155967
|
+
} | {
|
|
155968
|
+
/** Date and time at which Seam created the warning. */
|
|
155969
|
+
created_at: string;
|
|
155970
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155971
|
+
message: string;
|
|
155972
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155973
|
+
warning_code: 'schedule_modified';
|
|
155974
|
+
} | {
|
|
155975
|
+
/** Date and time at which Seam created the warning. */
|
|
155976
|
+
created_at: string;
|
|
155977
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155978
|
+
message: string;
|
|
155979
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155980
|
+
warning_code: 'being_deleted';
|
|
155981
|
+
} | {
|
|
155982
|
+
/** Date and time at which Seam created the warning. */
|
|
155983
|
+
created_at: string;
|
|
155984
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155985
|
+
message: string;
|
|
155986
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155987
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
155988
|
+
} | {
|
|
155989
|
+
/** Date and time at which Seam created the warning. */
|
|
155990
|
+
created_at: string;
|
|
155991
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
155992
|
+
message: string;
|
|
155993
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
155994
|
+
warning_code: 'needs_to_be_reissued';
|
|
155995
|
+
})[];
|
|
155996
|
+
/** 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). */
|
|
155997
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
155998
|
+
/** 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. */
|
|
155999
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
156000
|
+
/** 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. */
|
|
156001
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
156002
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156003
|
+
visionline_metadata?: {
|
|
156004
|
+
/** Card function type in the Visionline access system. */
|
|
156005
|
+
card_function_type: 'guest' | 'staff';
|
|
156006
|
+
/** IDs of the credentials to which you want to join. */
|
|
156007
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
156008
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
156009
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
156010
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
156011
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
156012
|
+
/** Indicates whether the credential is valid. */
|
|
156013
|
+
is_valid?: boolean | undefined;
|
|
156014
|
+
/** 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. */
|
|
156015
|
+
auto_join?: boolean | undefined;
|
|
156016
|
+
/** ID of the card in the Visionline access system. */
|
|
156017
|
+
card_id?: string | undefined;
|
|
156018
|
+
/** ID of the credential in the Visionline access system. */
|
|
156019
|
+
credential_id?: string | undefined;
|
|
156020
|
+
} | undefined;
|
|
156021
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156022
|
+
assa_abloy_vostio_metadata?: {
|
|
156023
|
+
/** 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. */
|
|
156024
|
+
auto_join?: boolean | undefined;
|
|
156025
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
156026
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
156027
|
+
/** Key ID in the Vostio access system. */
|
|
156028
|
+
key_id?: string | undefined;
|
|
156029
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
156030
|
+
key_issuing_request_id?: string | undefined;
|
|
156031
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
156032
|
+
door_names?: string[] | undefined;
|
|
156033
|
+
/** Endpoint ID in the Vostio access system. */
|
|
156034
|
+
endpoint_id?: string | undefined;
|
|
156035
|
+
} | undefined;
|
|
156036
|
+
is_managed: true;
|
|
156037
|
+
} | {
|
|
156038
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156039
|
+
acs_credential_id: string;
|
|
156040
|
+
/** 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. */
|
|
156041
|
+
acs_user_id?: string | undefined;
|
|
156042
|
+
/** 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. */
|
|
156043
|
+
user_identity_id?: string | undefined;
|
|
156044
|
+
/** 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. */
|
|
156045
|
+
connected_account_id: string;
|
|
156046
|
+
acs_credential_pool_id?: string | undefined;
|
|
156047
|
+
/** 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). */
|
|
156048
|
+
acs_system_id: string;
|
|
156049
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156050
|
+
parent_acs_credential_id?: string | undefined;
|
|
156051
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
156052
|
+
display_name: string;
|
|
156053
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156054
|
+
code?: (string | undefined) | null;
|
|
156055
|
+
/** 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. */
|
|
156056
|
+
is_one_time_use?: boolean | undefined;
|
|
156057
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156058
|
+
card_number?: (string | undefined) | null;
|
|
156059
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
156060
|
+
is_issued?: boolean | undefined;
|
|
156061
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
156062
|
+
issued_at?: (string | undefined) | null;
|
|
156063
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
156064
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
156065
|
+
/** 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`. */
|
|
156066
|
+
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;
|
|
156067
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
156068
|
+
external_type_display_name?: string | undefined;
|
|
156069
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
156070
|
+
created_at: string;
|
|
156071
|
+
/** 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). */
|
|
156072
|
+
workspace_id: string;
|
|
156073
|
+
/** 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. */
|
|
156074
|
+
starts_at?: string | undefined;
|
|
156075
|
+
/** 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`. */
|
|
156076
|
+
ends_at?: string | undefined;
|
|
156077
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156078
|
+
errors: {
|
|
156079
|
+
error_code: string;
|
|
156080
|
+
message: string;
|
|
156081
|
+
}[];
|
|
156082
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156083
|
+
warnings: ({
|
|
156084
|
+
/** Date and time at which Seam created the warning. */
|
|
156085
|
+
created_at: string;
|
|
156086
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156087
|
+
message: string;
|
|
156088
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156089
|
+
warning_code: 'waiting_to_be_issued';
|
|
156090
|
+
} | {
|
|
156091
|
+
/** Date and time at which Seam created the warning. */
|
|
156092
|
+
created_at: string;
|
|
156093
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156094
|
+
message: string;
|
|
156095
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156096
|
+
warning_code: 'schedule_externally_modified';
|
|
156097
|
+
} | {
|
|
156098
|
+
/** Date and time at which Seam created the warning. */
|
|
156099
|
+
created_at: string;
|
|
156100
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156101
|
+
message: string;
|
|
156102
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156103
|
+
warning_code: 'schedule_modified';
|
|
156104
|
+
} | {
|
|
156105
|
+
/** Date and time at which Seam created the warning. */
|
|
156106
|
+
created_at: string;
|
|
156107
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156108
|
+
message: string;
|
|
156109
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156110
|
+
warning_code: 'being_deleted';
|
|
156111
|
+
} | {
|
|
156112
|
+
/** Date and time at which Seam created the warning. */
|
|
156113
|
+
created_at: string;
|
|
156114
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156115
|
+
message: string;
|
|
156116
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156117
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
156118
|
+
} | {
|
|
156119
|
+
/** Date and time at which Seam created the warning. */
|
|
156120
|
+
created_at: string;
|
|
156121
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156122
|
+
message: string;
|
|
156123
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156124
|
+
warning_code: 'needs_to_be_reissued';
|
|
156125
|
+
})[];
|
|
156126
|
+
/** 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). */
|
|
156127
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
156128
|
+
/** 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. */
|
|
156129
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
156130
|
+
/** 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. */
|
|
156131
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
156132
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156133
|
+
visionline_metadata?: {
|
|
156134
|
+
/** Card function type in the Visionline access system. */
|
|
156135
|
+
card_function_type: 'guest' | 'staff';
|
|
156136
|
+
/** IDs of the credentials to which you want to join. */
|
|
156137
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
156138
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
156139
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
156140
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
156141
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
156142
|
+
/** Indicates whether the credential is valid. */
|
|
156143
|
+
is_valid?: boolean | undefined;
|
|
156144
|
+
/** 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. */
|
|
156145
|
+
auto_join?: boolean | undefined;
|
|
156146
|
+
/** ID of the card in the Visionline access system. */
|
|
156147
|
+
card_id?: string | undefined;
|
|
156148
|
+
/** ID of the credential in the Visionline access system. */
|
|
156149
|
+
credential_id?: string | undefined;
|
|
156150
|
+
} | undefined;
|
|
156151
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156152
|
+
assa_abloy_vostio_metadata?: {
|
|
156153
|
+
/** 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. */
|
|
156154
|
+
auto_join?: boolean | undefined;
|
|
156155
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
156156
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
156157
|
+
/** Key ID in the Vostio access system. */
|
|
156158
|
+
key_id?: string | undefined;
|
|
156159
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
156160
|
+
key_issuing_request_id?: string | undefined;
|
|
156161
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
156162
|
+
door_names?: string[] | undefined;
|
|
156163
|
+
/** Endpoint ID in the Vostio access system. */
|
|
156164
|
+
endpoint_id?: string | undefined;
|
|
156165
|
+
} | undefined;
|
|
156166
|
+
is_managed: false;
|
|
156167
|
+
}) | null;
|
|
156168
|
+
/** 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. */
|
|
156169
|
+
warnings: {
|
|
156170
|
+
/** Indicates a warning related to scanning a credential. */
|
|
156171
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
156172
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156173
|
+
warning_message: string;
|
|
156174
|
+
}[];
|
|
156175
|
+
};
|
|
156176
|
+
} | {
|
|
156177
|
+
/** ID of the action attempt. */
|
|
156178
|
+
action_attempt_id: string;
|
|
156179
|
+
status: 'error';
|
|
156180
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156181
|
+
result: null;
|
|
156182
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
156183
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
156184
|
+
error: {
|
|
156185
|
+
/** Type of the error associated with the action attempt. */
|
|
156186
|
+
type: 'uncategorized_error';
|
|
156187
|
+
/** Message for the error associated with the action attempt. */
|
|
156188
|
+
message: string;
|
|
156189
|
+
} | {
|
|
156190
|
+
/** Type of the error associated with the action attempt. */
|
|
156191
|
+
type: 'action_attempt_expired';
|
|
156192
|
+
/** Message for the error associated with the action attempt. */
|
|
156193
|
+
message: string;
|
|
156194
|
+
} | {
|
|
156195
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
156196
|
+
type: 'no_credential_on_encoder';
|
|
156197
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156198
|
+
message: string;
|
|
156199
|
+
} | {
|
|
156200
|
+
/** Error type to indicate that the encoder is not online. */
|
|
156201
|
+
type: 'encoder_not_online';
|
|
156202
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156203
|
+
message: string;
|
|
156204
|
+
};
|
|
156205
|
+
} | {
|
|
156206
|
+
/** ID of the action attempt. */
|
|
156207
|
+
action_attempt_id: string;
|
|
156208
|
+
status: 'pending';
|
|
156209
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156210
|
+
result: null;
|
|
156211
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156212
|
+
error: null;
|
|
156213
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
156214
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
156215
|
+
} | {
|
|
156216
|
+
/** ID of the action attempt. */
|
|
156217
|
+
action_attempt_id: string;
|
|
156218
|
+
status: 'success';
|
|
156219
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156220
|
+
error: null;
|
|
156221
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
156222
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
156223
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
156224
|
+
result: {
|
|
156225
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156226
|
+
acs_credential_id: string;
|
|
156227
|
+
/** 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. */
|
|
156228
|
+
acs_user_id?: string | undefined;
|
|
156229
|
+
/** 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. */
|
|
156230
|
+
user_identity_id?: string | undefined;
|
|
156231
|
+
/** 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. */
|
|
156232
|
+
connected_account_id: string;
|
|
156233
|
+
acs_credential_pool_id?: string | undefined;
|
|
156234
|
+
/** 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). */
|
|
156235
|
+
acs_system_id: string;
|
|
156236
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156237
|
+
parent_acs_credential_id?: string | undefined;
|
|
156238
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
156239
|
+
display_name: string;
|
|
156240
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156241
|
+
code?: (string | undefined) | null;
|
|
156242
|
+
/** 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. */
|
|
156243
|
+
is_one_time_use?: boolean | undefined;
|
|
156244
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156245
|
+
card_number?: (string | undefined) | null;
|
|
156246
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
156247
|
+
is_issued?: boolean | undefined;
|
|
156248
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
156249
|
+
issued_at?: (string | undefined) | null;
|
|
156250
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
156251
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
156252
|
+
/** 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`. */
|
|
156253
|
+
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;
|
|
156254
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
156255
|
+
external_type_display_name?: string | undefined;
|
|
156256
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
156257
|
+
created_at: string;
|
|
156258
|
+
/** 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). */
|
|
156259
|
+
workspace_id: string;
|
|
156260
|
+
/** 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. */
|
|
156261
|
+
starts_at?: string | undefined;
|
|
156262
|
+
/** 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`. */
|
|
156263
|
+
ends_at?: string | undefined;
|
|
156264
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156265
|
+
errors: {
|
|
156266
|
+
error_code: string;
|
|
156267
|
+
message: string;
|
|
156268
|
+
}[];
|
|
156269
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156270
|
+
warnings: ({
|
|
156271
|
+
/** Date and time at which Seam created the warning. */
|
|
156272
|
+
created_at: string;
|
|
156273
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156274
|
+
message: string;
|
|
156275
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156276
|
+
warning_code: 'waiting_to_be_issued';
|
|
156277
|
+
} | {
|
|
156278
|
+
/** Date and time at which Seam created the warning. */
|
|
156279
|
+
created_at: string;
|
|
156280
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156281
|
+
message: string;
|
|
156282
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156283
|
+
warning_code: 'schedule_externally_modified';
|
|
156284
|
+
} | {
|
|
156285
|
+
/** Date and time at which Seam created the warning. */
|
|
156286
|
+
created_at: string;
|
|
156287
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156288
|
+
message: string;
|
|
156289
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156290
|
+
warning_code: 'schedule_modified';
|
|
156291
|
+
} | {
|
|
156292
|
+
/** Date and time at which Seam created the warning. */
|
|
156293
|
+
created_at: string;
|
|
156294
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156295
|
+
message: string;
|
|
156296
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156297
|
+
warning_code: 'being_deleted';
|
|
156298
|
+
} | {
|
|
156299
|
+
/** Date and time at which Seam created the warning. */
|
|
156300
|
+
created_at: string;
|
|
156301
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156302
|
+
message: string;
|
|
156303
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156304
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
156305
|
+
} | {
|
|
156306
|
+
/** Date and time at which Seam created the warning. */
|
|
156307
|
+
created_at: string;
|
|
156308
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156309
|
+
message: string;
|
|
156310
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156311
|
+
warning_code: 'needs_to_be_reissued';
|
|
156312
|
+
})[];
|
|
156313
|
+
/** 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). */
|
|
156314
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
156315
|
+
/** 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. */
|
|
156316
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
156317
|
+
/** 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. */
|
|
156318
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
156319
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156320
|
+
visionline_metadata?: {
|
|
156321
|
+
/** Card function type in the Visionline access system. */
|
|
156322
|
+
card_function_type: 'guest' | 'staff';
|
|
156323
|
+
/** IDs of the credentials to which you want to join. */
|
|
156324
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
156325
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
156326
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
156327
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
156328
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
156329
|
+
/** Indicates whether the credential is valid. */
|
|
156330
|
+
is_valid?: boolean | undefined;
|
|
156331
|
+
/** 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. */
|
|
156332
|
+
auto_join?: boolean | undefined;
|
|
156333
|
+
/** ID of the card in the Visionline access system. */
|
|
156334
|
+
card_id?: string | undefined;
|
|
156335
|
+
/** ID of the credential in the Visionline access system. */
|
|
156336
|
+
credential_id?: string | undefined;
|
|
156337
|
+
} | undefined;
|
|
156338
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156339
|
+
assa_abloy_vostio_metadata?: {
|
|
156340
|
+
/** 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. */
|
|
156341
|
+
auto_join?: boolean | undefined;
|
|
156342
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
156343
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
156344
|
+
/** Key ID in the Vostio access system. */
|
|
156345
|
+
key_id?: string | undefined;
|
|
156346
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
156347
|
+
key_issuing_request_id?: string | undefined;
|
|
156348
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
156349
|
+
door_names?: string[] | undefined;
|
|
156350
|
+
/** Endpoint ID in the Vostio access system. */
|
|
156351
|
+
endpoint_id?: string | undefined;
|
|
156352
|
+
} | undefined;
|
|
156353
|
+
is_managed: true;
|
|
156354
|
+
} | {
|
|
156355
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156356
|
+
acs_credential_id: string;
|
|
156357
|
+
/** 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. */
|
|
156358
|
+
acs_user_id?: string | undefined;
|
|
156359
|
+
/** 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. */
|
|
156360
|
+
user_identity_id?: string | undefined;
|
|
156361
|
+
/** 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. */
|
|
156362
|
+
connected_account_id: string;
|
|
156363
|
+
acs_credential_pool_id?: string | undefined;
|
|
156364
|
+
/** 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). */
|
|
156365
|
+
acs_system_id: string;
|
|
156366
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156367
|
+
parent_acs_credential_id?: string | undefined;
|
|
156368
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
156369
|
+
display_name: string;
|
|
156370
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156371
|
+
code?: (string | undefined) | null;
|
|
156372
|
+
/** 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. */
|
|
156373
|
+
is_one_time_use?: boolean | undefined;
|
|
156374
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156375
|
+
card_number?: (string | undefined) | null;
|
|
156376
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
156377
|
+
is_issued?: boolean | undefined;
|
|
156378
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
156379
|
+
issued_at?: (string | undefined) | null;
|
|
156380
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
156381
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
156382
|
+
/** 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`. */
|
|
156383
|
+
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;
|
|
156384
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
156385
|
+
external_type_display_name?: string | undefined;
|
|
156386
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
156387
|
+
created_at: string;
|
|
156388
|
+
/** 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). */
|
|
156389
|
+
workspace_id: string;
|
|
156390
|
+
/** 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. */
|
|
156391
|
+
starts_at?: string | undefined;
|
|
156392
|
+
/** 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`. */
|
|
156393
|
+
ends_at?: string | undefined;
|
|
156394
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156395
|
+
errors: {
|
|
156396
|
+
error_code: string;
|
|
156397
|
+
message: string;
|
|
156398
|
+
}[];
|
|
156399
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156400
|
+
warnings: ({
|
|
156401
|
+
/** Date and time at which Seam created the warning. */
|
|
156402
|
+
created_at: string;
|
|
156403
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156404
|
+
message: string;
|
|
156405
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156406
|
+
warning_code: 'waiting_to_be_issued';
|
|
156407
|
+
} | {
|
|
156408
|
+
/** Date and time at which Seam created the warning. */
|
|
156409
|
+
created_at: string;
|
|
156410
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156411
|
+
message: string;
|
|
156412
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156413
|
+
warning_code: 'schedule_externally_modified';
|
|
156414
|
+
} | {
|
|
156415
|
+
/** Date and time at which Seam created the warning. */
|
|
156416
|
+
created_at: string;
|
|
156417
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156418
|
+
message: string;
|
|
156419
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156420
|
+
warning_code: 'schedule_modified';
|
|
156421
|
+
} | {
|
|
156422
|
+
/** Date and time at which Seam created the warning. */
|
|
156423
|
+
created_at: string;
|
|
156424
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156425
|
+
message: string;
|
|
156426
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156427
|
+
warning_code: 'being_deleted';
|
|
156428
|
+
} | {
|
|
156429
|
+
/** Date and time at which Seam created the warning. */
|
|
156430
|
+
created_at: string;
|
|
156431
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156432
|
+
message: string;
|
|
156433
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156434
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
156435
|
+
} | {
|
|
156436
|
+
/** Date and time at which Seam created the warning. */
|
|
156437
|
+
created_at: string;
|
|
156438
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
156439
|
+
message: string;
|
|
156440
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
156441
|
+
warning_code: 'needs_to_be_reissued';
|
|
156442
|
+
})[];
|
|
156443
|
+
/** 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). */
|
|
156444
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
156445
|
+
/** 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. */
|
|
156446
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
156447
|
+
/** 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. */
|
|
156448
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
156449
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156450
|
+
visionline_metadata?: {
|
|
156451
|
+
/** Card function type in the Visionline access system. */
|
|
156452
|
+
card_function_type: 'guest' | 'staff';
|
|
156453
|
+
/** IDs of the credentials to which you want to join. */
|
|
156454
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
156455
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
156456
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
156457
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
156458
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
156459
|
+
/** Indicates whether the credential is valid. */
|
|
156460
|
+
is_valid?: boolean | undefined;
|
|
156461
|
+
/** 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. */
|
|
156462
|
+
auto_join?: boolean | undefined;
|
|
156463
|
+
/** ID of the card in the Visionline access system. */
|
|
156464
|
+
card_id?: string | undefined;
|
|
156465
|
+
/** ID of the credential in the Visionline access system. */
|
|
156466
|
+
credential_id?: string | undefined;
|
|
156467
|
+
} | undefined;
|
|
156468
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
156469
|
+
assa_abloy_vostio_metadata?: {
|
|
156470
|
+
/** 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. */
|
|
156471
|
+
auto_join?: boolean | undefined;
|
|
156472
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
156473
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
156474
|
+
/** Key ID in the Vostio access system. */
|
|
156475
|
+
key_id?: string | undefined;
|
|
156476
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
156477
|
+
key_issuing_request_id?: string | undefined;
|
|
156478
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
156479
|
+
door_names?: string[] | undefined;
|
|
156480
|
+
/** Endpoint ID in the Vostio access system. */
|
|
156481
|
+
endpoint_id?: string | undefined;
|
|
156482
|
+
} | undefined;
|
|
156483
|
+
is_managed: false;
|
|
156484
|
+
};
|
|
156485
|
+
} | {
|
|
156486
|
+
/** ID of the action attempt. */
|
|
156487
|
+
action_attempt_id: string;
|
|
156488
|
+
status: 'error';
|
|
156489
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156490
|
+
result: null;
|
|
156491
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
156492
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
156493
|
+
error: {
|
|
156494
|
+
/** Type of the error associated with the action attempt. */
|
|
156495
|
+
type: 'uncategorized_error';
|
|
156496
|
+
/** Message for the error associated with the action attempt. */
|
|
156497
|
+
message: string;
|
|
156498
|
+
} | {
|
|
156499
|
+
/** Type of the error associated with the action attempt. */
|
|
156500
|
+
type: 'action_attempt_expired';
|
|
156501
|
+
/** Message for the error associated with the action attempt. */
|
|
156502
|
+
message: string;
|
|
156503
|
+
} | {
|
|
156504
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
156505
|
+
type: 'no_credential_on_encoder';
|
|
156506
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156507
|
+
message: string;
|
|
156508
|
+
} | {
|
|
156509
|
+
/** Error type to indicate an incompatible card format. */
|
|
156510
|
+
type: 'incompatible_card_format';
|
|
156511
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156512
|
+
message: string;
|
|
156513
|
+
} | {
|
|
156514
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
156515
|
+
type: 'credential_cannot_be_reissued';
|
|
156516
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156517
|
+
message: string;
|
|
156518
|
+
} | {
|
|
156519
|
+
/** Error type to indicate that the encoder is not online. */
|
|
156520
|
+
type: 'encoder_not_online';
|
|
156521
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156522
|
+
message: string;
|
|
156523
|
+
};
|
|
156524
|
+
} | {
|
|
156525
|
+
/** ID of the action attempt. */
|
|
156526
|
+
action_attempt_id: string;
|
|
156527
|
+
status: 'pending';
|
|
156528
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156529
|
+
result: null;
|
|
156530
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156531
|
+
error: null;
|
|
156532
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
156533
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
156534
|
+
} | {
|
|
156535
|
+
/** ID of the action attempt. */
|
|
156536
|
+
action_attempt_id: string;
|
|
156537
|
+
status: 'success';
|
|
156538
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156539
|
+
error: null;
|
|
156540
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
156541
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
156542
|
+
/** Result of the action. */
|
|
156543
|
+
result: {};
|
|
156544
|
+
} | {
|
|
156545
|
+
/** ID of the action attempt. */
|
|
156546
|
+
action_attempt_id: string;
|
|
156547
|
+
status: 'error';
|
|
156548
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156549
|
+
result: null;
|
|
156550
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
156551
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
156552
|
+
/** Error associated with the action. */
|
|
156553
|
+
error: {
|
|
156554
|
+
/** Type of the error. */
|
|
156555
|
+
type: string;
|
|
156556
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156557
|
+
message: string;
|
|
156558
|
+
};
|
|
156559
|
+
} | {
|
|
156560
|
+
/** ID of the action attempt. */
|
|
156561
|
+
action_attempt_id: string;
|
|
156562
|
+
status: 'pending';
|
|
156563
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156564
|
+
result: null;
|
|
156565
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156566
|
+
error: null;
|
|
156567
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
156568
|
+
action_type: 'SET_FAN_MODE';
|
|
156569
|
+
} | {
|
|
156570
|
+
/** ID of the action attempt. */
|
|
156571
|
+
action_attempt_id: string;
|
|
156572
|
+
status: 'success';
|
|
156573
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156574
|
+
error: null;
|
|
156575
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
156576
|
+
action_type: 'SET_FAN_MODE';
|
|
156577
|
+
/** Result of the action. */
|
|
156578
|
+
result: {};
|
|
156579
|
+
} | {
|
|
156580
|
+
/** ID of the action attempt. */
|
|
156581
|
+
action_attempt_id: string;
|
|
156582
|
+
status: 'error';
|
|
156583
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156584
|
+
result: null;
|
|
156585
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
156586
|
+
action_type: 'SET_FAN_MODE';
|
|
156587
|
+
/** Error associated with the action. */
|
|
156588
|
+
error: {
|
|
156589
|
+
/** Type of the error. */
|
|
156590
|
+
type: string;
|
|
156591
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156592
|
+
message: string;
|
|
156593
|
+
};
|
|
156594
|
+
} | {
|
|
156595
|
+
/** ID of the action attempt. */
|
|
156596
|
+
action_attempt_id: string;
|
|
156597
|
+
status: 'pending';
|
|
156598
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156599
|
+
result: null;
|
|
156600
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156601
|
+
error: null;
|
|
156602
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
156603
|
+
action_type: 'SET_HVAC_MODE';
|
|
156604
|
+
} | {
|
|
156605
|
+
/** ID of the action attempt. */
|
|
156606
|
+
action_attempt_id: string;
|
|
156607
|
+
status: 'success';
|
|
156608
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156609
|
+
error: null;
|
|
156610
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
156611
|
+
action_type: 'SET_HVAC_MODE';
|
|
156612
|
+
/** Result of the action. */
|
|
156613
|
+
result: {};
|
|
156614
|
+
} | {
|
|
156615
|
+
/** ID of the action attempt. */
|
|
156616
|
+
action_attempt_id: string;
|
|
156617
|
+
status: 'error';
|
|
156618
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156619
|
+
result: null;
|
|
156620
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
156621
|
+
action_type: 'SET_HVAC_MODE';
|
|
156622
|
+
/** Error associated with the action. */
|
|
156623
|
+
error: {
|
|
156624
|
+
/** Type of the error. */
|
|
156625
|
+
type: string;
|
|
156626
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156627
|
+
message: string;
|
|
156628
|
+
};
|
|
156629
|
+
} | {
|
|
156630
|
+
/** ID of the action attempt. */
|
|
156631
|
+
action_attempt_id: string;
|
|
156632
|
+
status: 'pending';
|
|
156633
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156634
|
+
result: null;
|
|
156635
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156636
|
+
error: null;
|
|
156637
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
156638
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
156639
|
+
} | {
|
|
156640
|
+
/** ID of the action attempt. */
|
|
156641
|
+
action_attempt_id: string;
|
|
156642
|
+
status: 'success';
|
|
156643
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156644
|
+
error: null;
|
|
156645
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
156646
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
156647
|
+
/** Result of the action. */
|
|
156648
|
+
result: {};
|
|
156649
|
+
} | {
|
|
156650
|
+
/** ID of the action attempt. */
|
|
156651
|
+
action_attempt_id: string;
|
|
156652
|
+
status: 'error';
|
|
156653
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156654
|
+
result: null;
|
|
156655
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
156656
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
156657
|
+
/** Error associated with the action. */
|
|
156658
|
+
error: {
|
|
156659
|
+
/** Type of the error. */
|
|
156660
|
+
type: string;
|
|
156661
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156662
|
+
message: string;
|
|
156663
|
+
};
|
|
156664
|
+
} | {
|
|
156665
|
+
/** ID of the action attempt. */
|
|
156666
|
+
action_attempt_id: string;
|
|
156667
|
+
status: 'pending';
|
|
156668
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156669
|
+
result: null;
|
|
156670
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156671
|
+
error: null;
|
|
156672
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
156673
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
156674
|
+
} | {
|
|
156675
|
+
/** ID of the action attempt. */
|
|
156676
|
+
action_attempt_id: string;
|
|
156677
|
+
status: 'success';
|
|
156678
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156679
|
+
error: null;
|
|
156680
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
156681
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
156682
|
+
/** Result of the action. */
|
|
156683
|
+
result: {};
|
|
156684
|
+
} | {
|
|
156685
|
+
/** ID of the action attempt. */
|
|
156686
|
+
action_attempt_id: string;
|
|
156687
|
+
status: 'error';
|
|
156688
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156689
|
+
result: null;
|
|
156690
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
156691
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
156692
|
+
/** Error associated with the action. */
|
|
156693
|
+
error: {
|
|
156694
|
+
/** Type of the error. */
|
|
156695
|
+
type: string;
|
|
156696
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156697
|
+
message: string;
|
|
156698
|
+
};
|
|
156699
|
+
} | {
|
|
156700
|
+
/** ID of the action attempt. */
|
|
156701
|
+
action_attempt_id: string;
|
|
156702
|
+
status: 'pending';
|
|
156703
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156704
|
+
result: null;
|
|
156705
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156706
|
+
error: null;
|
|
156707
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
156708
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
156709
|
+
} | {
|
|
156710
|
+
/** ID of the action attempt. */
|
|
156711
|
+
action_attempt_id: string;
|
|
156712
|
+
status: 'success';
|
|
156713
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156714
|
+
error: null;
|
|
156715
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
156716
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
156717
|
+
/** Result of the action. */
|
|
156718
|
+
result: {};
|
|
156719
|
+
} | {
|
|
156720
|
+
/** ID of the action attempt. */
|
|
156721
|
+
action_attempt_id: string;
|
|
156722
|
+
status: 'error';
|
|
156723
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156724
|
+
result: null;
|
|
156725
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
156726
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
156727
|
+
/** Error associated with the action. */
|
|
156728
|
+
error: {
|
|
156729
|
+
/** Type of the error. */
|
|
156730
|
+
type: string;
|
|
156731
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156732
|
+
message: string;
|
|
156733
|
+
};
|
|
156734
|
+
} | {
|
|
156735
|
+
/** ID of the action attempt. */
|
|
156736
|
+
action_attempt_id: string;
|
|
156737
|
+
status: 'pending';
|
|
156738
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156739
|
+
result: null;
|
|
156740
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156741
|
+
error: null;
|
|
156742
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
156743
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
156744
|
+
} | {
|
|
156745
|
+
/** ID of the action attempt. */
|
|
156746
|
+
action_attempt_id: string;
|
|
156747
|
+
status: 'success';
|
|
156748
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156749
|
+
error: null;
|
|
156750
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
156751
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
156752
|
+
/** Result of the action. */
|
|
156753
|
+
result: {};
|
|
156754
|
+
} | {
|
|
156755
|
+
/** ID of the action attempt. */
|
|
156756
|
+
action_attempt_id: string;
|
|
156757
|
+
status: 'error';
|
|
156758
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156759
|
+
result: null;
|
|
156760
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
156761
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
156762
|
+
/** Error associated with the action. */
|
|
156763
|
+
error: {
|
|
156764
|
+
/** Type of the error. */
|
|
156765
|
+
type: string;
|
|
156766
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156767
|
+
message: string;
|
|
156768
|
+
};
|
|
156769
|
+
} | {
|
|
156770
|
+
/** ID of the action attempt. */
|
|
156771
|
+
action_attempt_id: string;
|
|
156772
|
+
status: 'pending';
|
|
156773
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156774
|
+
result: null;
|
|
156775
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156776
|
+
error: null;
|
|
156777
|
+
/** Syncing access codes is pending. */
|
|
156778
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
156779
|
+
} | {
|
|
156780
|
+
/** ID of the action attempt. */
|
|
156781
|
+
action_attempt_id: string;
|
|
156782
|
+
status: 'success';
|
|
156783
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156784
|
+
error: null;
|
|
156785
|
+
/** Syncing access codes succeeded. */
|
|
156786
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
156787
|
+
/** Result of the action. */
|
|
156788
|
+
result: {};
|
|
156789
|
+
} | {
|
|
156790
|
+
/** ID of the action attempt. */
|
|
156791
|
+
action_attempt_id: string;
|
|
156792
|
+
status: 'error';
|
|
156793
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156794
|
+
result: null;
|
|
156795
|
+
/** Syncing access codes failed. */
|
|
156796
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
156797
|
+
/** Error associated with the action. */
|
|
156798
|
+
error: {
|
|
156799
|
+
/** Type of the error. */
|
|
156800
|
+
type: string;
|
|
156801
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156802
|
+
message: string;
|
|
156803
|
+
};
|
|
156804
|
+
} | {
|
|
156805
|
+
/** ID of the action attempt. */
|
|
156806
|
+
action_attempt_id: string;
|
|
156807
|
+
status: 'pending';
|
|
156808
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156809
|
+
result: null;
|
|
156810
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156811
|
+
error: null;
|
|
156812
|
+
/** Creating an access code is pending. */
|
|
156813
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
156814
|
+
} | {
|
|
156815
|
+
/** ID of the action attempt. */
|
|
156816
|
+
action_attempt_id: string;
|
|
156817
|
+
status: 'success';
|
|
156818
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156819
|
+
error: null;
|
|
156820
|
+
/** Creating an access code succeeded. */
|
|
156821
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
156822
|
+
/** Result of the action. */
|
|
156823
|
+
result: {
|
|
156824
|
+
/** Created access code. */
|
|
156825
|
+
access_code?: any;
|
|
156826
|
+
};
|
|
156827
|
+
} | {
|
|
156828
|
+
/** ID of the action attempt. */
|
|
156829
|
+
action_attempt_id: string;
|
|
156830
|
+
status: 'error';
|
|
156831
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156832
|
+
result: null;
|
|
156833
|
+
/** Creating an access code failed. */
|
|
156834
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
156835
|
+
/** Error associated with the action. */
|
|
156836
|
+
error: {
|
|
156837
|
+
/** Type of the error. */
|
|
156838
|
+
type: string;
|
|
156839
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156840
|
+
message: string;
|
|
156841
|
+
};
|
|
156842
|
+
} | {
|
|
156843
|
+
/** ID of the action attempt. */
|
|
156844
|
+
action_attempt_id: string;
|
|
156845
|
+
status: 'pending';
|
|
156846
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156847
|
+
result: null;
|
|
156848
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156849
|
+
error: null;
|
|
156850
|
+
/** Deleting an access code is pending. */
|
|
156851
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
156852
|
+
} | {
|
|
156853
|
+
/** ID of the action attempt. */
|
|
156854
|
+
action_attempt_id: string;
|
|
156855
|
+
status: 'success';
|
|
156856
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156857
|
+
error: null;
|
|
156858
|
+
/** Deleting an access code succeeded. */
|
|
156859
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
156860
|
+
/** Result of the action. */
|
|
156861
|
+
result: {};
|
|
156862
|
+
} | {
|
|
156863
|
+
/** ID of the action attempt. */
|
|
156864
|
+
action_attempt_id: string;
|
|
156865
|
+
status: 'error';
|
|
156866
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156867
|
+
result: null;
|
|
156868
|
+
/** Deleting an access code failed. */
|
|
156869
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
156870
|
+
/** Error associated with the action. */
|
|
156871
|
+
error: {
|
|
156872
|
+
/** Type of the error. */
|
|
156873
|
+
type: string;
|
|
156874
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156875
|
+
message: string;
|
|
156876
|
+
};
|
|
156877
|
+
} | {
|
|
156878
|
+
/** ID of the action attempt. */
|
|
156879
|
+
action_attempt_id: string;
|
|
156880
|
+
status: 'pending';
|
|
156881
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156882
|
+
result: null;
|
|
156883
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156884
|
+
error: null;
|
|
156885
|
+
/** Updating an access code is pending. */
|
|
156886
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
156887
|
+
} | {
|
|
156888
|
+
/** ID of the action attempt. */
|
|
156889
|
+
action_attempt_id: string;
|
|
156890
|
+
status: 'success';
|
|
156891
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156892
|
+
error: null;
|
|
156893
|
+
/** Updating an access code succeeded. */
|
|
156894
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
156895
|
+
/** Result of the action. */
|
|
156896
|
+
result: {
|
|
156897
|
+
/** Updated access code. */
|
|
156898
|
+
access_code?: any;
|
|
156899
|
+
};
|
|
156900
|
+
} | {
|
|
156901
|
+
/** ID of the action attempt. */
|
|
156902
|
+
action_attempt_id: string;
|
|
156903
|
+
status: 'error';
|
|
156904
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156905
|
+
result: null;
|
|
156906
|
+
/** Updating an access code failed. */
|
|
156907
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
156908
|
+
/** Error associated with the action. */
|
|
156909
|
+
error: {
|
|
156910
|
+
/** Type of the error. */
|
|
156911
|
+
type: string;
|
|
156912
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156913
|
+
message: string;
|
|
156914
|
+
};
|
|
156915
|
+
} | {
|
|
156916
|
+
/** ID of the action attempt. */
|
|
156917
|
+
action_attempt_id: string;
|
|
156918
|
+
status: 'pending';
|
|
156919
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156920
|
+
result: null;
|
|
156921
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156922
|
+
error: null;
|
|
156923
|
+
/** Creating a noise threshold is pending. */
|
|
156924
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
156925
|
+
} | {
|
|
156926
|
+
/** ID of the action attempt. */
|
|
156927
|
+
action_attempt_id: string;
|
|
156928
|
+
status: 'success';
|
|
156929
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156930
|
+
error: null;
|
|
156931
|
+
/** Creating a noise threshold succeeded. */
|
|
156932
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
156933
|
+
/** Result of the action. */
|
|
156934
|
+
result: {
|
|
156935
|
+
/** Created noise threshold. */
|
|
156936
|
+
noise_threshold?: any;
|
|
156937
|
+
};
|
|
156938
|
+
} | {
|
|
156939
|
+
/** ID of the action attempt. */
|
|
156940
|
+
action_attempt_id: string;
|
|
156941
|
+
status: 'error';
|
|
156942
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156943
|
+
result: null;
|
|
156944
|
+
/** Creating a noise threshold failed. */
|
|
156945
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
156946
|
+
/** Error associated with the action. */
|
|
156947
|
+
error: {
|
|
156948
|
+
/** Type of the error. */
|
|
156949
|
+
type: string;
|
|
156950
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156951
|
+
message: string;
|
|
156952
|
+
};
|
|
156953
|
+
} | {
|
|
156954
|
+
/** ID of the action attempt. */
|
|
156955
|
+
action_attempt_id: string;
|
|
156956
|
+
status: 'pending';
|
|
156957
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156958
|
+
result: null;
|
|
156959
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156960
|
+
error: null;
|
|
156961
|
+
/** Deleting a noise threshold is pending. */
|
|
156962
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
156963
|
+
} | {
|
|
156964
|
+
/** ID of the action attempt. */
|
|
156965
|
+
action_attempt_id: string;
|
|
156966
|
+
status: 'success';
|
|
156967
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
156968
|
+
error: null;
|
|
156969
|
+
/** Deleting a noise threshold succeeded. */
|
|
156970
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
156971
|
+
/** Result of the action. */
|
|
156972
|
+
result: {};
|
|
156973
|
+
} | {
|
|
156974
|
+
/** ID of the action attempt. */
|
|
156975
|
+
action_attempt_id: string;
|
|
156976
|
+
status: 'error';
|
|
156977
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
156978
|
+
result: null;
|
|
156979
|
+
/** Deleting a noise threshold failed. */
|
|
156980
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
156981
|
+
/** Error associated with the action. */
|
|
156982
|
+
error: {
|
|
156983
|
+
/** Type of the error. */
|
|
156984
|
+
type: string;
|
|
156985
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
156986
|
+
message: string;
|
|
156987
|
+
};
|
|
156988
|
+
} | {
|
|
156989
|
+
/** ID of the action attempt. */
|
|
156990
|
+
action_attempt_id: string;
|
|
156991
|
+
status: 'pending';
|
|
156992
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
156993
|
+
result: null;
|
|
156994
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
156995
|
+
error: null;
|
|
156996
|
+
/** Updating a noise threshold is pending. */
|
|
156997
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
156998
|
+
} | {
|
|
156999
|
+
/** ID of the action attempt. */
|
|
157000
|
+
action_attempt_id: string;
|
|
157001
|
+
status: 'success';
|
|
157002
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
157003
|
+
error: null;
|
|
157004
|
+
/** Updating a noise threshold succeeded. */
|
|
157005
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
157006
|
+
/** Result of the action. */
|
|
157007
|
+
result: {
|
|
157008
|
+
/** Updated noise threshold. */
|
|
157009
|
+
noise_threshold?: any;
|
|
157010
|
+
};
|
|
157011
|
+
} | {
|
|
157012
|
+
/** ID of the action attempt. */
|
|
157013
|
+
action_attempt_id: string;
|
|
157014
|
+
status: 'error';
|
|
157015
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
157016
|
+
result: null;
|
|
157017
|
+
/** Updating a noise threshold failed. */
|
|
157018
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
157019
|
+
/** Error associated with the action. */
|
|
157020
|
+
error: {
|
|
157021
|
+
/** Type of the error. */
|
|
157022
|
+
type: string;
|
|
157023
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
157024
|
+
message: string;
|
|
157025
|
+
};
|
|
157026
|
+
};
|
|
157027
|
+
};
|
|
157028
|
+
maxDuration: undefined;
|
|
157029
|
+
};
|
|
155675
157030
|
'/acs/systems/get': {
|
|
155676
157031
|
route: '/acs/systems/get';
|
|
155677
157032
|
method: 'GET' | 'POST';
|
|
@@ -157092,6 +158447,8 @@ type Routes = {
|
|
|
157092
158447
|
can_unlock_with_code?: boolean | undefined;
|
|
157093
158448
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
157094
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;
|
|
157095
158452
|
}[];
|
|
157096
158453
|
};
|
|
157097
158454
|
maxDuration: undefined;
|
|
@@ -191034,7 +192391,10 @@ type Routes = {
|
|
|
191034
192391
|
method: 'GET' | 'POST';
|
|
191035
192392
|
queryParams: {};
|
|
191036
192393
|
jsonBody: {};
|
|
191037
|
-
commonParams: {
|
|
192394
|
+
commonParams: {
|
|
192395
|
+
/** Key of the customer to get automation config for. */
|
|
192396
|
+
customer_key?: string | undefined;
|
|
192397
|
+
};
|
|
191038
192398
|
formData: {};
|
|
191039
192399
|
jsonResponse: {
|
|
191040
192400
|
access_rules?: {
|
|
@@ -191116,6 +192476,8 @@ type Routes = {
|
|
|
191116
192476
|
method: 'PATCH' | 'POST';
|
|
191117
192477
|
queryParams: {};
|
|
191118
192478
|
jsonBody: {
|
|
192479
|
+
/** Key of the customer to update automation config for. */
|
|
192480
|
+
customer_key?: string | undefined;
|
|
191119
192481
|
/** Access automation rules configuration. */
|
|
191120
192482
|
access_rules?: {
|
|
191121
192483
|
reservation_created?: {
|
|
@@ -191408,10 +192770,7 @@ type Routes = {
|
|
|
191408
192770
|
method: 'GET' | 'POST';
|
|
191409
192771
|
queryParams: {};
|
|
191410
192772
|
jsonBody: {};
|
|
191411
|
-
commonParams: {
|
|
191412
|
-
/** Key of the customer. */
|
|
191413
|
-
customer_key: string;
|
|
191414
|
-
};
|
|
192773
|
+
commonParams: {};
|
|
191415
192774
|
formData: {};
|
|
191416
192775
|
jsonResponse: {
|
|
191417
192776
|
automation: {
|
|
@@ -195756,6 +197115,8 @@ type Routes = {
|
|
|
195756
197115
|
can_unlock_with_code?: boolean | undefined;
|
|
195757
197116
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
195758
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;
|
|
195759
197120
|
}[];
|
|
195760
197121
|
}[];
|
|
195761
197122
|
}[];
|
|
@@ -197465,6 +198826,8 @@ type Routes = {
|
|
|
197465
198826
|
can_unlock_with_code?: boolean | undefined;
|
|
197466
198827
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
197467
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;
|
|
197468
198831
|
}[] | undefined;
|
|
197469
198832
|
connected_accounts?: {
|
|
197470
198833
|
/** ID of the connected account. */
|
|
@@ -219530,6 +220893,8 @@ type Routes = {
|
|
|
219530
220893
|
can_unlock_with_code?: boolean | undefined;
|
|
219531
220894
|
/** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
|
|
219532
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;
|
|
219533
220898
|
}[] | undefined;
|
|
219534
220899
|
acs_systems?: {
|
|
219535
220900
|
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|