@seamapi/types 1.384.0 → 1.386.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 +629 -150
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +4211 -445
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +8 -5
- package/lib/seam/connect/models/access-grants/access-grant.js +3 -0
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
- package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
- package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +156 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +4 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.d.ts +80 -0
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js +28 -0
- package/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.d.ts +80 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js +28 -0
- package/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.js.map +1 -0
- package/lib/seam/connect/models/colors.d.ts +2 -0
- package/lib/seam/connect/models/colors.js +8 -0
- package/lib/seam/connect/models/colors.js.map +1 -0
- package/lib/seam/connect/models/events/access-grants.d.ts +277 -0
- package/lib/seam/connect/models/events/access-grants.js +60 -0
- package/lib/seam/connect/models/events/access-grants.js.map +1 -0
- package/lib/seam/connect/models/events/access-methods.d.ts +146 -0
- package/lib/seam/connect/models/events/access-methods.js +35 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -0
- package/lib/seam/connect/models/workspaces/workspace.d.ts +33 -0
- package/lib/seam/connect/models/workspaces/workspace.js +8 -0
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +523 -225
- package/lib/seam/connect/openapi.js +592 -171
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3477 -198
- package/package.json +2 -2
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +5 -0
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +4 -2
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +4 -0
- package/src/lib/seam/connect/models/action-attempts/simulate-keypad-code-entry.ts +39 -0
- package/src/lib/seam/connect/models/action-attempts/simulate-manual-lock-via-keypad.ts +37 -0
- package/src/lib/seam/connect/models/colors.ts +9 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +92 -0
- package/src/lib/seam/connect/models/events/access-methods.ts +51 -0
- package/src/lib/seam/connect/models/workspaces/workspace.ts +9 -0
- package/src/lib/seam/connect/openapi.ts +615 -175
- package/src/lib/seam/connect/route-types.ts +3793 -36
|
@@ -785,6 +785,62 @@ export interface Routes {
|
|
|
785
785
|
type: string;
|
|
786
786
|
message: string;
|
|
787
787
|
};
|
|
788
|
+
} | {
|
|
789
|
+
/** ID of the action attempt. */
|
|
790
|
+
action_attempt_id: string;
|
|
791
|
+
status: 'pending';
|
|
792
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
793
|
+
result: null;
|
|
794
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
795
|
+
error: null;
|
|
796
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
797
|
+
} | {
|
|
798
|
+
/** ID of the action attempt. */
|
|
799
|
+
action_attempt_id: string;
|
|
800
|
+
status: 'success';
|
|
801
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
802
|
+
error: null;
|
|
803
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
804
|
+
result: {};
|
|
805
|
+
} | {
|
|
806
|
+
/** ID of the action attempt. */
|
|
807
|
+
action_attempt_id: string;
|
|
808
|
+
status: 'error';
|
|
809
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
810
|
+
result: null;
|
|
811
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
812
|
+
error: {
|
|
813
|
+
type: string;
|
|
814
|
+
message: string;
|
|
815
|
+
};
|
|
816
|
+
} | {
|
|
817
|
+
/** ID of the action attempt. */
|
|
818
|
+
action_attempt_id: string;
|
|
819
|
+
status: 'pending';
|
|
820
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
821
|
+
result: null;
|
|
822
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
823
|
+
error: null;
|
|
824
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
825
|
+
} | {
|
|
826
|
+
/** ID of the action attempt. */
|
|
827
|
+
action_attempt_id: string;
|
|
828
|
+
status: 'success';
|
|
829
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
830
|
+
error: null;
|
|
831
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
832
|
+
result: {};
|
|
833
|
+
} | {
|
|
834
|
+
/** ID of the action attempt. */
|
|
835
|
+
action_attempt_id: string;
|
|
836
|
+
status: 'error';
|
|
837
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
838
|
+
result: null;
|
|
839
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
840
|
+
error: {
|
|
841
|
+
type: string;
|
|
842
|
+
message: string;
|
|
843
|
+
};
|
|
788
844
|
} | {
|
|
789
845
|
/** ID of the action attempt. */
|
|
790
846
|
action_attempt_id: string;
|
|
@@ -2680,6 +2736,62 @@ export interface Routes {
|
|
|
2680
2736
|
type: string;
|
|
2681
2737
|
message: string;
|
|
2682
2738
|
};
|
|
2739
|
+
} | {
|
|
2740
|
+
/** ID of the action attempt. */
|
|
2741
|
+
action_attempt_id: string;
|
|
2742
|
+
status: 'pending';
|
|
2743
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
2744
|
+
result: null;
|
|
2745
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
2746
|
+
error: null;
|
|
2747
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
2748
|
+
} | {
|
|
2749
|
+
/** ID of the action attempt. */
|
|
2750
|
+
action_attempt_id: string;
|
|
2751
|
+
status: 'success';
|
|
2752
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
2753
|
+
error: null;
|
|
2754
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
2755
|
+
result: {};
|
|
2756
|
+
} | {
|
|
2757
|
+
/** ID of the action attempt. */
|
|
2758
|
+
action_attempt_id: string;
|
|
2759
|
+
status: 'error';
|
|
2760
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
2761
|
+
result: null;
|
|
2762
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
2763
|
+
error: {
|
|
2764
|
+
type: string;
|
|
2765
|
+
message: string;
|
|
2766
|
+
};
|
|
2767
|
+
} | {
|
|
2768
|
+
/** ID of the action attempt. */
|
|
2769
|
+
action_attempt_id: string;
|
|
2770
|
+
status: 'pending';
|
|
2771
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
2772
|
+
result: null;
|
|
2773
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
2774
|
+
error: null;
|
|
2775
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
2776
|
+
} | {
|
|
2777
|
+
/** ID of the action attempt. */
|
|
2778
|
+
action_attempt_id: string;
|
|
2779
|
+
status: 'success';
|
|
2780
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
2781
|
+
error: null;
|
|
2782
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
2783
|
+
result: {};
|
|
2784
|
+
} | {
|
|
2785
|
+
/** ID of the action attempt. */
|
|
2786
|
+
action_attempt_id: string;
|
|
2787
|
+
status: 'error';
|
|
2788
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
2789
|
+
result: null;
|
|
2790
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
2791
|
+
error: {
|
|
2792
|
+
type: string;
|
|
2793
|
+
message: string;
|
|
2794
|
+
};
|
|
2683
2795
|
} | {
|
|
2684
2796
|
/** ID of the action attempt. */
|
|
2685
2797
|
action_attempt_id: string;
|
|
@@ -5955,6 +6067,62 @@ export interface Routes {
|
|
|
5955
6067
|
type: string;
|
|
5956
6068
|
message: string;
|
|
5957
6069
|
};
|
|
6070
|
+
} | {
|
|
6071
|
+
/** ID of the action attempt. */
|
|
6072
|
+
action_attempt_id: string;
|
|
6073
|
+
status: 'pending';
|
|
6074
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
6075
|
+
result: null;
|
|
6076
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
6077
|
+
error: null;
|
|
6078
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
6079
|
+
} | {
|
|
6080
|
+
/** ID of the action attempt. */
|
|
6081
|
+
action_attempt_id: string;
|
|
6082
|
+
status: 'success';
|
|
6083
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
6084
|
+
error: null;
|
|
6085
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
6086
|
+
result: {};
|
|
6087
|
+
} | {
|
|
6088
|
+
/** ID of the action attempt. */
|
|
6089
|
+
action_attempt_id: string;
|
|
6090
|
+
status: 'error';
|
|
6091
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
6092
|
+
result: null;
|
|
6093
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
6094
|
+
error: {
|
|
6095
|
+
type: string;
|
|
6096
|
+
message: string;
|
|
6097
|
+
};
|
|
6098
|
+
} | {
|
|
6099
|
+
/** ID of the action attempt. */
|
|
6100
|
+
action_attempt_id: string;
|
|
6101
|
+
status: 'pending';
|
|
6102
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
6103
|
+
result: null;
|
|
6104
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
6105
|
+
error: null;
|
|
6106
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
6107
|
+
} | {
|
|
6108
|
+
/** ID of the action attempt. */
|
|
6109
|
+
action_attempt_id: string;
|
|
6110
|
+
status: 'success';
|
|
6111
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
6112
|
+
error: null;
|
|
6113
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
6114
|
+
result: {};
|
|
6115
|
+
} | {
|
|
6116
|
+
/** ID of the action attempt. */
|
|
6117
|
+
action_attempt_id: string;
|
|
6118
|
+
status: 'error';
|
|
6119
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
6120
|
+
result: null;
|
|
6121
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
6122
|
+
error: {
|
|
6123
|
+
type: string;
|
|
6124
|
+
message: string;
|
|
6125
|
+
};
|
|
5958
6126
|
} | {
|
|
5959
6127
|
/** ID of the action attempt. */
|
|
5960
6128
|
action_attempt_id: string;
|
|
@@ -7854,6 +8022,62 @@ export interface Routes {
|
|
|
7854
8022
|
type: string;
|
|
7855
8023
|
message: string;
|
|
7856
8024
|
};
|
|
8025
|
+
} | {
|
|
8026
|
+
/** ID of the action attempt. */
|
|
8027
|
+
action_attempt_id: string;
|
|
8028
|
+
status: 'pending';
|
|
8029
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
8030
|
+
result: null;
|
|
8031
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
8032
|
+
error: null;
|
|
8033
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
8034
|
+
} | {
|
|
8035
|
+
/** ID of the action attempt. */
|
|
8036
|
+
action_attempt_id: string;
|
|
8037
|
+
status: 'success';
|
|
8038
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
8039
|
+
error: null;
|
|
8040
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
8041
|
+
result: {};
|
|
8042
|
+
} | {
|
|
8043
|
+
/** ID of the action attempt. */
|
|
8044
|
+
action_attempt_id: string;
|
|
8045
|
+
status: 'error';
|
|
8046
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
8047
|
+
result: null;
|
|
8048
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
8049
|
+
error: {
|
|
8050
|
+
type: string;
|
|
8051
|
+
message: string;
|
|
8052
|
+
};
|
|
8053
|
+
} | {
|
|
8054
|
+
/** ID of the action attempt. */
|
|
8055
|
+
action_attempt_id: string;
|
|
8056
|
+
status: 'pending';
|
|
8057
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
8058
|
+
result: null;
|
|
8059
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
8060
|
+
error: null;
|
|
8061
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
8062
|
+
} | {
|
|
8063
|
+
/** ID of the action attempt. */
|
|
8064
|
+
action_attempt_id: string;
|
|
8065
|
+
status: 'success';
|
|
8066
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
8067
|
+
error: null;
|
|
8068
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
8069
|
+
result: {};
|
|
8070
|
+
} | {
|
|
8071
|
+
/** ID of the action attempt. */
|
|
8072
|
+
action_attempt_id: string;
|
|
8073
|
+
status: 'error';
|
|
8074
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
8075
|
+
result: null;
|
|
8076
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
8077
|
+
error: {
|
|
8078
|
+
type: string;
|
|
8079
|
+
message: string;
|
|
8080
|
+
};
|
|
7857
8081
|
} | {
|
|
7858
8082
|
/** ID of the action attempt. */
|
|
7859
8083
|
action_attempt_id: string;
|
|
@@ -10675,6 +10899,62 @@ export interface Routes {
|
|
|
10675
10899
|
type: string;
|
|
10676
10900
|
message: string;
|
|
10677
10901
|
};
|
|
10902
|
+
} | {
|
|
10903
|
+
/** ID of the action attempt. */
|
|
10904
|
+
action_attempt_id: string;
|
|
10905
|
+
status: 'pending';
|
|
10906
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
10907
|
+
result: null;
|
|
10908
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
10909
|
+
error: null;
|
|
10910
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
10911
|
+
} | {
|
|
10912
|
+
/** ID of the action attempt. */
|
|
10913
|
+
action_attempt_id: string;
|
|
10914
|
+
status: 'success';
|
|
10915
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
10916
|
+
error: null;
|
|
10917
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
10918
|
+
result: {};
|
|
10919
|
+
} | {
|
|
10920
|
+
/** ID of the action attempt. */
|
|
10921
|
+
action_attempt_id: string;
|
|
10922
|
+
status: 'error';
|
|
10923
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
10924
|
+
result: null;
|
|
10925
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
10926
|
+
error: {
|
|
10927
|
+
type: string;
|
|
10928
|
+
message: string;
|
|
10929
|
+
};
|
|
10930
|
+
} | {
|
|
10931
|
+
/** ID of the action attempt. */
|
|
10932
|
+
action_attempt_id: string;
|
|
10933
|
+
status: 'pending';
|
|
10934
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
10935
|
+
result: null;
|
|
10936
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
10937
|
+
error: null;
|
|
10938
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
10939
|
+
} | {
|
|
10940
|
+
/** ID of the action attempt. */
|
|
10941
|
+
action_attempt_id: string;
|
|
10942
|
+
status: 'success';
|
|
10943
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
10944
|
+
error: null;
|
|
10945
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
10946
|
+
result: {};
|
|
10947
|
+
} | {
|
|
10948
|
+
/** ID of the action attempt. */
|
|
10949
|
+
action_attempt_id: string;
|
|
10950
|
+
status: 'error';
|
|
10951
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
10952
|
+
result: null;
|
|
10953
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
10954
|
+
error: {
|
|
10955
|
+
type: string;
|
|
10956
|
+
message: string;
|
|
10957
|
+
};
|
|
10678
10958
|
} | {
|
|
10679
10959
|
/** ID of the action attempt. */
|
|
10680
10960
|
action_attempt_id: string;
|
|
@@ -11732,6 +12012,62 @@ export interface Routes {
|
|
|
11732
12012
|
type: string;
|
|
11733
12013
|
message: string;
|
|
11734
12014
|
};
|
|
12015
|
+
} | {
|
|
12016
|
+
/** ID of the action attempt. */
|
|
12017
|
+
action_attempt_id: string;
|
|
12018
|
+
status: 'pending';
|
|
12019
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
12020
|
+
result: null;
|
|
12021
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
12022
|
+
error: null;
|
|
12023
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
12024
|
+
} | {
|
|
12025
|
+
/** ID of the action attempt. */
|
|
12026
|
+
action_attempt_id: string;
|
|
12027
|
+
status: 'success';
|
|
12028
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
12029
|
+
error: null;
|
|
12030
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
12031
|
+
result: {};
|
|
12032
|
+
} | {
|
|
12033
|
+
/** ID of the action attempt. */
|
|
12034
|
+
action_attempt_id: string;
|
|
12035
|
+
status: 'error';
|
|
12036
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
12037
|
+
result: null;
|
|
12038
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
12039
|
+
error: {
|
|
12040
|
+
type: string;
|
|
12041
|
+
message: string;
|
|
12042
|
+
};
|
|
12043
|
+
} | {
|
|
12044
|
+
/** ID of the action attempt. */
|
|
12045
|
+
action_attempt_id: string;
|
|
12046
|
+
status: 'pending';
|
|
12047
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
12048
|
+
result: null;
|
|
12049
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
12050
|
+
error: null;
|
|
12051
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
12052
|
+
} | {
|
|
12053
|
+
/** ID of the action attempt. */
|
|
12054
|
+
action_attempt_id: string;
|
|
12055
|
+
status: 'success';
|
|
12056
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
12057
|
+
error: null;
|
|
12058
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
12059
|
+
result: {};
|
|
12060
|
+
} | {
|
|
12061
|
+
/** ID of the action attempt. */
|
|
12062
|
+
action_attempt_id: string;
|
|
12063
|
+
status: 'error';
|
|
12064
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
12065
|
+
result: null;
|
|
12066
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
12067
|
+
error: {
|
|
12068
|
+
type: string;
|
|
12069
|
+
message: string;
|
|
12070
|
+
};
|
|
11735
12071
|
} | {
|
|
11736
12072
|
/** ID of the action attempt. */
|
|
11737
12073
|
action_attempt_id: string;
|
|
@@ -14560,6 +14896,62 @@ export interface Routes {
|
|
|
14560
14896
|
type: string;
|
|
14561
14897
|
message: string;
|
|
14562
14898
|
};
|
|
14899
|
+
} | {
|
|
14900
|
+
/** ID of the action attempt. */
|
|
14901
|
+
action_attempt_id: string;
|
|
14902
|
+
status: 'pending';
|
|
14903
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
14904
|
+
result: null;
|
|
14905
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
14906
|
+
error: null;
|
|
14907
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
14908
|
+
} | {
|
|
14909
|
+
/** ID of the action attempt. */
|
|
14910
|
+
action_attempt_id: string;
|
|
14911
|
+
status: 'success';
|
|
14912
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
14913
|
+
error: null;
|
|
14914
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
14915
|
+
result: {};
|
|
14916
|
+
} | {
|
|
14917
|
+
/** ID of the action attempt. */
|
|
14918
|
+
action_attempt_id: string;
|
|
14919
|
+
status: 'error';
|
|
14920
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
14921
|
+
result: null;
|
|
14922
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
14923
|
+
error: {
|
|
14924
|
+
type: string;
|
|
14925
|
+
message: string;
|
|
14926
|
+
};
|
|
14927
|
+
} | {
|
|
14928
|
+
/** ID of the action attempt. */
|
|
14929
|
+
action_attempt_id: string;
|
|
14930
|
+
status: 'pending';
|
|
14931
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
14932
|
+
result: null;
|
|
14933
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
14934
|
+
error: null;
|
|
14935
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
14936
|
+
} | {
|
|
14937
|
+
/** ID of the action attempt. */
|
|
14938
|
+
action_attempt_id: string;
|
|
14939
|
+
status: 'success';
|
|
14940
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
14941
|
+
error: null;
|
|
14942
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
14943
|
+
result: {};
|
|
14944
|
+
} | {
|
|
14945
|
+
/** ID of the action attempt. */
|
|
14946
|
+
action_attempt_id: string;
|
|
14947
|
+
status: 'error';
|
|
14948
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
14949
|
+
result: null;
|
|
14950
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
14951
|
+
error: {
|
|
14952
|
+
type: string;
|
|
14953
|
+
message: string;
|
|
14954
|
+
};
|
|
14563
14955
|
} | {
|
|
14564
14956
|
/** ID of the action attempt. */
|
|
14565
14957
|
action_attempt_id: string;
|
|
@@ -15521,6 +15913,62 @@ export interface Routes {
|
|
|
15521
15913
|
type: string;
|
|
15522
15914
|
message: string;
|
|
15523
15915
|
};
|
|
15916
|
+
} | {
|
|
15917
|
+
/** ID of the action attempt. */
|
|
15918
|
+
action_attempt_id: string;
|
|
15919
|
+
status: 'pending';
|
|
15920
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
15921
|
+
result: null;
|
|
15922
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
15923
|
+
error: null;
|
|
15924
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
15925
|
+
} | {
|
|
15926
|
+
/** ID of the action attempt. */
|
|
15927
|
+
action_attempt_id: string;
|
|
15928
|
+
status: 'success';
|
|
15929
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
15930
|
+
error: null;
|
|
15931
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
15932
|
+
result: {};
|
|
15933
|
+
} | {
|
|
15934
|
+
/** ID of the action attempt. */
|
|
15935
|
+
action_attempt_id: string;
|
|
15936
|
+
status: 'error';
|
|
15937
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
15938
|
+
result: null;
|
|
15939
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
15940
|
+
error: {
|
|
15941
|
+
type: string;
|
|
15942
|
+
message: string;
|
|
15943
|
+
};
|
|
15944
|
+
} | {
|
|
15945
|
+
/** ID of the action attempt. */
|
|
15946
|
+
action_attempt_id: string;
|
|
15947
|
+
status: 'pending';
|
|
15948
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
15949
|
+
result: null;
|
|
15950
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
15951
|
+
error: null;
|
|
15952
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
15953
|
+
} | {
|
|
15954
|
+
/** ID of the action attempt. */
|
|
15955
|
+
action_attempt_id: string;
|
|
15956
|
+
status: 'success';
|
|
15957
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
15958
|
+
error: null;
|
|
15959
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
15960
|
+
result: {};
|
|
15961
|
+
} | {
|
|
15962
|
+
/** ID of the action attempt. */
|
|
15963
|
+
action_attempt_id: string;
|
|
15964
|
+
status: 'error';
|
|
15965
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
15966
|
+
result: null;
|
|
15967
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
15968
|
+
error: {
|
|
15969
|
+
type: string;
|
|
15970
|
+
message: string;
|
|
15971
|
+
};
|
|
15524
15972
|
} | {
|
|
15525
15973
|
/** ID of the action attempt. */
|
|
15526
15974
|
action_attempt_id: string;
|
|
@@ -17875,30 +18323,6 @@ export interface Routes {
|
|
|
17875
18323
|
}>;
|
|
17876
18324
|
};
|
|
17877
18325
|
};
|
|
17878
|
-
'/devices/simulate/access_code_lock': {
|
|
17879
|
-
route: '/devices/simulate/access_code_lock';
|
|
17880
|
-
method: 'POST';
|
|
17881
|
-
queryParams: {};
|
|
17882
|
-
jsonBody: {
|
|
17883
|
-
device_id: string;
|
|
17884
|
-
access_code_id: string;
|
|
17885
|
-
};
|
|
17886
|
-
commonParams: {};
|
|
17887
|
-
formData: {};
|
|
17888
|
-
jsonResponse: {};
|
|
17889
|
-
};
|
|
17890
|
-
'/devices/simulate/access_code_unlock': {
|
|
17891
|
-
route: '/devices/simulate/access_code_unlock';
|
|
17892
|
-
method: 'POST';
|
|
17893
|
-
queryParams: {};
|
|
17894
|
-
jsonBody: {
|
|
17895
|
-
device_id: string;
|
|
17896
|
-
access_code_id: string;
|
|
17897
|
-
};
|
|
17898
|
-
commonParams: {};
|
|
17899
|
-
formData: {};
|
|
17900
|
-
jsonResponse: {};
|
|
17901
|
-
};
|
|
17902
18326
|
'/devices/simulate/connect': {
|
|
17903
18327
|
route: '/devices/simulate/connect';
|
|
17904
18328
|
method: 'POST';
|
|
@@ -24722,6 +25146,62 @@ export interface Routes {
|
|
|
24722
25146
|
type: string;
|
|
24723
25147
|
message: string;
|
|
24724
25148
|
};
|
|
25149
|
+
} | {
|
|
25150
|
+
/** ID of the action attempt. */
|
|
25151
|
+
action_attempt_id: string;
|
|
25152
|
+
status: 'pending';
|
|
25153
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
25154
|
+
result: null;
|
|
25155
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
25156
|
+
error: null;
|
|
25157
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
25158
|
+
} | {
|
|
25159
|
+
/** ID of the action attempt. */
|
|
25160
|
+
action_attempt_id: string;
|
|
25161
|
+
status: 'success';
|
|
25162
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
25163
|
+
error: null;
|
|
25164
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
25165
|
+
result: {};
|
|
25166
|
+
} | {
|
|
25167
|
+
/** ID of the action attempt. */
|
|
25168
|
+
action_attempt_id: string;
|
|
25169
|
+
status: 'error';
|
|
25170
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
25171
|
+
result: null;
|
|
25172
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
25173
|
+
error: {
|
|
25174
|
+
type: string;
|
|
25175
|
+
message: string;
|
|
25176
|
+
};
|
|
25177
|
+
} | {
|
|
25178
|
+
/** ID of the action attempt. */
|
|
25179
|
+
action_attempt_id: string;
|
|
25180
|
+
status: 'pending';
|
|
25181
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
25182
|
+
result: null;
|
|
25183
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
25184
|
+
error: null;
|
|
25185
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
25186
|
+
} | {
|
|
25187
|
+
/** ID of the action attempt. */
|
|
25188
|
+
action_attempt_id: string;
|
|
25189
|
+
status: 'success';
|
|
25190
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
25191
|
+
error: null;
|
|
25192
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
25193
|
+
result: {};
|
|
25194
|
+
} | {
|
|
25195
|
+
/** ID of the action attempt. */
|
|
25196
|
+
action_attempt_id: string;
|
|
25197
|
+
status: 'error';
|
|
25198
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
25199
|
+
result: null;
|
|
25200
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
25201
|
+
error: {
|
|
25202
|
+
type: string;
|
|
25203
|
+
message: string;
|
|
25204
|
+
};
|
|
24725
25205
|
} | {
|
|
24726
25206
|
/** ID of the action attempt. */
|
|
24727
25207
|
action_attempt_id: string;
|
|
@@ -24929,13 +25409,13 @@ export interface Routes {
|
|
|
24929
25409
|
};
|
|
24930
25410
|
};
|
|
24931
25411
|
};
|
|
24932
|
-
'/locks/
|
|
24933
|
-
route: '/locks/
|
|
25412
|
+
'/locks/simulate/keypad_code_entry': {
|
|
25413
|
+
route: '/locks/simulate/keypad_code_entry';
|
|
24934
25414
|
method: 'POST';
|
|
24935
25415
|
queryParams: {};
|
|
24936
25416
|
jsonBody: {
|
|
24937
25417
|
device_id: string;
|
|
24938
|
-
|
|
25418
|
+
code: string;
|
|
24939
25419
|
};
|
|
24940
25420
|
commonParams: {};
|
|
24941
25421
|
formData: {};
|
|
@@ -25685,6 +26165,62 @@ export interface Routes {
|
|
|
25685
26165
|
type: string;
|
|
25686
26166
|
message: string;
|
|
25687
26167
|
};
|
|
26168
|
+
} | {
|
|
26169
|
+
/** ID of the action attempt. */
|
|
26170
|
+
action_attempt_id: string;
|
|
26171
|
+
status: 'pending';
|
|
26172
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26173
|
+
result: null;
|
|
26174
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26175
|
+
error: null;
|
|
26176
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
26177
|
+
} | {
|
|
26178
|
+
/** ID of the action attempt. */
|
|
26179
|
+
action_attempt_id: string;
|
|
26180
|
+
status: 'success';
|
|
26181
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26182
|
+
error: null;
|
|
26183
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
26184
|
+
result: {};
|
|
26185
|
+
} | {
|
|
26186
|
+
/** ID of the action attempt. */
|
|
26187
|
+
action_attempt_id: string;
|
|
26188
|
+
status: 'error';
|
|
26189
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
26190
|
+
result: null;
|
|
26191
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
26192
|
+
error: {
|
|
26193
|
+
type: string;
|
|
26194
|
+
message: string;
|
|
26195
|
+
};
|
|
26196
|
+
} | {
|
|
26197
|
+
/** ID of the action attempt. */
|
|
26198
|
+
action_attempt_id: string;
|
|
26199
|
+
status: 'pending';
|
|
26200
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26201
|
+
result: null;
|
|
26202
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26203
|
+
error: null;
|
|
26204
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
26205
|
+
} | {
|
|
26206
|
+
/** ID of the action attempt. */
|
|
26207
|
+
action_attempt_id: string;
|
|
26208
|
+
status: 'success';
|
|
26209
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26210
|
+
error: null;
|
|
26211
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
26212
|
+
result: {};
|
|
26213
|
+
} | {
|
|
26214
|
+
/** ID of the action attempt. */
|
|
26215
|
+
action_attempt_id: string;
|
|
26216
|
+
status: 'error';
|
|
26217
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
26218
|
+
result: null;
|
|
26219
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
26220
|
+
error: {
|
|
26221
|
+
type: string;
|
|
26222
|
+
message: string;
|
|
26223
|
+
};
|
|
25688
26224
|
} | {
|
|
25689
26225
|
/** ID of the action attempt. */
|
|
25690
26226
|
action_attempt_id: string;
|
|
@@ -25892,176 +26428,2213 @@ export interface Routes {
|
|
|
25892
26428
|
};
|
|
25893
26429
|
};
|
|
25894
26430
|
};
|
|
25895
|
-
'/
|
|
25896
|
-
route: '/
|
|
25897
|
-
method: '
|
|
26431
|
+
'/locks/simulate/manual_lock_via_keypad': {
|
|
26432
|
+
route: '/locks/simulate/manual_lock_via_keypad';
|
|
26433
|
+
method: 'POST';
|
|
25898
26434
|
queryParams: {};
|
|
25899
|
-
jsonBody: {
|
|
25900
|
-
|
|
25901
|
-
network_id: string;
|
|
25902
|
-
};
|
|
25903
|
-
formData: {};
|
|
25904
|
-
jsonResponse: {
|
|
25905
|
-
/** */
|
|
25906
|
-
network: {
|
|
25907
|
-
network_id: string;
|
|
25908
|
-
workspace_id: string;
|
|
25909
|
-
display_name: string;
|
|
25910
|
-
created_at: string;
|
|
25911
|
-
};
|
|
26435
|
+
jsonBody: {
|
|
26436
|
+
device_id: string;
|
|
25912
26437
|
};
|
|
25913
|
-
};
|
|
25914
|
-
'/networks/list': {
|
|
25915
|
-
route: '/networks/list';
|
|
25916
|
-
method: 'GET' | 'POST';
|
|
25917
|
-
queryParams: {};
|
|
25918
|
-
jsonBody: {};
|
|
25919
26438
|
commonParams: {};
|
|
25920
26439
|
formData: {};
|
|
25921
26440
|
jsonResponse: {
|
|
25922
|
-
networks: Array<{
|
|
25923
|
-
network_id: string;
|
|
25924
|
-
workspace_id: string;
|
|
25925
|
-
display_name: string;
|
|
25926
|
-
created_at: string;
|
|
25927
|
-
}>;
|
|
25928
|
-
};
|
|
25929
|
-
};
|
|
25930
|
-
'/noise_sensors/list': {
|
|
25931
|
-
route: '/noise_sensors/list';
|
|
25932
|
-
method: 'GET' | 'POST';
|
|
25933
|
-
queryParams: {};
|
|
25934
|
-
jsonBody: {};
|
|
25935
|
-
commonParams: {
|
|
25936
|
-
/** ID of the connected account by which to filter. */
|
|
25937
|
-
connected_account_id?: string | undefined;
|
|
25938
|
-
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
25939
|
-
connected_account_ids?: string[] | undefined;
|
|
25940
|
-
/** ID of the Connect Webview by which to filter devices. */
|
|
25941
|
-
connect_webview_id?: string | undefined;
|
|
25942
|
-
/** Device type by which to filter devices. */
|
|
25943
|
-
device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
|
|
25944
|
-
/** Array of device types by which to filter devices. */
|
|
25945
|
-
device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
|
|
25946
|
-
/** Manufacturer by which to filter devices. */
|
|
25947
|
-
manufacturer?: ('noiseaware' | 'minut') | undefined;
|
|
25948
|
-
/** Array of device IDs by which to filter devices. */
|
|
25949
|
-
device_ids?: string[] | undefined;
|
|
25950
|
-
/** Numerical limit on the number of devices to return. */
|
|
25951
|
-
limit?: number;
|
|
25952
|
-
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
25953
|
-
created_before?: Date | undefined;
|
|
25954
|
-
/** Your own internal user ID for the user by which to filter devices. */
|
|
25955
|
-
user_identifier_key?: string | undefined;
|
|
25956
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
|
|
25957
|
-
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
25958
|
-
/** */
|
|
25959
|
-
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
25960
|
-
/** */
|
|
25961
|
-
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
25962
26441
|
/** */
|
|
25963
|
-
|
|
25964
|
-
|
|
25965
|
-
|
|
25966
|
-
|
|
25967
|
-
|
|
25968
|
-
|
|
25969
|
-
|
|
25970
|
-
|
|
25971
|
-
|
|
25972
|
-
|
|
25973
|
-
|
|
25974
|
-
|
|
25975
|
-
|
|
25976
|
-
/**
|
|
25977
|
-
|
|
25978
|
-
|
|
25979
|
-
|
|
25980
|
-
|
|
25981
|
-
|
|
25982
|
-
|
|
25983
|
-
|
|
25984
|
-
|
|
25985
|
-
|
|
25986
|
-
|
|
25987
|
-
|
|
25988
|
-
|
|
25989
|
-
|
|
25990
|
-
|
|
25991
|
-
|
|
26442
|
+
action_attempt: {
|
|
26443
|
+
/** ID of the action attempt. */
|
|
26444
|
+
action_attempt_id: string;
|
|
26445
|
+
status: 'pending';
|
|
26446
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26447
|
+
result: null;
|
|
26448
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26449
|
+
error: null;
|
|
26450
|
+
action_type: 'LOCK_DOOR';
|
|
26451
|
+
} | {
|
|
26452
|
+
/** ID of the action attempt. */
|
|
26453
|
+
action_attempt_id: string;
|
|
26454
|
+
status: 'success';
|
|
26455
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26456
|
+
error: null;
|
|
26457
|
+
action_type: 'LOCK_DOOR';
|
|
26458
|
+
result: {};
|
|
26459
|
+
} | {
|
|
26460
|
+
/** ID of the action attempt. */
|
|
26461
|
+
action_attempt_id: string;
|
|
26462
|
+
status: 'error';
|
|
26463
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
26464
|
+
result: null;
|
|
26465
|
+
action_type: 'LOCK_DOOR';
|
|
26466
|
+
error: {
|
|
26467
|
+
type: string;
|
|
26468
|
+
message: string;
|
|
26469
|
+
};
|
|
26470
|
+
} | {
|
|
26471
|
+
/** ID of the action attempt. */
|
|
26472
|
+
action_attempt_id: string;
|
|
26473
|
+
status: 'pending';
|
|
26474
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26475
|
+
result: null;
|
|
26476
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26477
|
+
error: null;
|
|
26478
|
+
action_type: 'UNLOCK_DOOR';
|
|
26479
|
+
} | {
|
|
26480
|
+
/** ID of the action attempt. */
|
|
26481
|
+
action_attempt_id: string;
|
|
26482
|
+
status: 'success';
|
|
26483
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26484
|
+
error: null;
|
|
26485
|
+
action_type: 'UNLOCK_DOOR';
|
|
26486
|
+
result: {};
|
|
26487
|
+
} | {
|
|
26488
|
+
/** ID of the action attempt. */
|
|
26489
|
+
action_attempt_id: string;
|
|
26490
|
+
status: 'error';
|
|
26491
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
26492
|
+
result: null;
|
|
26493
|
+
action_type: 'UNLOCK_DOOR';
|
|
26494
|
+
error: {
|
|
26495
|
+
type: string;
|
|
26496
|
+
message: string;
|
|
26497
|
+
};
|
|
26498
|
+
} | {
|
|
26499
|
+
/** ID of the action attempt. */
|
|
26500
|
+
action_attempt_id: string;
|
|
26501
|
+
status: 'pending';
|
|
26502
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26503
|
+
result: null;
|
|
26504
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26505
|
+
error: null;
|
|
26506
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
26507
|
+
} | {
|
|
26508
|
+
/** ID of the action attempt. */
|
|
26509
|
+
action_attempt_id: string;
|
|
26510
|
+
status: 'success';
|
|
26511
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26512
|
+
error: null;
|
|
26513
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
26514
|
+
result: {
|
|
26515
|
+
/** Snapshot of credential data read from physical encoder. */
|
|
26516
|
+
acs_credential_on_encoder: {
|
|
26517
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
26518
|
+
created_at: string | null;
|
|
26519
|
+
is_issued: boolean | null;
|
|
26520
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
26521
|
+
starts_at: string | null;
|
|
26522
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
26523
|
+
ends_at: string | null;
|
|
26524
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26525
|
+
card_number: string | null;
|
|
26526
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26527
|
+
visionline_metadata?: {
|
|
26528
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26529
|
+
card_id: string;
|
|
26530
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
26531
|
+
cancelled: boolean;
|
|
26532
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
26533
|
+
discarded: boolean;
|
|
26534
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
26535
|
+
expired: boolean;
|
|
26536
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
26537
|
+
overwritten: boolean;
|
|
26538
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
26539
|
+
overridden?: boolean | undefined;
|
|
26540
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
26541
|
+
pending_auto_update: boolean;
|
|
26542
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26543
|
+
card_format: 'TLCode' | 'rfid48';
|
|
26544
|
+
/** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26545
|
+
card_holder?: string | undefined;
|
|
26546
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26547
|
+
number_of_issued_cards: number;
|
|
26548
|
+
/** 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). */
|
|
26549
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
26550
|
+
/** 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). */
|
|
26551
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
25992
26552
|
} | undefined;
|
|
25993
|
-
} |
|
|
25994
|
-
|
|
25995
|
-
|
|
25996
|
-
|
|
25997
|
-
|
|
25998
|
-
|
|
25999
|
-
|
|
26000
|
-
|
|
26001
|
-
/**
|
|
26553
|
+
} | null;
|
|
26554
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
26555
|
+
acs_credential_on_seam: ({
|
|
26556
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26557
|
+
acs_credential_id: string;
|
|
26558
|
+
/** 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. */
|
|
26559
|
+
acs_user_id?: string | undefined;
|
|
26560
|
+
acs_credential_pool_id?: string | undefined;
|
|
26561
|
+
/** 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). */
|
|
26562
|
+
acs_system_id: string;
|
|
26563
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26564
|
+
parent_acs_credential_id?: string | undefined;
|
|
26565
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26002
26566
|
display_name: string;
|
|
26003
|
-
/**
|
|
26004
|
-
|
|
26005
|
-
/** Indicates whether the
|
|
26006
|
-
|
|
26007
|
-
/**
|
|
26008
|
-
|
|
26009
|
-
/** Indicates whether the
|
|
26010
|
-
|
|
26011
|
-
/**
|
|
26012
|
-
|
|
26013
|
-
|
|
26014
|
-
|
|
26015
|
-
|
|
26016
|
-
|
|
26017
|
-
|
|
26018
|
-
|
|
26019
|
-
|
|
26020
|
-
|
|
26021
|
-
|
|
26022
|
-
|
|
26023
|
-
|
|
26024
|
-
|
|
26025
|
-
|
|
26026
|
-
|
|
26027
|
-
|
|
26028
|
-
|
|
26029
|
-
|
|
26030
|
-
|
|
26031
|
-
|
|
26032
|
-
|
|
26033
|
-
|
|
26034
|
-
|
|
26035
|
-
|
|
26036
|
-
|
|
26037
|
-
|
|
26038
|
-
|
|
26039
|
-
|
|
26040
|
-
|
|
26041
|
-
|
|
26042
|
-
|
|
26043
|
-
|
|
26044
|
-
|
|
26045
|
-
|
|
26046
|
-
|
|
26047
|
-
|
|
26048
|
-
|
|
26049
|
-
|
|
26050
|
-
|
|
26051
|
-
|
|
26052
|
-
|
|
26053
|
-
|
|
26054
|
-
|
|
26055
|
-
/**
|
|
26056
|
-
|
|
26057
|
-
|
|
26058
|
-
|
|
26059
|
-
|
|
26060
|
-
|
|
26061
|
-
|
|
26062
|
-
|
|
26063
|
-
|
|
26064
|
-
|
|
26567
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26568
|
+
code?: (string | undefined) | null;
|
|
26569
|
+
/** 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. */
|
|
26570
|
+
is_one_time_use?: boolean | undefined;
|
|
26571
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26572
|
+
card_number?: (string | undefined) | null;
|
|
26573
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
26574
|
+
is_issued?: boolean | undefined;
|
|
26575
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
26576
|
+
issued_at?: (string | undefined) | null;
|
|
26577
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
26578
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
26579
|
+
/** 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`. */
|
|
26580
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
26581
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26582
|
+
external_type_display_name?: string | undefined;
|
|
26583
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
26584
|
+
created_at: string;
|
|
26585
|
+
/** 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). */
|
|
26586
|
+
workspace_id: string;
|
|
26587
|
+
/** 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. */
|
|
26588
|
+
starts_at?: string | undefined;
|
|
26589
|
+
/** 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`. */
|
|
26590
|
+
ends_at?: string | undefined;
|
|
26591
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26592
|
+
errors: Array<{
|
|
26593
|
+
error_code: string;
|
|
26594
|
+
message: string;
|
|
26595
|
+
}>;
|
|
26596
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26597
|
+
warnings: Array<{
|
|
26598
|
+
/** Date and time at which Seam created the warning. */
|
|
26599
|
+
created_at: string;
|
|
26600
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26601
|
+
message: string;
|
|
26602
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26603
|
+
warning_code: 'waiting_to_be_issued';
|
|
26604
|
+
} | {
|
|
26605
|
+
/** Date and time at which Seam created the warning. */
|
|
26606
|
+
created_at: string;
|
|
26607
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26608
|
+
message: string;
|
|
26609
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26610
|
+
warning_code: 'schedule_externally_modified';
|
|
26611
|
+
} | {
|
|
26612
|
+
/** Date and time at which Seam created the warning. */
|
|
26613
|
+
created_at: string;
|
|
26614
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26615
|
+
message: string;
|
|
26616
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26617
|
+
warning_code: 'schedule_modified';
|
|
26618
|
+
} | {
|
|
26619
|
+
/** Date and time at which Seam created the warning. */
|
|
26620
|
+
created_at: string;
|
|
26621
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26622
|
+
message: string;
|
|
26623
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26624
|
+
warning_code: 'being_deleted';
|
|
26625
|
+
} | {
|
|
26626
|
+
/** Date and time at which Seam created the warning. */
|
|
26627
|
+
created_at: string;
|
|
26628
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26629
|
+
message: string;
|
|
26630
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26631
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
26632
|
+
} | {
|
|
26633
|
+
/** Date and time at which Seam created the warning. */
|
|
26634
|
+
created_at: string;
|
|
26635
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26636
|
+
message: string;
|
|
26637
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26638
|
+
warning_code: 'needs_to_be_reissued';
|
|
26639
|
+
}>;
|
|
26640
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
26641
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
26642
|
+
/** 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. */
|
|
26643
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
26644
|
+
/** 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. */
|
|
26645
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
26646
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26647
|
+
visionline_metadata?: {
|
|
26648
|
+
card_function_type: 'guest' | 'staff';
|
|
26649
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
26650
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
26651
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
26652
|
+
is_valid?: boolean | undefined;
|
|
26653
|
+
auto_join?: boolean | undefined;
|
|
26654
|
+
card_id?: string | undefined;
|
|
26655
|
+
credential_id?: string | undefined;
|
|
26656
|
+
} | undefined;
|
|
26657
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26658
|
+
assa_abloy_vostio_metadata?: {
|
|
26659
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
26660
|
+
key_id?: string | undefined;
|
|
26661
|
+
key_issuing_request_id?: string | undefined;
|
|
26662
|
+
door_names?: string[] | undefined;
|
|
26663
|
+
endpoint_id?: string | undefined;
|
|
26664
|
+
} | undefined;
|
|
26665
|
+
is_managed: true;
|
|
26666
|
+
} | {
|
|
26667
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26668
|
+
acs_credential_id: string;
|
|
26669
|
+
/** 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. */
|
|
26670
|
+
acs_user_id?: string | undefined;
|
|
26671
|
+
acs_credential_pool_id?: string | undefined;
|
|
26672
|
+
/** 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). */
|
|
26673
|
+
acs_system_id: string;
|
|
26674
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26675
|
+
parent_acs_credential_id?: string | undefined;
|
|
26676
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26677
|
+
display_name: string;
|
|
26678
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26679
|
+
code?: (string | undefined) | null;
|
|
26680
|
+
/** 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. */
|
|
26681
|
+
is_one_time_use?: boolean | undefined;
|
|
26682
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26683
|
+
card_number?: (string | undefined) | null;
|
|
26684
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
26685
|
+
is_issued?: boolean | undefined;
|
|
26686
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
26687
|
+
issued_at?: (string | undefined) | null;
|
|
26688
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
26689
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
26690
|
+
/** 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`. */
|
|
26691
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
26692
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26693
|
+
external_type_display_name?: string | undefined;
|
|
26694
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
26695
|
+
created_at: string;
|
|
26696
|
+
/** 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). */
|
|
26697
|
+
workspace_id: string;
|
|
26698
|
+
/** 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. */
|
|
26699
|
+
starts_at?: string | undefined;
|
|
26700
|
+
/** 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`. */
|
|
26701
|
+
ends_at?: string | undefined;
|
|
26702
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26703
|
+
errors: Array<{
|
|
26704
|
+
error_code: string;
|
|
26705
|
+
message: string;
|
|
26706
|
+
}>;
|
|
26707
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26708
|
+
warnings: Array<{
|
|
26709
|
+
/** Date and time at which Seam created the warning. */
|
|
26710
|
+
created_at: string;
|
|
26711
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26712
|
+
message: string;
|
|
26713
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26714
|
+
warning_code: 'waiting_to_be_issued';
|
|
26715
|
+
} | {
|
|
26716
|
+
/** Date and time at which Seam created the warning. */
|
|
26717
|
+
created_at: string;
|
|
26718
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26719
|
+
message: string;
|
|
26720
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26721
|
+
warning_code: 'schedule_externally_modified';
|
|
26722
|
+
} | {
|
|
26723
|
+
/** Date and time at which Seam created the warning. */
|
|
26724
|
+
created_at: string;
|
|
26725
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26726
|
+
message: string;
|
|
26727
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26728
|
+
warning_code: 'schedule_modified';
|
|
26729
|
+
} | {
|
|
26730
|
+
/** Date and time at which Seam created the warning. */
|
|
26731
|
+
created_at: string;
|
|
26732
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26733
|
+
message: string;
|
|
26734
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26735
|
+
warning_code: 'being_deleted';
|
|
26736
|
+
} | {
|
|
26737
|
+
/** Date and time at which Seam created the warning. */
|
|
26738
|
+
created_at: string;
|
|
26739
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26740
|
+
message: string;
|
|
26741
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26742
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
26743
|
+
} | {
|
|
26744
|
+
/** Date and time at which Seam created the warning. */
|
|
26745
|
+
created_at: string;
|
|
26746
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26747
|
+
message: string;
|
|
26748
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26749
|
+
warning_code: 'needs_to_be_reissued';
|
|
26750
|
+
}>;
|
|
26751
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
26752
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
26753
|
+
/** 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. */
|
|
26754
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
26755
|
+
/** 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. */
|
|
26756
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
26757
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26758
|
+
visionline_metadata?: {
|
|
26759
|
+
card_function_type: 'guest' | 'staff';
|
|
26760
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
26761
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
26762
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
26763
|
+
is_valid?: boolean | undefined;
|
|
26764
|
+
auto_join?: boolean | undefined;
|
|
26765
|
+
card_id?: string | undefined;
|
|
26766
|
+
credential_id?: string | undefined;
|
|
26767
|
+
} | undefined;
|
|
26768
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26769
|
+
assa_abloy_vostio_metadata?: {
|
|
26770
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
26771
|
+
key_id?: string | undefined;
|
|
26772
|
+
key_issuing_request_id?: string | undefined;
|
|
26773
|
+
door_names?: string[] | undefined;
|
|
26774
|
+
endpoint_id?: string | undefined;
|
|
26775
|
+
} | undefined;
|
|
26776
|
+
is_managed: false;
|
|
26777
|
+
}) | null;
|
|
26778
|
+
warnings: Array<{
|
|
26779
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
26780
|
+
warning_message: string;
|
|
26781
|
+
}>;
|
|
26782
|
+
};
|
|
26783
|
+
} | {
|
|
26784
|
+
/** ID of the action attempt. */
|
|
26785
|
+
action_attempt_id: string;
|
|
26786
|
+
status: 'error';
|
|
26787
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
26788
|
+
result: null;
|
|
26789
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
26790
|
+
error: {
|
|
26791
|
+
/** Type of the error associated with the action attempt. */
|
|
26792
|
+
type: 'uncategorized_error';
|
|
26793
|
+
/** Message for the error associated with the action attempt. */
|
|
26794
|
+
message: string;
|
|
26795
|
+
} | {
|
|
26796
|
+
/** Type of the error associated with the action attempt. */
|
|
26797
|
+
type: 'action_attempt_expired';
|
|
26798
|
+
/** Message for the error associated with the action attempt. */
|
|
26799
|
+
message: string;
|
|
26800
|
+
} | {
|
|
26801
|
+
type: 'no_credential_on_encoder';
|
|
26802
|
+
message: string;
|
|
26803
|
+
};
|
|
26804
|
+
} | {
|
|
26805
|
+
/** ID of the action attempt. */
|
|
26806
|
+
action_attempt_id: string;
|
|
26807
|
+
status: 'pending';
|
|
26808
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26809
|
+
result: null;
|
|
26810
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26811
|
+
error: null;
|
|
26812
|
+
/** Type of action that the action attempt tracks. */
|
|
26813
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
26814
|
+
} | {
|
|
26815
|
+
/** ID of the action attempt. */
|
|
26816
|
+
action_attempt_id: string;
|
|
26817
|
+
status: 'success';
|
|
26818
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26819
|
+
error: null;
|
|
26820
|
+
/** Type of action that the action attempt tracks. */
|
|
26821
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
26822
|
+
/** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
|
|
26823
|
+
result: {
|
|
26824
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26825
|
+
acs_credential_id: string;
|
|
26826
|
+
/** 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. */
|
|
26827
|
+
acs_user_id?: string | undefined;
|
|
26828
|
+
acs_credential_pool_id?: string | undefined;
|
|
26829
|
+
/** 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). */
|
|
26830
|
+
acs_system_id: string;
|
|
26831
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26832
|
+
parent_acs_credential_id?: string | undefined;
|
|
26833
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26834
|
+
display_name: string;
|
|
26835
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26836
|
+
code?: (string | undefined) | null;
|
|
26837
|
+
/** 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. */
|
|
26838
|
+
is_one_time_use?: boolean | undefined;
|
|
26839
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26840
|
+
card_number?: (string | undefined) | null;
|
|
26841
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
26842
|
+
is_issued?: boolean | undefined;
|
|
26843
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
26844
|
+
issued_at?: (string | undefined) | null;
|
|
26845
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
26846
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
26847
|
+
/** 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`. */
|
|
26848
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
26849
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26850
|
+
external_type_display_name?: string | undefined;
|
|
26851
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
26852
|
+
created_at: string;
|
|
26853
|
+
/** 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). */
|
|
26854
|
+
workspace_id: string;
|
|
26855
|
+
/** 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. */
|
|
26856
|
+
starts_at?: string | undefined;
|
|
26857
|
+
/** 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`. */
|
|
26858
|
+
ends_at?: string | undefined;
|
|
26859
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26860
|
+
errors: Array<{
|
|
26861
|
+
error_code: string;
|
|
26862
|
+
message: string;
|
|
26863
|
+
}>;
|
|
26864
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26865
|
+
warnings: Array<{
|
|
26866
|
+
/** Date and time at which Seam created the warning. */
|
|
26867
|
+
created_at: string;
|
|
26868
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26869
|
+
message: string;
|
|
26870
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26871
|
+
warning_code: 'waiting_to_be_issued';
|
|
26872
|
+
} | {
|
|
26873
|
+
/** Date and time at which Seam created the warning. */
|
|
26874
|
+
created_at: string;
|
|
26875
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26876
|
+
message: string;
|
|
26877
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26878
|
+
warning_code: 'schedule_externally_modified';
|
|
26879
|
+
} | {
|
|
26880
|
+
/** Date and time at which Seam created the warning. */
|
|
26881
|
+
created_at: string;
|
|
26882
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26883
|
+
message: string;
|
|
26884
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26885
|
+
warning_code: 'schedule_modified';
|
|
26886
|
+
} | {
|
|
26887
|
+
/** Date and time at which Seam created the warning. */
|
|
26888
|
+
created_at: string;
|
|
26889
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26890
|
+
message: string;
|
|
26891
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26892
|
+
warning_code: 'being_deleted';
|
|
26893
|
+
} | {
|
|
26894
|
+
/** Date and time at which Seam created the warning. */
|
|
26895
|
+
created_at: string;
|
|
26896
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26897
|
+
message: string;
|
|
26898
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26899
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
26900
|
+
} | {
|
|
26901
|
+
/** Date and time at which Seam created the warning. */
|
|
26902
|
+
created_at: string;
|
|
26903
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26904
|
+
message: string;
|
|
26905
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26906
|
+
warning_code: 'needs_to_be_reissued';
|
|
26907
|
+
}>;
|
|
26908
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
26909
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
26910
|
+
/** 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. */
|
|
26911
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
26912
|
+
/** 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. */
|
|
26913
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
26914
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26915
|
+
visionline_metadata?: {
|
|
26916
|
+
card_function_type: 'guest' | 'staff';
|
|
26917
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
26918
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
26919
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
26920
|
+
is_valid?: boolean | undefined;
|
|
26921
|
+
auto_join?: boolean | undefined;
|
|
26922
|
+
card_id?: string | undefined;
|
|
26923
|
+
credential_id?: string | undefined;
|
|
26924
|
+
} | undefined;
|
|
26925
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26926
|
+
assa_abloy_vostio_metadata?: {
|
|
26927
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
26928
|
+
key_id?: string | undefined;
|
|
26929
|
+
key_issuing_request_id?: string | undefined;
|
|
26930
|
+
door_names?: string[] | undefined;
|
|
26931
|
+
endpoint_id?: string | undefined;
|
|
26932
|
+
} | undefined;
|
|
26933
|
+
is_managed: true;
|
|
26934
|
+
} | {
|
|
26935
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26936
|
+
acs_credential_id: string;
|
|
26937
|
+
/** 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. */
|
|
26938
|
+
acs_user_id?: string | undefined;
|
|
26939
|
+
acs_credential_pool_id?: string | undefined;
|
|
26940
|
+
/** 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). */
|
|
26941
|
+
acs_system_id: string;
|
|
26942
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26943
|
+
parent_acs_credential_id?: string | undefined;
|
|
26944
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26945
|
+
display_name: string;
|
|
26946
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26947
|
+
code?: (string | undefined) | null;
|
|
26948
|
+
/** 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. */
|
|
26949
|
+
is_one_time_use?: boolean | undefined;
|
|
26950
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26951
|
+
card_number?: (string | undefined) | null;
|
|
26952
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
26953
|
+
is_issued?: boolean | undefined;
|
|
26954
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
26955
|
+
issued_at?: (string | undefined) | null;
|
|
26956
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
26957
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
26958
|
+
/** 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`. */
|
|
26959
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
26960
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
26961
|
+
external_type_display_name?: string | undefined;
|
|
26962
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
26963
|
+
created_at: string;
|
|
26964
|
+
/** 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). */
|
|
26965
|
+
workspace_id: string;
|
|
26966
|
+
/** 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. */
|
|
26967
|
+
starts_at?: string | undefined;
|
|
26968
|
+
/** 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`. */
|
|
26969
|
+
ends_at?: string | undefined;
|
|
26970
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26971
|
+
errors: Array<{
|
|
26972
|
+
error_code: string;
|
|
26973
|
+
message: string;
|
|
26974
|
+
}>;
|
|
26975
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
26976
|
+
warnings: Array<{
|
|
26977
|
+
/** Date and time at which Seam created the warning. */
|
|
26978
|
+
created_at: string;
|
|
26979
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26980
|
+
message: string;
|
|
26981
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26982
|
+
warning_code: 'waiting_to_be_issued';
|
|
26983
|
+
} | {
|
|
26984
|
+
/** Date and time at which Seam created the warning. */
|
|
26985
|
+
created_at: string;
|
|
26986
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26987
|
+
message: string;
|
|
26988
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26989
|
+
warning_code: 'schedule_externally_modified';
|
|
26990
|
+
} | {
|
|
26991
|
+
/** Date and time at which Seam created the warning. */
|
|
26992
|
+
created_at: string;
|
|
26993
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
26994
|
+
message: string;
|
|
26995
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
26996
|
+
warning_code: 'schedule_modified';
|
|
26997
|
+
} | {
|
|
26998
|
+
/** Date and time at which Seam created the warning. */
|
|
26999
|
+
created_at: string;
|
|
27000
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27001
|
+
message: string;
|
|
27002
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27003
|
+
warning_code: 'being_deleted';
|
|
27004
|
+
} | {
|
|
27005
|
+
/** Date and time at which Seam created the warning. */
|
|
27006
|
+
created_at: string;
|
|
27007
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27008
|
+
message: string;
|
|
27009
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27010
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
27011
|
+
} | {
|
|
27012
|
+
/** Date and time at which Seam created the warning. */
|
|
27013
|
+
created_at: string;
|
|
27014
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27015
|
+
message: string;
|
|
27016
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27017
|
+
warning_code: 'needs_to_be_reissued';
|
|
27018
|
+
}>;
|
|
27019
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
27020
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
27021
|
+
/** 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. */
|
|
27022
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
27023
|
+
/** 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. */
|
|
27024
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
27025
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27026
|
+
visionline_metadata?: {
|
|
27027
|
+
card_function_type: 'guest' | 'staff';
|
|
27028
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
27029
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
27030
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
27031
|
+
is_valid?: boolean | undefined;
|
|
27032
|
+
auto_join?: boolean | undefined;
|
|
27033
|
+
card_id?: string | undefined;
|
|
27034
|
+
credential_id?: string | undefined;
|
|
27035
|
+
} | undefined;
|
|
27036
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27037
|
+
assa_abloy_vostio_metadata?: {
|
|
27038
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
27039
|
+
key_id?: string | undefined;
|
|
27040
|
+
key_issuing_request_id?: string | undefined;
|
|
27041
|
+
door_names?: string[] | undefined;
|
|
27042
|
+
endpoint_id?: string | undefined;
|
|
27043
|
+
} | undefined;
|
|
27044
|
+
is_managed: false;
|
|
27045
|
+
};
|
|
27046
|
+
} | {
|
|
27047
|
+
/** ID of the action attempt. */
|
|
27048
|
+
action_attempt_id: string;
|
|
27049
|
+
status: 'error';
|
|
27050
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27051
|
+
result: null;
|
|
27052
|
+
/** Type of action that the action attempt tracks. */
|
|
27053
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
27054
|
+
error: {
|
|
27055
|
+
/** Type of the error associated with the action attempt. */
|
|
27056
|
+
type: 'uncategorized_error';
|
|
27057
|
+
/** Message for the error associated with the action attempt. */
|
|
27058
|
+
message: string;
|
|
27059
|
+
} | {
|
|
27060
|
+
/** Type of the error associated with the action attempt. */
|
|
27061
|
+
type: 'action_attempt_expired';
|
|
27062
|
+
/** Message for the error associated with the action attempt. */
|
|
27063
|
+
message: string;
|
|
27064
|
+
} | {
|
|
27065
|
+
type: 'no_credential_on_encoder';
|
|
27066
|
+
message: string;
|
|
27067
|
+
} | {
|
|
27068
|
+
type: 'incompatible_card_format';
|
|
27069
|
+
message: string;
|
|
27070
|
+
} | {
|
|
27071
|
+
type: 'credential_cannot_be_reissued';
|
|
27072
|
+
message: string;
|
|
27073
|
+
};
|
|
27074
|
+
} | {
|
|
27075
|
+
/** ID of the action attempt. */
|
|
27076
|
+
action_attempt_id: string;
|
|
27077
|
+
status: 'pending';
|
|
27078
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27079
|
+
result: null;
|
|
27080
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27081
|
+
error: null;
|
|
27082
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
27083
|
+
} | {
|
|
27084
|
+
/** ID of the action attempt. */
|
|
27085
|
+
action_attempt_id: string;
|
|
27086
|
+
status: 'success';
|
|
27087
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27088
|
+
error: null;
|
|
27089
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
27090
|
+
result: {};
|
|
27091
|
+
} | {
|
|
27092
|
+
/** ID of the action attempt. */
|
|
27093
|
+
action_attempt_id: string;
|
|
27094
|
+
status: 'error';
|
|
27095
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27096
|
+
result: null;
|
|
27097
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
27098
|
+
error: {
|
|
27099
|
+
type: string;
|
|
27100
|
+
message: string;
|
|
27101
|
+
};
|
|
27102
|
+
} | {
|
|
27103
|
+
/** ID of the action attempt. */
|
|
27104
|
+
action_attempt_id: string;
|
|
27105
|
+
status: 'pending';
|
|
27106
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27107
|
+
result: null;
|
|
27108
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27109
|
+
error: null;
|
|
27110
|
+
action_type: 'SET_FAN_MODE';
|
|
27111
|
+
} | {
|
|
27112
|
+
/** ID of the action attempt. */
|
|
27113
|
+
action_attempt_id: string;
|
|
27114
|
+
status: 'success';
|
|
27115
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27116
|
+
error: null;
|
|
27117
|
+
action_type: 'SET_FAN_MODE';
|
|
27118
|
+
result: {};
|
|
27119
|
+
} | {
|
|
27120
|
+
/** ID of the action attempt. */
|
|
27121
|
+
action_attempt_id: string;
|
|
27122
|
+
status: 'error';
|
|
27123
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27124
|
+
result: null;
|
|
27125
|
+
action_type: 'SET_FAN_MODE';
|
|
27126
|
+
error: {
|
|
27127
|
+
type: string;
|
|
27128
|
+
message: string;
|
|
27129
|
+
};
|
|
27130
|
+
} | {
|
|
27131
|
+
/** ID of the action attempt. */
|
|
27132
|
+
action_attempt_id: string;
|
|
27133
|
+
status: 'pending';
|
|
27134
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27135
|
+
result: null;
|
|
27136
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27137
|
+
error: null;
|
|
27138
|
+
action_type: 'SET_HVAC_MODE';
|
|
27139
|
+
} | {
|
|
27140
|
+
/** ID of the action attempt. */
|
|
27141
|
+
action_attempt_id: string;
|
|
27142
|
+
status: 'success';
|
|
27143
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27144
|
+
error: null;
|
|
27145
|
+
action_type: 'SET_HVAC_MODE';
|
|
27146
|
+
result: {};
|
|
27147
|
+
} | {
|
|
27148
|
+
/** ID of the action attempt. */
|
|
27149
|
+
action_attempt_id: string;
|
|
27150
|
+
status: 'error';
|
|
27151
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27152
|
+
result: null;
|
|
27153
|
+
action_type: 'SET_HVAC_MODE';
|
|
27154
|
+
error: {
|
|
27155
|
+
type: string;
|
|
27156
|
+
message: string;
|
|
27157
|
+
};
|
|
27158
|
+
} | {
|
|
27159
|
+
/** ID of the action attempt. */
|
|
27160
|
+
action_attempt_id: string;
|
|
27161
|
+
status: 'pending';
|
|
27162
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27163
|
+
result: null;
|
|
27164
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27165
|
+
error: null;
|
|
27166
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
27167
|
+
} | {
|
|
27168
|
+
/** ID of the action attempt. */
|
|
27169
|
+
action_attempt_id: string;
|
|
27170
|
+
status: 'success';
|
|
27171
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27172
|
+
error: null;
|
|
27173
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
27174
|
+
result: {};
|
|
27175
|
+
} | {
|
|
27176
|
+
/** ID of the action attempt. */
|
|
27177
|
+
action_attempt_id: string;
|
|
27178
|
+
status: 'error';
|
|
27179
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27180
|
+
result: null;
|
|
27181
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
27182
|
+
error: {
|
|
27183
|
+
type: string;
|
|
27184
|
+
message: string;
|
|
27185
|
+
};
|
|
27186
|
+
} | {
|
|
27187
|
+
/** ID of the action attempt. */
|
|
27188
|
+
action_attempt_id: string;
|
|
27189
|
+
status: 'pending';
|
|
27190
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27191
|
+
result: null;
|
|
27192
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27193
|
+
error: null;
|
|
27194
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
27195
|
+
} | {
|
|
27196
|
+
/** ID of the action attempt. */
|
|
27197
|
+
action_attempt_id: string;
|
|
27198
|
+
status: 'success';
|
|
27199
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27200
|
+
error: null;
|
|
27201
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
27202
|
+
result: {};
|
|
27203
|
+
} | {
|
|
27204
|
+
/** ID of the action attempt. */
|
|
27205
|
+
action_attempt_id: string;
|
|
27206
|
+
status: 'error';
|
|
27207
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27208
|
+
result: null;
|
|
27209
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
27210
|
+
error: {
|
|
27211
|
+
type: string;
|
|
27212
|
+
message: string;
|
|
27213
|
+
};
|
|
27214
|
+
} | {
|
|
27215
|
+
/** ID of the action attempt. */
|
|
27216
|
+
action_attempt_id: string;
|
|
27217
|
+
status: 'pending';
|
|
27218
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27219
|
+
result: null;
|
|
27220
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27221
|
+
error: null;
|
|
27222
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
27223
|
+
} | {
|
|
27224
|
+
/** ID of the action attempt. */
|
|
27225
|
+
action_attempt_id: string;
|
|
27226
|
+
status: 'success';
|
|
27227
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27228
|
+
error: null;
|
|
27229
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
27230
|
+
result: {};
|
|
27231
|
+
} | {
|
|
27232
|
+
/** ID of the action attempt. */
|
|
27233
|
+
action_attempt_id: string;
|
|
27234
|
+
status: 'error';
|
|
27235
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27236
|
+
result: null;
|
|
27237
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
27238
|
+
error: {
|
|
27239
|
+
type: string;
|
|
27240
|
+
message: string;
|
|
27241
|
+
};
|
|
27242
|
+
} | {
|
|
27243
|
+
/** ID of the action attempt. */
|
|
27244
|
+
action_attempt_id: string;
|
|
27245
|
+
status: 'pending';
|
|
27246
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27247
|
+
result: null;
|
|
27248
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27249
|
+
error: null;
|
|
27250
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
27251
|
+
} | {
|
|
27252
|
+
/** ID of the action attempt. */
|
|
27253
|
+
action_attempt_id: string;
|
|
27254
|
+
status: 'success';
|
|
27255
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27256
|
+
error: null;
|
|
27257
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
27258
|
+
result: {};
|
|
27259
|
+
} | {
|
|
27260
|
+
/** ID of the action attempt. */
|
|
27261
|
+
action_attempt_id: string;
|
|
27262
|
+
status: 'error';
|
|
27263
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27264
|
+
result: null;
|
|
27265
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
27266
|
+
error: {
|
|
27267
|
+
type: string;
|
|
27268
|
+
message: string;
|
|
27269
|
+
};
|
|
27270
|
+
} | {
|
|
27271
|
+
/** ID of the action attempt. */
|
|
27272
|
+
action_attempt_id: string;
|
|
27273
|
+
status: 'pending';
|
|
27274
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27275
|
+
result: null;
|
|
27276
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27277
|
+
error: null;
|
|
27278
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
27279
|
+
} | {
|
|
27280
|
+
/** ID of the action attempt. */
|
|
27281
|
+
action_attempt_id: string;
|
|
27282
|
+
status: 'success';
|
|
27283
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27284
|
+
error: null;
|
|
27285
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
27286
|
+
result: {
|
|
27287
|
+
access_code?: any;
|
|
27288
|
+
};
|
|
27289
|
+
} | {
|
|
27290
|
+
/** ID of the action attempt. */
|
|
27291
|
+
action_attempt_id: string;
|
|
27292
|
+
status: 'error';
|
|
27293
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27294
|
+
result: null;
|
|
27295
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
27296
|
+
error: {
|
|
27297
|
+
type: string;
|
|
27298
|
+
message: string;
|
|
27299
|
+
};
|
|
27300
|
+
} | {
|
|
27301
|
+
/** ID of the action attempt. */
|
|
27302
|
+
action_attempt_id: string;
|
|
27303
|
+
status: 'pending';
|
|
27304
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27305
|
+
result: null;
|
|
27306
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27307
|
+
error: null;
|
|
27308
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
27309
|
+
} | {
|
|
27310
|
+
/** ID of the action attempt. */
|
|
27311
|
+
action_attempt_id: string;
|
|
27312
|
+
status: 'success';
|
|
27313
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27314
|
+
error: null;
|
|
27315
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
27316
|
+
result: {};
|
|
27317
|
+
} | {
|
|
27318
|
+
/** ID of the action attempt. */
|
|
27319
|
+
action_attempt_id: string;
|
|
27320
|
+
status: 'error';
|
|
27321
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27322
|
+
result: null;
|
|
27323
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
27324
|
+
error: {
|
|
27325
|
+
type: string;
|
|
27326
|
+
message: string;
|
|
27327
|
+
};
|
|
27328
|
+
} | {
|
|
27329
|
+
/** ID of the action attempt. */
|
|
27330
|
+
action_attempt_id: string;
|
|
27331
|
+
status: 'pending';
|
|
27332
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27333
|
+
result: null;
|
|
27334
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27335
|
+
error: null;
|
|
27336
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
27337
|
+
} | {
|
|
27338
|
+
/** ID of the action attempt. */
|
|
27339
|
+
action_attempt_id: string;
|
|
27340
|
+
status: 'success';
|
|
27341
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27342
|
+
error: null;
|
|
27343
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
27344
|
+
result: {
|
|
27345
|
+
access_code?: any;
|
|
27346
|
+
};
|
|
27347
|
+
} | {
|
|
27348
|
+
/** ID of the action attempt. */
|
|
27349
|
+
action_attempt_id: string;
|
|
27350
|
+
status: 'error';
|
|
27351
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27352
|
+
result: null;
|
|
27353
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
27354
|
+
error: {
|
|
27355
|
+
type: string;
|
|
27356
|
+
message: string;
|
|
27357
|
+
};
|
|
27358
|
+
} | {
|
|
27359
|
+
/** ID of the action attempt. */
|
|
27360
|
+
action_attempt_id: string;
|
|
27361
|
+
status: 'pending';
|
|
27362
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27363
|
+
result: null;
|
|
27364
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27365
|
+
error: null;
|
|
27366
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
27367
|
+
} | {
|
|
27368
|
+
/** ID of the action attempt. */
|
|
27369
|
+
action_attempt_id: string;
|
|
27370
|
+
status: 'success';
|
|
27371
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27372
|
+
error: null;
|
|
27373
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
27374
|
+
result: {
|
|
27375
|
+
noise_threshold?: any;
|
|
27376
|
+
};
|
|
27377
|
+
} | {
|
|
27378
|
+
/** ID of the action attempt. */
|
|
27379
|
+
action_attempt_id: string;
|
|
27380
|
+
status: 'error';
|
|
27381
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27382
|
+
result: null;
|
|
27383
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
27384
|
+
error: {
|
|
27385
|
+
type: string;
|
|
27386
|
+
message: string;
|
|
27387
|
+
};
|
|
27388
|
+
} | {
|
|
27389
|
+
/** ID of the action attempt. */
|
|
27390
|
+
action_attempt_id: string;
|
|
27391
|
+
status: 'pending';
|
|
27392
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27393
|
+
result: null;
|
|
27394
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27395
|
+
error: null;
|
|
27396
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
27397
|
+
} | {
|
|
27398
|
+
/** ID of the action attempt. */
|
|
27399
|
+
action_attempt_id: string;
|
|
27400
|
+
status: 'success';
|
|
27401
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27402
|
+
error: null;
|
|
27403
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
27404
|
+
result: {};
|
|
27405
|
+
} | {
|
|
27406
|
+
/** ID of the action attempt. */
|
|
27407
|
+
action_attempt_id: string;
|
|
27408
|
+
status: 'error';
|
|
27409
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27410
|
+
result: null;
|
|
27411
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
27412
|
+
error: {
|
|
27413
|
+
type: string;
|
|
27414
|
+
message: string;
|
|
27415
|
+
};
|
|
27416
|
+
} | {
|
|
27417
|
+
/** ID of the action attempt. */
|
|
27418
|
+
action_attempt_id: string;
|
|
27419
|
+
status: 'pending';
|
|
27420
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27421
|
+
result: null;
|
|
27422
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27423
|
+
error: null;
|
|
27424
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
27425
|
+
} | {
|
|
27426
|
+
/** ID of the action attempt. */
|
|
27427
|
+
action_attempt_id: string;
|
|
27428
|
+
status: 'success';
|
|
27429
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27430
|
+
error: null;
|
|
27431
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
27432
|
+
result: {
|
|
27433
|
+
noise_threshold?: any;
|
|
27434
|
+
};
|
|
27435
|
+
} | {
|
|
27436
|
+
/** ID of the action attempt. */
|
|
27437
|
+
action_attempt_id: string;
|
|
27438
|
+
status: 'error';
|
|
27439
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27440
|
+
result: null;
|
|
27441
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
27442
|
+
error: {
|
|
27443
|
+
type: string;
|
|
27444
|
+
message: string;
|
|
27445
|
+
};
|
|
27446
|
+
};
|
|
27447
|
+
};
|
|
27448
|
+
};
|
|
27449
|
+
'/locks/unlock_door': {
|
|
27450
|
+
route: '/locks/unlock_door';
|
|
27451
|
+
method: 'POST';
|
|
27452
|
+
queryParams: {};
|
|
27453
|
+
jsonBody: {
|
|
27454
|
+
device_id: string;
|
|
27455
|
+
sync?: boolean;
|
|
27456
|
+
};
|
|
27457
|
+
commonParams: {};
|
|
27458
|
+
formData: {};
|
|
27459
|
+
jsonResponse: {
|
|
27460
|
+
/** */
|
|
27461
|
+
action_attempt: {
|
|
27462
|
+
/** ID of the action attempt. */
|
|
27463
|
+
action_attempt_id: string;
|
|
27464
|
+
status: 'pending';
|
|
27465
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27466
|
+
result: null;
|
|
27467
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27468
|
+
error: null;
|
|
27469
|
+
action_type: 'LOCK_DOOR';
|
|
27470
|
+
} | {
|
|
27471
|
+
/** ID of the action attempt. */
|
|
27472
|
+
action_attempt_id: string;
|
|
27473
|
+
status: 'success';
|
|
27474
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27475
|
+
error: null;
|
|
27476
|
+
action_type: 'LOCK_DOOR';
|
|
27477
|
+
result: {};
|
|
27478
|
+
} | {
|
|
27479
|
+
/** ID of the action attempt. */
|
|
27480
|
+
action_attempt_id: string;
|
|
27481
|
+
status: 'error';
|
|
27482
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27483
|
+
result: null;
|
|
27484
|
+
action_type: 'LOCK_DOOR';
|
|
27485
|
+
error: {
|
|
27486
|
+
type: string;
|
|
27487
|
+
message: string;
|
|
27488
|
+
};
|
|
27489
|
+
} | {
|
|
27490
|
+
/** ID of the action attempt. */
|
|
27491
|
+
action_attempt_id: string;
|
|
27492
|
+
status: 'pending';
|
|
27493
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27494
|
+
result: null;
|
|
27495
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27496
|
+
error: null;
|
|
27497
|
+
action_type: 'UNLOCK_DOOR';
|
|
27498
|
+
} | {
|
|
27499
|
+
/** ID of the action attempt. */
|
|
27500
|
+
action_attempt_id: string;
|
|
27501
|
+
status: 'success';
|
|
27502
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27503
|
+
error: null;
|
|
27504
|
+
action_type: 'UNLOCK_DOOR';
|
|
27505
|
+
result: {};
|
|
27506
|
+
} | {
|
|
27507
|
+
/** ID of the action attempt. */
|
|
27508
|
+
action_attempt_id: string;
|
|
27509
|
+
status: 'error';
|
|
27510
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27511
|
+
result: null;
|
|
27512
|
+
action_type: 'UNLOCK_DOOR';
|
|
27513
|
+
error: {
|
|
27514
|
+
type: string;
|
|
27515
|
+
message: string;
|
|
27516
|
+
};
|
|
27517
|
+
} | {
|
|
27518
|
+
/** ID of the action attempt. */
|
|
27519
|
+
action_attempt_id: string;
|
|
27520
|
+
status: 'pending';
|
|
27521
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27522
|
+
result: null;
|
|
27523
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27524
|
+
error: null;
|
|
27525
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
27526
|
+
} | {
|
|
27527
|
+
/** ID of the action attempt. */
|
|
27528
|
+
action_attempt_id: string;
|
|
27529
|
+
status: 'success';
|
|
27530
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27531
|
+
error: null;
|
|
27532
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
27533
|
+
result: {
|
|
27534
|
+
/** Snapshot of credential data read from physical encoder. */
|
|
27535
|
+
acs_credential_on_encoder: {
|
|
27536
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
27537
|
+
created_at: string | null;
|
|
27538
|
+
is_issued: boolean | null;
|
|
27539
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
27540
|
+
starts_at: string | null;
|
|
27541
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
27542
|
+
ends_at: string | null;
|
|
27543
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27544
|
+
card_number: string | null;
|
|
27545
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27546
|
+
visionline_metadata?: {
|
|
27547
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27548
|
+
card_id: string;
|
|
27549
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
27550
|
+
cancelled: boolean;
|
|
27551
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
27552
|
+
discarded: boolean;
|
|
27553
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
27554
|
+
expired: boolean;
|
|
27555
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
27556
|
+
overwritten: boolean;
|
|
27557
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
27558
|
+
overridden?: boolean | undefined;
|
|
27559
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
27560
|
+
pending_auto_update: boolean;
|
|
27561
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27562
|
+
card_format: 'TLCode' | 'rfid48';
|
|
27563
|
+
/** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27564
|
+
card_holder?: string | undefined;
|
|
27565
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27566
|
+
number_of_issued_cards: number;
|
|
27567
|
+
/** 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). */
|
|
27568
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
27569
|
+
/** 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). */
|
|
27570
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
27571
|
+
} | undefined;
|
|
27572
|
+
} | null;
|
|
27573
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
27574
|
+
acs_credential_on_seam: ({
|
|
27575
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27576
|
+
acs_credential_id: string;
|
|
27577
|
+
/** 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. */
|
|
27578
|
+
acs_user_id?: string | undefined;
|
|
27579
|
+
acs_credential_pool_id?: string | undefined;
|
|
27580
|
+
/** 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). */
|
|
27581
|
+
acs_system_id: string;
|
|
27582
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27583
|
+
parent_acs_credential_id?: string | undefined;
|
|
27584
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27585
|
+
display_name: string;
|
|
27586
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27587
|
+
code?: (string | undefined) | null;
|
|
27588
|
+
/** 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. */
|
|
27589
|
+
is_one_time_use?: boolean | undefined;
|
|
27590
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27591
|
+
card_number?: (string | undefined) | null;
|
|
27592
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
27593
|
+
is_issued?: boolean | undefined;
|
|
27594
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
27595
|
+
issued_at?: (string | undefined) | null;
|
|
27596
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
27597
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
27598
|
+
/** 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`. */
|
|
27599
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
27600
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27601
|
+
external_type_display_name?: string | undefined;
|
|
27602
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
27603
|
+
created_at: string;
|
|
27604
|
+
/** 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). */
|
|
27605
|
+
workspace_id: string;
|
|
27606
|
+
/** 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. */
|
|
27607
|
+
starts_at?: string | undefined;
|
|
27608
|
+
/** 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`. */
|
|
27609
|
+
ends_at?: string | undefined;
|
|
27610
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27611
|
+
errors: Array<{
|
|
27612
|
+
error_code: string;
|
|
27613
|
+
message: string;
|
|
27614
|
+
}>;
|
|
27615
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27616
|
+
warnings: Array<{
|
|
27617
|
+
/** Date and time at which Seam created the warning. */
|
|
27618
|
+
created_at: string;
|
|
27619
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27620
|
+
message: string;
|
|
27621
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27622
|
+
warning_code: 'waiting_to_be_issued';
|
|
27623
|
+
} | {
|
|
27624
|
+
/** Date and time at which Seam created the warning. */
|
|
27625
|
+
created_at: string;
|
|
27626
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27627
|
+
message: string;
|
|
27628
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27629
|
+
warning_code: 'schedule_externally_modified';
|
|
27630
|
+
} | {
|
|
27631
|
+
/** Date and time at which Seam created the warning. */
|
|
27632
|
+
created_at: string;
|
|
27633
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27634
|
+
message: string;
|
|
27635
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27636
|
+
warning_code: 'schedule_modified';
|
|
27637
|
+
} | {
|
|
27638
|
+
/** Date and time at which Seam created the warning. */
|
|
27639
|
+
created_at: string;
|
|
27640
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27641
|
+
message: string;
|
|
27642
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27643
|
+
warning_code: 'being_deleted';
|
|
27644
|
+
} | {
|
|
27645
|
+
/** Date and time at which Seam created the warning. */
|
|
27646
|
+
created_at: string;
|
|
27647
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27648
|
+
message: string;
|
|
27649
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27650
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
27651
|
+
} | {
|
|
27652
|
+
/** Date and time at which Seam created the warning. */
|
|
27653
|
+
created_at: string;
|
|
27654
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27655
|
+
message: string;
|
|
27656
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27657
|
+
warning_code: 'needs_to_be_reissued';
|
|
27658
|
+
}>;
|
|
27659
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
27660
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
27661
|
+
/** 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. */
|
|
27662
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
27663
|
+
/** 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. */
|
|
27664
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
27665
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27666
|
+
visionline_metadata?: {
|
|
27667
|
+
card_function_type: 'guest' | 'staff';
|
|
27668
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
27669
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
27670
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
27671
|
+
is_valid?: boolean | undefined;
|
|
27672
|
+
auto_join?: boolean | undefined;
|
|
27673
|
+
card_id?: string | undefined;
|
|
27674
|
+
credential_id?: string | undefined;
|
|
27675
|
+
} | undefined;
|
|
27676
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27677
|
+
assa_abloy_vostio_metadata?: {
|
|
27678
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
27679
|
+
key_id?: string | undefined;
|
|
27680
|
+
key_issuing_request_id?: string | undefined;
|
|
27681
|
+
door_names?: string[] | undefined;
|
|
27682
|
+
endpoint_id?: string | undefined;
|
|
27683
|
+
} | undefined;
|
|
27684
|
+
is_managed: true;
|
|
27685
|
+
} | {
|
|
27686
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27687
|
+
acs_credential_id: string;
|
|
27688
|
+
/** 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. */
|
|
27689
|
+
acs_user_id?: string | undefined;
|
|
27690
|
+
acs_credential_pool_id?: string | undefined;
|
|
27691
|
+
/** 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). */
|
|
27692
|
+
acs_system_id: string;
|
|
27693
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27694
|
+
parent_acs_credential_id?: string | undefined;
|
|
27695
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27696
|
+
display_name: string;
|
|
27697
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27698
|
+
code?: (string | undefined) | null;
|
|
27699
|
+
/** 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. */
|
|
27700
|
+
is_one_time_use?: boolean | undefined;
|
|
27701
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27702
|
+
card_number?: (string | undefined) | null;
|
|
27703
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
27704
|
+
is_issued?: boolean | undefined;
|
|
27705
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
27706
|
+
issued_at?: (string | undefined) | null;
|
|
27707
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
27708
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
27709
|
+
/** 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`. */
|
|
27710
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
27711
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27712
|
+
external_type_display_name?: string | undefined;
|
|
27713
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
27714
|
+
created_at: string;
|
|
27715
|
+
/** 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). */
|
|
27716
|
+
workspace_id: string;
|
|
27717
|
+
/** 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. */
|
|
27718
|
+
starts_at?: string | undefined;
|
|
27719
|
+
/** 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`. */
|
|
27720
|
+
ends_at?: string | undefined;
|
|
27721
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27722
|
+
errors: Array<{
|
|
27723
|
+
error_code: string;
|
|
27724
|
+
message: string;
|
|
27725
|
+
}>;
|
|
27726
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27727
|
+
warnings: Array<{
|
|
27728
|
+
/** Date and time at which Seam created the warning. */
|
|
27729
|
+
created_at: string;
|
|
27730
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27731
|
+
message: string;
|
|
27732
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27733
|
+
warning_code: 'waiting_to_be_issued';
|
|
27734
|
+
} | {
|
|
27735
|
+
/** Date and time at which Seam created the warning. */
|
|
27736
|
+
created_at: string;
|
|
27737
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27738
|
+
message: string;
|
|
27739
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27740
|
+
warning_code: 'schedule_externally_modified';
|
|
27741
|
+
} | {
|
|
27742
|
+
/** Date and time at which Seam created the warning. */
|
|
27743
|
+
created_at: string;
|
|
27744
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27745
|
+
message: string;
|
|
27746
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27747
|
+
warning_code: 'schedule_modified';
|
|
27748
|
+
} | {
|
|
27749
|
+
/** Date and time at which Seam created the warning. */
|
|
27750
|
+
created_at: string;
|
|
27751
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27752
|
+
message: string;
|
|
27753
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27754
|
+
warning_code: 'being_deleted';
|
|
27755
|
+
} | {
|
|
27756
|
+
/** Date and time at which Seam created the warning. */
|
|
27757
|
+
created_at: string;
|
|
27758
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27759
|
+
message: string;
|
|
27760
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27761
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
27762
|
+
} | {
|
|
27763
|
+
/** Date and time at which Seam created the warning. */
|
|
27764
|
+
created_at: string;
|
|
27765
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27766
|
+
message: string;
|
|
27767
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27768
|
+
warning_code: 'needs_to_be_reissued';
|
|
27769
|
+
}>;
|
|
27770
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
27771
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
27772
|
+
/** 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. */
|
|
27773
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
27774
|
+
/** 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. */
|
|
27775
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
27776
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27777
|
+
visionline_metadata?: {
|
|
27778
|
+
card_function_type: 'guest' | 'staff';
|
|
27779
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
27780
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
27781
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
27782
|
+
is_valid?: boolean | undefined;
|
|
27783
|
+
auto_join?: boolean | undefined;
|
|
27784
|
+
card_id?: string | undefined;
|
|
27785
|
+
credential_id?: string | undefined;
|
|
27786
|
+
} | undefined;
|
|
27787
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27788
|
+
assa_abloy_vostio_metadata?: {
|
|
27789
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
27790
|
+
key_id?: string | undefined;
|
|
27791
|
+
key_issuing_request_id?: string | undefined;
|
|
27792
|
+
door_names?: string[] | undefined;
|
|
27793
|
+
endpoint_id?: string | undefined;
|
|
27794
|
+
} | undefined;
|
|
27795
|
+
is_managed: false;
|
|
27796
|
+
}) | null;
|
|
27797
|
+
warnings: Array<{
|
|
27798
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
27799
|
+
warning_message: string;
|
|
27800
|
+
}>;
|
|
27801
|
+
};
|
|
27802
|
+
} | {
|
|
27803
|
+
/** ID of the action attempt. */
|
|
27804
|
+
action_attempt_id: string;
|
|
27805
|
+
status: 'error';
|
|
27806
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27807
|
+
result: null;
|
|
27808
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
27809
|
+
error: {
|
|
27810
|
+
/** Type of the error associated with the action attempt. */
|
|
27811
|
+
type: 'uncategorized_error';
|
|
27812
|
+
/** Message for the error associated with the action attempt. */
|
|
27813
|
+
message: string;
|
|
27814
|
+
} | {
|
|
27815
|
+
/** Type of the error associated with the action attempt. */
|
|
27816
|
+
type: 'action_attempt_expired';
|
|
27817
|
+
/** Message for the error associated with the action attempt. */
|
|
27818
|
+
message: string;
|
|
27819
|
+
} | {
|
|
27820
|
+
type: 'no_credential_on_encoder';
|
|
27821
|
+
message: string;
|
|
27822
|
+
};
|
|
27823
|
+
} | {
|
|
27824
|
+
/** ID of the action attempt. */
|
|
27825
|
+
action_attempt_id: string;
|
|
27826
|
+
status: 'pending';
|
|
27827
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27828
|
+
result: null;
|
|
27829
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27830
|
+
error: null;
|
|
27831
|
+
/** Type of action that the action attempt tracks. */
|
|
27832
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
27833
|
+
} | {
|
|
27834
|
+
/** ID of the action attempt. */
|
|
27835
|
+
action_attempt_id: string;
|
|
27836
|
+
status: 'success';
|
|
27837
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27838
|
+
error: null;
|
|
27839
|
+
/** Type of action that the action attempt tracks. */
|
|
27840
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
27841
|
+
/** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
|
|
27842
|
+
result: {
|
|
27843
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27844
|
+
acs_credential_id: string;
|
|
27845
|
+
/** 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. */
|
|
27846
|
+
acs_user_id?: string | undefined;
|
|
27847
|
+
acs_credential_pool_id?: string | undefined;
|
|
27848
|
+
/** 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). */
|
|
27849
|
+
acs_system_id: string;
|
|
27850
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27851
|
+
parent_acs_credential_id?: string | undefined;
|
|
27852
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27853
|
+
display_name: string;
|
|
27854
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27855
|
+
code?: (string | undefined) | null;
|
|
27856
|
+
/** 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. */
|
|
27857
|
+
is_one_time_use?: boolean | undefined;
|
|
27858
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27859
|
+
card_number?: (string | undefined) | null;
|
|
27860
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
27861
|
+
is_issued?: boolean | undefined;
|
|
27862
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
27863
|
+
issued_at?: (string | undefined) | null;
|
|
27864
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
27865
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
27866
|
+
/** 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`. */
|
|
27867
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
27868
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27869
|
+
external_type_display_name?: string | undefined;
|
|
27870
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
27871
|
+
created_at: string;
|
|
27872
|
+
/** 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). */
|
|
27873
|
+
workspace_id: string;
|
|
27874
|
+
/** 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. */
|
|
27875
|
+
starts_at?: string | undefined;
|
|
27876
|
+
/** 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`. */
|
|
27877
|
+
ends_at?: string | undefined;
|
|
27878
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27879
|
+
errors: Array<{
|
|
27880
|
+
error_code: string;
|
|
27881
|
+
message: string;
|
|
27882
|
+
}>;
|
|
27883
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27884
|
+
warnings: Array<{
|
|
27885
|
+
/** Date and time at which Seam created the warning. */
|
|
27886
|
+
created_at: string;
|
|
27887
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27888
|
+
message: string;
|
|
27889
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27890
|
+
warning_code: 'waiting_to_be_issued';
|
|
27891
|
+
} | {
|
|
27892
|
+
/** Date and time at which Seam created the warning. */
|
|
27893
|
+
created_at: string;
|
|
27894
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27895
|
+
message: string;
|
|
27896
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27897
|
+
warning_code: 'schedule_externally_modified';
|
|
27898
|
+
} | {
|
|
27899
|
+
/** Date and time at which Seam created the warning. */
|
|
27900
|
+
created_at: string;
|
|
27901
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27902
|
+
message: string;
|
|
27903
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27904
|
+
warning_code: 'schedule_modified';
|
|
27905
|
+
} | {
|
|
27906
|
+
/** Date and time at which Seam created the warning. */
|
|
27907
|
+
created_at: string;
|
|
27908
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27909
|
+
message: string;
|
|
27910
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27911
|
+
warning_code: 'being_deleted';
|
|
27912
|
+
} | {
|
|
27913
|
+
/** Date and time at which Seam created the warning. */
|
|
27914
|
+
created_at: string;
|
|
27915
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27916
|
+
message: string;
|
|
27917
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27918
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
27919
|
+
} | {
|
|
27920
|
+
/** Date and time at which Seam created the warning. */
|
|
27921
|
+
created_at: string;
|
|
27922
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27923
|
+
message: string;
|
|
27924
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
27925
|
+
warning_code: 'needs_to_be_reissued';
|
|
27926
|
+
}>;
|
|
27927
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
27928
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
27929
|
+
/** 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. */
|
|
27930
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
27931
|
+
/** 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. */
|
|
27932
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
27933
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27934
|
+
visionline_metadata?: {
|
|
27935
|
+
card_function_type: 'guest' | 'staff';
|
|
27936
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
27937
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
27938
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
27939
|
+
is_valid?: boolean | undefined;
|
|
27940
|
+
auto_join?: boolean | undefined;
|
|
27941
|
+
card_id?: string | undefined;
|
|
27942
|
+
credential_id?: string | undefined;
|
|
27943
|
+
} | undefined;
|
|
27944
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27945
|
+
assa_abloy_vostio_metadata?: {
|
|
27946
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
27947
|
+
key_id?: string | undefined;
|
|
27948
|
+
key_issuing_request_id?: string | undefined;
|
|
27949
|
+
door_names?: string[] | undefined;
|
|
27950
|
+
endpoint_id?: string | undefined;
|
|
27951
|
+
} | undefined;
|
|
27952
|
+
is_managed: true;
|
|
27953
|
+
} | {
|
|
27954
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27955
|
+
acs_credential_id: string;
|
|
27956
|
+
/** 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. */
|
|
27957
|
+
acs_user_id?: string | undefined;
|
|
27958
|
+
acs_credential_pool_id?: string | undefined;
|
|
27959
|
+
/** 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). */
|
|
27960
|
+
acs_system_id: string;
|
|
27961
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27962
|
+
parent_acs_credential_id?: string | undefined;
|
|
27963
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27964
|
+
display_name: string;
|
|
27965
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27966
|
+
code?: (string | undefined) | null;
|
|
27967
|
+
/** 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. */
|
|
27968
|
+
is_one_time_use?: boolean | undefined;
|
|
27969
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27970
|
+
card_number?: (string | undefined) | null;
|
|
27971
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
27972
|
+
is_issued?: boolean | undefined;
|
|
27973
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
27974
|
+
issued_at?: (string | undefined) | null;
|
|
27975
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
27976
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
27977
|
+
/** 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`. */
|
|
27978
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
27979
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
27980
|
+
external_type_display_name?: string | undefined;
|
|
27981
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
27982
|
+
created_at: string;
|
|
27983
|
+
/** 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). */
|
|
27984
|
+
workspace_id: string;
|
|
27985
|
+
/** 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. */
|
|
27986
|
+
starts_at?: string | undefined;
|
|
27987
|
+
/** 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`. */
|
|
27988
|
+
ends_at?: string | undefined;
|
|
27989
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27990
|
+
errors: Array<{
|
|
27991
|
+
error_code: string;
|
|
27992
|
+
message: string;
|
|
27993
|
+
}>;
|
|
27994
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
27995
|
+
warnings: Array<{
|
|
27996
|
+
/** Date and time at which Seam created the warning. */
|
|
27997
|
+
created_at: string;
|
|
27998
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
27999
|
+
message: string;
|
|
28000
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
28001
|
+
warning_code: 'waiting_to_be_issued';
|
|
28002
|
+
} | {
|
|
28003
|
+
/** Date and time at which Seam created the warning. */
|
|
28004
|
+
created_at: string;
|
|
28005
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
28006
|
+
message: string;
|
|
28007
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
28008
|
+
warning_code: 'schedule_externally_modified';
|
|
28009
|
+
} | {
|
|
28010
|
+
/** Date and time at which Seam created the warning. */
|
|
28011
|
+
created_at: string;
|
|
28012
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
28013
|
+
message: string;
|
|
28014
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
28015
|
+
warning_code: 'schedule_modified';
|
|
28016
|
+
} | {
|
|
28017
|
+
/** Date and time at which Seam created the warning. */
|
|
28018
|
+
created_at: string;
|
|
28019
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
28020
|
+
message: string;
|
|
28021
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
28022
|
+
warning_code: 'being_deleted';
|
|
28023
|
+
} | {
|
|
28024
|
+
/** Date and time at which Seam created the warning. */
|
|
28025
|
+
created_at: string;
|
|
28026
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
28027
|
+
message: string;
|
|
28028
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
28029
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
28030
|
+
} | {
|
|
28031
|
+
/** Date and time at which Seam created the warning. */
|
|
28032
|
+
created_at: string;
|
|
28033
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
28034
|
+
message: string;
|
|
28035
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
28036
|
+
warning_code: 'needs_to_be_reissued';
|
|
28037
|
+
}>;
|
|
28038
|
+
/** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
28039
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
28040
|
+
/** 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. */
|
|
28041
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
28042
|
+
/** 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. */
|
|
28043
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
28044
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
28045
|
+
visionline_metadata?: {
|
|
28046
|
+
card_function_type: 'guest' | 'staff';
|
|
28047
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
28048
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
28049
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
28050
|
+
is_valid?: boolean | undefined;
|
|
28051
|
+
auto_join?: boolean | undefined;
|
|
28052
|
+
card_id?: string | undefined;
|
|
28053
|
+
credential_id?: string | undefined;
|
|
28054
|
+
} | undefined;
|
|
28055
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
28056
|
+
assa_abloy_vostio_metadata?: {
|
|
28057
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
28058
|
+
key_id?: string | undefined;
|
|
28059
|
+
key_issuing_request_id?: string | undefined;
|
|
28060
|
+
door_names?: string[] | undefined;
|
|
28061
|
+
endpoint_id?: string | undefined;
|
|
28062
|
+
} | undefined;
|
|
28063
|
+
is_managed: false;
|
|
28064
|
+
};
|
|
28065
|
+
} | {
|
|
28066
|
+
/** ID of the action attempt. */
|
|
28067
|
+
action_attempt_id: string;
|
|
28068
|
+
status: 'error';
|
|
28069
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28070
|
+
result: null;
|
|
28071
|
+
/** Type of action that the action attempt tracks. */
|
|
28072
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
28073
|
+
error: {
|
|
28074
|
+
/** Type of the error associated with the action attempt. */
|
|
28075
|
+
type: 'uncategorized_error';
|
|
28076
|
+
/** Message for the error associated with the action attempt. */
|
|
28077
|
+
message: string;
|
|
28078
|
+
} | {
|
|
28079
|
+
/** Type of the error associated with the action attempt. */
|
|
28080
|
+
type: 'action_attempt_expired';
|
|
28081
|
+
/** Message for the error associated with the action attempt. */
|
|
28082
|
+
message: string;
|
|
28083
|
+
} | {
|
|
28084
|
+
type: 'no_credential_on_encoder';
|
|
28085
|
+
message: string;
|
|
28086
|
+
} | {
|
|
28087
|
+
type: 'incompatible_card_format';
|
|
28088
|
+
message: string;
|
|
28089
|
+
} | {
|
|
28090
|
+
type: 'credential_cannot_be_reissued';
|
|
28091
|
+
message: string;
|
|
28092
|
+
};
|
|
28093
|
+
} | {
|
|
28094
|
+
/** ID of the action attempt. */
|
|
28095
|
+
action_attempt_id: string;
|
|
28096
|
+
status: 'pending';
|
|
28097
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28098
|
+
result: null;
|
|
28099
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28100
|
+
error: null;
|
|
28101
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
28102
|
+
} | {
|
|
28103
|
+
/** ID of the action attempt. */
|
|
28104
|
+
action_attempt_id: string;
|
|
28105
|
+
status: 'success';
|
|
28106
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28107
|
+
error: null;
|
|
28108
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
28109
|
+
result: {};
|
|
28110
|
+
} | {
|
|
28111
|
+
/** ID of the action attempt. */
|
|
28112
|
+
action_attempt_id: string;
|
|
28113
|
+
status: 'error';
|
|
28114
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28115
|
+
result: null;
|
|
28116
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
28117
|
+
error: {
|
|
28118
|
+
type: string;
|
|
28119
|
+
message: string;
|
|
28120
|
+
};
|
|
28121
|
+
} | {
|
|
28122
|
+
/** ID of the action attempt. */
|
|
28123
|
+
action_attempt_id: string;
|
|
28124
|
+
status: 'pending';
|
|
28125
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28126
|
+
result: null;
|
|
28127
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28128
|
+
error: null;
|
|
28129
|
+
action_type: 'SET_FAN_MODE';
|
|
28130
|
+
} | {
|
|
28131
|
+
/** ID of the action attempt. */
|
|
28132
|
+
action_attempt_id: string;
|
|
28133
|
+
status: 'success';
|
|
28134
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28135
|
+
error: null;
|
|
28136
|
+
action_type: 'SET_FAN_MODE';
|
|
28137
|
+
result: {};
|
|
28138
|
+
} | {
|
|
28139
|
+
/** ID of the action attempt. */
|
|
28140
|
+
action_attempt_id: string;
|
|
28141
|
+
status: 'error';
|
|
28142
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28143
|
+
result: null;
|
|
28144
|
+
action_type: 'SET_FAN_MODE';
|
|
28145
|
+
error: {
|
|
28146
|
+
type: string;
|
|
28147
|
+
message: string;
|
|
28148
|
+
};
|
|
28149
|
+
} | {
|
|
28150
|
+
/** ID of the action attempt. */
|
|
28151
|
+
action_attempt_id: string;
|
|
28152
|
+
status: 'pending';
|
|
28153
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28154
|
+
result: null;
|
|
28155
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28156
|
+
error: null;
|
|
28157
|
+
action_type: 'SET_HVAC_MODE';
|
|
28158
|
+
} | {
|
|
28159
|
+
/** ID of the action attempt. */
|
|
28160
|
+
action_attempt_id: string;
|
|
28161
|
+
status: 'success';
|
|
28162
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28163
|
+
error: null;
|
|
28164
|
+
action_type: 'SET_HVAC_MODE';
|
|
28165
|
+
result: {};
|
|
28166
|
+
} | {
|
|
28167
|
+
/** ID of the action attempt. */
|
|
28168
|
+
action_attempt_id: string;
|
|
28169
|
+
status: 'error';
|
|
28170
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28171
|
+
result: null;
|
|
28172
|
+
action_type: 'SET_HVAC_MODE';
|
|
28173
|
+
error: {
|
|
28174
|
+
type: string;
|
|
28175
|
+
message: string;
|
|
28176
|
+
};
|
|
28177
|
+
} | {
|
|
28178
|
+
/** ID of the action attempt. */
|
|
28179
|
+
action_attempt_id: string;
|
|
28180
|
+
status: 'pending';
|
|
28181
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28182
|
+
result: null;
|
|
28183
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28184
|
+
error: null;
|
|
28185
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
28186
|
+
} | {
|
|
28187
|
+
/** ID of the action attempt. */
|
|
28188
|
+
action_attempt_id: string;
|
|
28189
|
+
status: 'success';
|
|
28190
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28191
|
+
error: null;
|
|
28192
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
28193
|
+
result: {};
|
|
28194
|
+
} | {
|
|
28195
|
+
/** ID of the action attempt. */
|
|
28196
|
+
action_attempt_id: string;
|
|
28197
|
+
status: 'error';
|
|
28198
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28199
|
+
result: null;
|
|
28200
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
28201
|
+
error: {
|
|
28202
|
+
type: string;
|
|
28203
|
+
message: string;
|
|
28204
|
+
};
|
|
28205
|
+
} | {
|
|
28206
|
+
/** ID of the action attempt. */
|
|
28207
|
+
action_attempt_id: string;
|
|
28208
|
+
status: 'pending';
|
|
28209
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28210
|
+
result: null;
|
|
28211
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28212
|
+
error: null;
|
|
28213
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
28214
|
+
} | {
|
|
28215
|
+
/** ID of the action attempt. */
|
|
28216
|
+
action_attempt_id: string;
|
|
28217
|
+
status: 'success';
|
|
28218
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28219
|
+
error: null;
|
|
28220
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
28221
|
+
result: {};
|
|
28222
|
+
} | {
|
|
28223
|
+
/** ID of the action attempt. */
|
|
28224
|
+
action_attempt_id: string;
|
|
28225
|
+
status: 'error';
|
|
28226
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28227
|
+
result: null;
|
|
28228
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
28229
|
+
error: {
|
|
28230
|
+
type: string;
|
|
28231
|
+
message: string;
|
|
28232
|
+
};
|
|
28233
|
+
} | {
|
|
28234
|
+
/** ID of the action attempt. */
|
|
28235
|
+
action_attempt_id: string;
|
|
28236
|
+
status: 'pending';
|
|
28237
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28238
|
+
result: null;
|
|
28239
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28240
|
+
error: null;
|
|
28241
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
28242
|
+
} | {
|
|
28243
|
+
/** ID of the action attempt. */
|
|
28244
|
+
action_attempt_id: string;
|
|
28245
|
+
status: 'success';
|
|
28246
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28247
|
+
error: null;
|
|
28248
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
28249
|
+
result: {};
|
|
28250
|
+
} | {
|
|
28251
|
+
/** ID of the action attempt. */
|
|
28252
|
+
action_attempt_id: string;
|
|
28253
|
+
status: 'error';
|
|
28254
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28255
|
+
result: null;
|
|
28256
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
28257
|
+
error: {
|
|
28258
|
+
type: string;
|
|
28259
|
+
message: string;
|
|
28260
|
+
};
|
|
28261
|
+
} | {
|
|
28262
|
+
/** ID of the action attempt. */
|
|
28263
|
+
action_attempt_id: string;
|
|
28264
|
+
status: 'pending';
|
|
28265
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28266
|
+
result: null;
|
|
28267
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28268
|
+
error: null;
|
|
28269
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
28270
|
+
} | {
|
|
28271
|
+
/** ID of the action attempt. */
|
|
28272
|
+
action_attempt_id: string;
|
|
28273
|
+
status: 'success';
|
|
28274
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28275
|
+
error: null;
|
|
28276
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
28277
|
+
result: {};
|
|
28278
|
+
} | {
|
|
28279
|
+
/** ID of the action attempt. */
|
|
28280
|
+
action_attempt_id: string;
|
|
28281
|
+
status: 'error';
|
|
28282
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28283
|
+
result: null;
|
|
28284
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
28285
|
+
error: {
|
|
28286
|
+
type: string;
|
|
28287
|
+
message: string;
|
|
28288
|
+
};
|
|
28289
|
+
} | {
|
|
28290
|
+
/** ID of the action attempt. */
|
|
28291
|
+
action_attempt_id: string;
|
|
28292
|
+
status: 'pending';
|
|
28293
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28294
|
+
result: null;
|
|
28295
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28296
|
+
error: null;
|
|
28297
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
28298
|
+
} | {
|
|
28299
|
+
/** ID of the action attempt. */
|
|
28300
|
+
action_attempt_id: string;
|
|
28301
|
+
status: 'success';
|
|
28302
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28303
|
+
error: null;
|
|
28304
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
28305
|
+
result: {
|
|
28306
|
+
access_code?: any;
|
|
28307
|
+
};
|
|
28308
|
+
} | {
|
|
28309
|
+
/** ID of the action attempt. */
|
|
28310
|
+
action_attempt_id: string;
|
|
28311
|
+
status: 'error';
|
|
28312
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28313
|
+
result: null;
|
|
28314
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
28315
|
+
error: {
|
|
28316
|
+
type: string;
|
|
28317
|
+
message: string;
|
|
28318
|
+
};
|
|
28319
|
+
} | {
|
|
28320
|
+
/** ID of the action attempt. */
|
|
28321
|
+
action_attempt_id: string;
|
|
28322
|
+
status: 'pending';
|
|
28323
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28324
|
+
result: null;
|
|
28325
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28326
|
+
error: null;
|
|
28327
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
28328
|
+
} | {
|
|
28329
|
+
/** ID of the action attempt. */
|
|
28330
|
+
action_attempt_id: string;
|
|
28331
|
+
status: 'success';
|
|
28332
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28333
|
+
error: null;
|
|
28334
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
28335
|
+
result: {};
|
|
28336
|
+
} | {
|
|
28337
|
+
/** ID of the action attempt. */
|
|
28338
|
+
action_attempt_id: string;
|
|
28339
|
+
status: 'error';
|
|
28340
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28341
|
+
result: null;
|
|
28342
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
28343
|
+
error: {
|
|
28344
|
+
type: string;
|
|
28345
|
+
message: string;
|
|
28346
|
+
};
|
|
28347
|
+
} | {
|
|
28348
|
+
/** ID of the action attempt. */
|
|
28349
|
+
action_attempt_id: string;
|
|
28350
|
+
status: 'pending';
|
|
28351
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28352
|
+
result: null;
|
|
28353
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28354
|
+
error: null;
|
|
28355
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
28356
|
+
} | {
|
|
28357
|
+
/** ID of the action attempt. */
|
|
28358
|
+
action_attempt_id: string;
|
|
28359
|
+
status: 'success';
|
|
28360
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28361
|
+
error: null;
|
|
28362
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
28363
|
+
result: {
|
|
28364
|
+
access_code?: any;
|
|
28365
|
+
};
|
|
28366
|
+
} | {
|
|
28367
|
+
/** ID of the action attempt. */
|
|
28368
|
+
action_attempt_id: string;
|
|
28369
|
+
status: 'error';
|
|
28370
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28371
|
+
result: null;
|
|
28372
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
28373
|
+
error: {
|
|
28374
|
+
type: string;
|
|
28375
|
+
message: string;
|
|
28376
|
+
};
|
|
28377
|
+
} | {
|
|
28378
|
+
/** ID of the action attempt. */
|
|
28379
|
+
action_attempt_id: string;
|
|
28380
|
+
status: 'pending';
|
|
28381
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28382
|
+
result: null;
|
|
28383
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28384
|
+
error: null;
|
|
28385
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
28386
|
+
} | {
|
|
28387
|
+
/** ID of the action attempt. */
|
|
28388
|
+
action_attempt_id: string;
|
|
28389
|
+
status: 'success';
|
|
28390
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28391
|
+
error: null;
|
|
28392
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
28393
|
+
result: {
|
|
28394
|
+
noise_threshold?: any;
|
|
28395
|
+
};
|
|
28396
|
+
} | {
|
|
28397
|
+
/** ID of the action attempt. */
|
|
28398
|
+
action_attempt_id: string;
|
|
28399
|
+
status: 'error';
|
|
28400
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28401
|
+
result: null;
|
|
28402
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
28403
|
+
error: {
|
|
28404
|
+
type: string;
|
|
28405
|
+
message: string;
|
|
28406
|
+
};
|
|
28407
|
+
} | {
|
|
28408
|
+
/** ID of the action attempt. */
|
|
28409
|
+
action_attempt_id: string;
|
|
28410
|
+
status: 'pending';
|
|
28411
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28412
|
+
result: null;
|
|
28413
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28414
|
+
error: null;
|
|
28415
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
28416
|
+
} | {
|
|
28417
|
+
/** ID of the action attempt. */
|
|
28418
|
+
action_attempt_id: string;
|
|
28419
|
+
status: 'success';
|
|
28420
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28421
|
+
error: null;
|
|
28422
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
28423
|
+
result: {};
|
|
28424
|
+
} | {
|
|
28425
|
+
/** ID of the action attempt. */
|
|
28426
|
+
action_attempt_id: string;
|
|
28427
|
+
status: 'error';
|
|
28428
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28429
|
+
result: null;
|
|
28430
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
28431
|
+
error: {
|
|
28432
|
+
type: string;
|
|
28433
|
+
message: string;
|
|
28434
|
+
};
|
|
28435
|
+
} | {
|
|
28436
|
+
/** ID of the action attempt. */
|
|
28437
|
+
action_attempt_id: string;
|
|
28438
|
+
status: 'pending';
|
|
28439
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28440
|
+
result: null;
|
|
28441
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28442
|
+
error: null;
|
|
28443
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
28444
|
+
} | {
|
|
28445
|
+
/** ID of the action attempt. */
|
|
28446
|
+
action_attempt_id: string;
|
|
28447
|
+
status: 'success';
|
|
28448
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28449
|
+
error: null;
|
|
28450
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
28451
|
+
result: {
|
|
28452
|
+
noise_threshold?: any;
|
|
28453
|
+
};
|
|
28454
|
+
} | {
|
|
28455
|
+
/** ID of the action attempt. */
|
|
28456
|
+
action_attempt_id: string;
|
|
28457
|
+
status: 'error';
|
|
28458
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28459
|
+
result: null;
|
|
28460
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
28461
|
+
error: {
|
|
28462
|
+
type: string;
|
|
28463
|
+
message: string;
|
|
28464
|
+
};
|
|
28465
|
+
};
|
|
28466
|
+
};
|
|
28467
|
+
};
|
|
28468
|
+
'/networks/get': {
|
|
28469
|
+
route: '/networks/get';
|
|
28470
|
+
method: 'GET' | 'POST';
|
|
28471
|
+
queryParams: {};
|
|
28472
|
+
jsonBody: {};
|
|
28473
|
+
commonParams: {
|
|
28474
|
+
network_id: string;
|
|
28475
|
+
};
|
|
28476
|
+
formData: {};
|
|
28477
|
+
jsonResponse: {
|
|
28478
|
+
/** */
|
|
28479
|
+
network: {
|
|
28480
|
+
network_id: string;
|
|
28481
|
+
workspace_id: string;
|
|
28482
|
+
display_name: string;
|
|
28483
|
+
created_at: string;
|
|
28484
|
+
};
|
|
28485
|
+
};
|
|
28486
|
+
};
|
|
28487
|
+
'/networks/list': {
|
|
28488
|
+
route: '/networks/list';
|
|
28489
|
+
method: 'GET' | 'POST';
|
|
28490
|
+
queryParams: {};
|
|
28491
|
+
jsonBody: {};
|
|
28492
|
+
commonParams: {};
|
|
28493
|
+
formData: {};
|
|
28494
|
+
jsonResponse: {
|
|
28495
|
+
networks: Array<{
|
|
28496
|
+
network_id: string;
|
|
28497
|
+
workspace_id: string;
|
|
28498
|
+
display_name: string;
|
|
28499
|
+
created_at: string;
|
|
28500
|
+
}>;
|
|
28501
|
+
};
|
|
28502
|
+
};
|
|
28503
|
+
'/noise_sensors/list': {
|
|
28504
|
+
route: '/noise_sensors/list';
|
|
28505
|
+
method: 'GET' | 'POST';
|
|
28506
|
+
queryParams: {};
|
|
28507
|
+
jsonBody: {};
|
|
28508
|
+
commonParams: {
|
|
28509
|
+
/** ID of the connected account by which to filter. */
|
|
28510
|
+
connected_account_id?: string | undefined;
|
|
28511
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
28512
|
+
connected_account_ids?: string[] | undefined;
|
|
28513
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
28514
|
+
connect_webview_id?: string | undefined;
|
|
28515
|
+
/** Device type by which to filter devices. */
|
|
28516
|
+
device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
|
|
28517
|
+
/** Array of device types by which to filter devices. */
|
|
28518
|
+
device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
|
|
28519
|
+
/** Manufacturer by which to filter devices. */
|
|
28520
|
+
manufacturer?: ('noiseaware' | 'minut') | undefined;
|
|
28521
|
+
/** Array of device IDs by which to filter devices. */
|
|
28522
|
+
device_ids?: string[] | undefined;
|
|
28523
|
+
/** Numerical limit on the number of devices to return. */
|
|
28524
|
+
limit?: number;
|
|
28525
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
28526
|
+
created_before?: Date | undefined;
|
|
28527
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
28528
|
+
user_identifier_key?: string | undefined;
|
|
28529
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
|
|
28530
|
+
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
28531
|
+
/** */
|
|
28532
|
+
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
28533
|
+
/** */
|
|
28534
|
+
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
28535
|
+
/** */
|
|
28536
|
+
unstable_location_id?: (string | null) | undefined;
|
|
28537
|
+
};
|
|
28538
|
+
formData: {};
|
|
28539
|
+
jsonResponse: {
|
|
28540
|
+
noise_sensors: Array<{
|
|
28541
|
+
/** Unique identifier for the device. */
|
|
28542
|
+
device_id: string;
|
|
28543
|
+
/** Type of the device. */
|
|
28544
|
+
device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat') | ('ios_phone' | 'android_phone');
|
|
28545
|
+
/** Optional nickname to describe the device, settable through Seam */
|
|
28546
|
+
nickname?: string | undefined;
|
|
28547
|
+
/** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
28548
|
+
display_name: string;
|
|
28549
|
+
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
28550
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
28551
|
+
/** Properties of the device. */
|
|
28552
|
+
properties: (({
|
|
28553
|
+
/** Indicates whether the device is online. */
|
|
28554
|
+
online: boolean;
|
|
28555
|
+
/** Name of the device.
|
|
28556
|
+
* @deprecated use device.display_name instead */
|
|
28557
|
+
name: string;
|
|
28558
|
+
/** Represents the accessory keypad state. */
|
|
28559
|
+
accessory_keypad?: {
|
|
28560
|
+
/** Indicates if the accessory_keypad is connected to the device. */
|
|
28561
|
+
is_connected: boolean;
|
|
28562
|
+
/** Indicates if the keypad battery properties. */
|
|
28563
|
+
battery?: {
|
|
28564
|
+
level: number;
|
|
28565
|
+
} | undefined;
|
|
28566
|
+
} | undefined;
|
|
28567
|
+
appearance: {
|
|
28568
|
+
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
28569
|
+
name: string;
|
|
28570
|
+
};
|
|
28571
|
+
model: {
|
|
28572
|
+
/** Indicates whether the device can connect a accessory keypad. */
|
|
28573
|
+
can_connect_accessory_keypad?: boolean | undefined;
|
|
28574
|
+
/** Display name of the device model. */
|
|
28575
|
+
display_name: string;
|
|
28576
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
28577
|
+
manufacturer_display_name: string;
|
|
28578
|
+
/** Indicates whether the device has a built in accessory keypad. */
|
|
28579
|
+
has_built_in_keypad?: boolean | undefined;
|
|
28580
|
+
/** Indicates whether the device supports offline access codes. */
|
|
28581
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
28582
|
+
/** Indicates whether the device supports online access codes. */
|
|
28583
|
+
online_access_codes_supported?: boolean | undefined;
|
|
28584
|
+
/**
|
|
28585
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
28586
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
28587
|
+
};
|
|
28588
|
+
/** Indicates whether the device has direct power. */
|
|
28589
|
+
has_direct_power?: boolean | undefined;
|
|
28590
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
28591
|
+
battery_level?: number | undefined;
|
|
28592
|
+
/** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
|
|
28593
|
+
battery?: {
|
|
28594
|
+
level: number;
|
|
28595
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
28596
|
+
} | undefined;
|
|
28597
|
+
/** Manufacturer of the device. */
|
|
28598
|
+
manufacturer?: string | undefined;
|
|
28599
|
+
/** Image URL for the device. */
|
|
28600
|
+
image_url?: string | undefined;
|
|
28601
|
+
/** Alt text for the device image. */
|
|
28602
|
+
image_alt_text?: string | undefined;
|
|
28603
|
+
/** Serial number of the device. */
|
|
28604
|
+
serial_number?: string | undefined;
|
|
28605
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
28606
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
28607
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
28608
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
28609
|
+
/**
|
|
28610
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
28611
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
28612
|
+
/**
|
|
28613
|
+
* @deprecated use offline_access_codes_enabled */
|
|
28614
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
28615
|
+
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
28616
|
+
noise_level_decibels?: number | undefined;
|
|
28617
|
+
/** Array of noise threshold IDs that are currently triggering. */
|
|
28618
|
+
currently_triggering_noise_threshold_ids?: string[] | undefined;
|
|
28619
|
+
} & {
|
|
28620
|
+
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
28621
|
+
assa_abloy_credential_service_metadata?: ({
|
|
28622
|
+
/** Indicates whether the credential service has active endpoints associated with the phone. */
|
|
28623
|
+
has_active_endpoint: boolean;
|
|
28624
|
+
/** Endpoints associated with the phone. */
|
|
28625
|
+
endpoints: Array<{
|
|
28626
|
+
/** ID of the associated endpoint. */
|
|
28627
|
+
endpoint_id: string;
|
|
28628
|
+
/** Indicated whether the endpoint is active. */
|
|
28629
|
+
is_active: boolean;
|
|
28630
|
+
}>;
|
|
28631
|
+
} | undefined) | undefined;
|
|
28632
|
+
/** Salto Space credential service metadata for the phone. */
|
|
28633
|
+
salto_space_credential_service_metadata?: ({
|
|
28634
|
+
/** Indicates whether the credential service has an active associated phone. */
|
|
28635
|
+
has_active_phone: boolean;
|
|
28636
|
+
} | undefined) | undefined;
|
|
28637
|
+
}) & {
|
|
26065
28638
|
august_metadata?: {
|
|
26066
28639
|
lock_id: string;
|
|
26067
28640
|
lock_name: string;
|
|
@@ -28131,6 +30704,62 @@ export interface Routes {
|
|
|
28131
30704
|
type: string;
|
|
28132
30705
|
message: string;
|
|
28133
30706
|
};
|
|
30707
|
+
} | {
|
|
30708
|
+
/** ID of the action attempt. */
|
|
30709
|
+
action_attempt_id: string;
|
|
30710
|
+
status: 'pending';
|
|
30711
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
30712
|
+
result: null;
|
|
30713
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
30714
|
+
error: null;
|
|
30715
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
30716
|
+
} | {
|
|
30717
|
+
/** ID of the action attempt. */
|
|
30718
|
+
action_attempt_id: string;
|
|
30719
|
+
status: 'success';
|
|
30720
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
30721
|
+
error: null;
|
|
30722
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
30723
|
+
result: {};
|
|
30724
|
+
} | {
|
|
30725
|
+
/** ID of the action attempt. */
|
|
30726
|
+
action_attempt_id: string;
|
|
30727
|
+
status: 'error';
|
|
30728
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
30729
|
+
result: null;
|
|
30730
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
30731
|
+
error: {
|
|
30732
|
+
type: string;
|
|
30733
|
+
message: string;
|
|
30734
|
+
};
|
|
30735
|
+
} | {
|
|
30736
|
+
/** ID of the action attempt. */
|
|
30737
|
+
action_attempt_id: string;
|
|
30738
|
+
status: 'pending';
|
|
30739
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
30740
|
+
result: null;
|
|
30741
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
30742
|
+
error: null;
|
|
30743
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
30744
|
+
} | {
|
|
30745
|
+
/** ID of the action attempt. */
|
|
30746
|
+
action_attempt_id: string;
|
|
30747
|
+
status: 'success';
|
|
30748
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
30749
|
+
error: null;
|
|
30750
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
30751
|
+
result: {};
|
|
30752
|
+
} | {
|
|
30753
|
+
/** ID of the action attempt. */
|
|
30754
|
+
action_attempt_id: string;
|
|
30755
|
+
status: 'error';
|
|
30756
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
30757
|
+
result: null;
|
|
30758
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
30759
|
+
error: {
|
|
30760
|
+
type: string;
|
|
30761
|
+
message: string;
|
|
30762
|
+
};
|
|
28134
30763
|
} | {
|
|
28135
30764
|
/** ID of the action attempt. */
|
|
28136
30765
|
action_attempt_id: string;
|
|
@@ -29105,6 +31734,62 @@ export interface Routes {
|
|
|
29105
31734
|
type: string;
|
|
29106
31735
|
message: string;
|
|
29107
31736
|
};
|
|
31737
|
+
} | {
|
|
31738
|
+
/** ID of the action attempt. */
|
|
31739
|
+
action_attempt_id: string;
|
|
31740
|
+
status: 'pending';
|
|
31741
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
31742
|
+
result: null;
|
|
31743
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
31744
|
+
error: null;
|
|
31745
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
31746
|
+
} | {
|
|
31747
|
+
/** ID of the action attempt. */
|
|
31748
|
+
action_attempt_id: string;
|
|
31749
|
+
status: 'success';
|
|
31750
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
31751
|
+
error: null;
|
|
31752
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
31753
|
+
result: {};
|
|
31754
|
+
} | {
|
|
31755
|
+
/** ID of the action attempt. */
|
|
31756
|
+
action_attempt_id: string;
|
|
31757
|
+
status: 'error';
|
|
31758
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
31759
|
+
result: null;
|
|
31760
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
31761
|
+
error: {
|
|
31762
|
+
type: string;
|
|
31763
|
+
message: string;
|
|
31764
|
+
};
|
|
31765
|
+
} | {
|
|
31766
|
+
/** ID of the action attempt. */
|
|
31767
|
+
action_attempt_id: string;
|
|
31768
|
+
status: 'pending';
|
|
31769
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
31770
|
+
result: null;
|
|
31771
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
31772
|
+
error: null;
|
|
31773
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
31774
|
+
} | {
|
|
31775
|
+
/** ID of the action attempt. */
|
|
31776
|
+
action_attempt_id: string;
|
|
31777
|
+
status: 'success';
|
|
31778
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
31779
|
+
error: null;
|
|
31780
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
31781
|
+
result: {};
|
|
31782
|
+
} | {
|
|
31783
|
+
/** ID of the action attempt. */
|
|
31784
|
+
action_attempt_id: string;
|
|
31785
|
+
status: 'error';
|
|
31786
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
31787
|
+
result: null;
|
|
31788
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
31789
|
+
error: {
|
|
31790
|
+
type: string;
|
|
31791
|
+
message: string;
|
|
31792
|
+
};
|
|
29108
31793
|
} | {
|
|
29109
31794
|
/** ID of the action attempt. */
|
|
29110
31795
|
action_attempt_id: string;
|
|
@@ -30118,6 +32803,62 @@ export interface Routes {
|
|
|
30118
32803
|
type: string;
|
|
30119
32804
|
message: string;
|
|
30120
32805
|
};
|
|
32806
|
+
} | {
|
|
32807
|
+
/** ID of the action attempt. */
|
|
32808
|
+
action_attempt_id: string;
|
|
32809
|
+
status: 'pending';
|
|
32810
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
32811
|
+
result: null;
|
|
32812
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
32813
|
+
error: null;
|
|
32814
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
32815
|
+
} | {
|
|
32816
|
+
/** ID of the action attempt. */
|
|
32817
|
+
action_attempt_id: string;
|
|
32818
|
+
status: 'success';
|
|
32819
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
32820
|
+
error: null;
|
|
32821
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
32822
|
+
result: {};
|
|
32823
|
+
} | {
|
|
32824
|
+
/** ID of the action attempt. */
|
|
32825
|
+
action_attempt_id: string;
|
|
32826
|
+
status: 'error';
|
|
32827
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
32828
|
+
result: null;
|
|
32829
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
32830
|
+
error: {
|
|
32831
|
+
type: string;
|
|
32832
|
+
message: string;
|
|
32833
|
+
};
|
|
32834
|
+
} | {
|
|
32835
|
+
/** ID of the action attempt. */
|
|
32836
|
+
action_attempt_id: string;
|
|
32837
|
+
status: 'pending';
|
|
32838
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
32839
|
+
result: null;
|
|
32840
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
32841
|
+
error: null;
|
|
32842
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
32843
|
+
} | {
|
|
32844
|
+
/** ID of the action attempt. */
|
|
32845
|
+
action_attempt_id: string;
|
|
32846
|
+
status: 'success';
|
|
32847
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
32848
|
+
error: null;
|
|
32849
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
32850
|
+
result: {};
|
|
32851
|
+
} | {
|
|
32852
|
+
/** ID of the action attempt. */
|
|
32853
|
+
action_attempt_id: string;
|
|
32854
|
+
status: 'error';
|
|
32855
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
32856
|
+
result: null;
|
|
32857
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
32858
|
+
error: {
|
|
32859
|
+
type: string;
|
|
32860
|
+
message: string;
|
|
32861
|
+
};
|
|
30121
32862
|
} | {
|
|
30122
32863
|
/** ID of the action attempt. */
|
|
30123
32864
|
action_attempt_id: string;
|
|
@@ -30781,6 +33522,32 @@ export interface Routes {
|
|
|
30781
33522
|
}>;
|
|
30782
33523
|
};
|
|
30783
33524
|
};
|
|
33525
|
+
'/seam/instant_key/v1/client_sessions/exchange_short_code': {
|
|
33526
|
+
route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
|
|
33527
|
+
method: 'POST';
|
|
33528
|
+
queryParams: {};
|
|
33529
|
+
jsonBody: {
|
|
33530
|
+
/** The short code to exchange for a client session token */
|
|
33531
|
+
short_code: string;
|
|
33532
|
+
};
|
|
33533
|
+
commonParams: {};
|
|
33534
|
+
formData: {};
|
|
33535
|
+
jsonResponse: {
|
|
33536
|
+
/** */
|
|
33537
|
+
client_session: {
|
|
33538
|
+
client_session_id: string;
|
|
33539
|
+
workspace_id: string;
|
|
33540
|
+
created_at: string;
|
|
33541
|
+
expires_at: string;
|
|
33542
|
+
token: string;
|
|
33543
|
+
user_identifier_key: string | null;
|
|
33544
|
+
device_count: number;
|
|
33545
|
+
connected_account_ids: string[];
|
|
33546
|
+
connect_webview_ids: string[];
|
|
33547
|
+
user_identity_ids: string[];
|
|
33548
|
+
};
|
|
33549
|
+
};
|
|
33550
|
+
};
|
|
30784
33551
|
'/thermostats/activate_climate_preset': {
|
|
30785
33552
|
route: '/thermostats/activate_climate_preset';
|
|
30786
33553
|
method: 'POST';
|
|
@@ -31539,6 +34306,62 @@ export interface Routes {
|
|
|
31539
34306
|
type: string;
|
|
31540
34307
|
message: string;
|
|
31541
34308
|
};
|
|
34309
|
+
} | {
|
|
34310
|
+
/** ID of the action attempt. */
|
|
34311
|
+
action_attempt_id: string;
|
|
34312
|
+
status: 'pending';
|
|
34313
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
34314
|
+
result: null;
|
|
34315
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
34316
|
+
error: null;
|
|
34317
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
34318
|
+
} | {
|
|
34319
|
+
/** ID of the action attempt. */
|
|
34320
|
+
action_attempt_id: string;
|
|
34321
|
+
status: 'success';
|
|
34322
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
34323
|
+
error: null;
|
|
34324
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
34325
|
+
result: {};
|
|
34326
|
+
} | {
|
|
34327
|
+
/** ID of the action attempt. */
|
|
34328
|
+
action_attempt_id: string;
|
|
34329
|
+
status: 'error';
|
|
34330
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
34331
|
+
result: null;
|
|
34332
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
34333
|
+
error: {
|
|
34334
|
+
type: string;
|
|
34335
|
+
message: string;
|
|
34336
|
+
};
|
|
34337
|
+
} | {
|
|
34338
|
+
/** ID of the action attempt. */
|
|
34339
|
+
action_attempt_id: string;
|
|
34340
|
+
status: 'pending';
|
|
34341
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
34342
|
+
result: null;
|
|
34343
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
34344
|
+
error: null;
|
|
34345
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
34346
|
+
} | {
|
|
34347
|
+
/** ID of the action attempt. */
|
|
34348
|
+
action_attempt_id: string;
|
|
34349
|
+
status: 'success';
|
|
34350
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
34351
|
+
error: null;
|
|
34352
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
34353
|
+
result: {};
|
|
34354
|
+
} | {
|
|
34355
|
+
/** ID of the action attempt. */
|
|
34356
|
+
action_attempt_id: string;
|
|
34357
|
+
status: 'error';
|
|
34358
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
34359
|
+
result: null;
|
|
34360
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
34361
|
+
error: {
|
|
34362
|
+
type: string;
|
|
34363
|
+
message: string;
|
|
34364
|
+
};
|
|
31542
34365
|
} | {
|
|
31543
34366
|
/** ID of the action attempt. */
|
|
31544
34367
|
action_attempt_id: string;
|
|
@@ -32508,6 +35331,62 @@ export interface Routes {
|
|
|
32508
35331
|
type: string;
|
|
32509
35332
|
message: string;
|
|
32510
35333
|
};
|
|
35334
|
+
} | {
|
|
35335
|
+
/** ID of the action attempt. */
|
|
35336
|
+
action_attempt_id: string;
|
|
35337
|
+
status: 'pending';
|
|
35338
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
35339
|
+
result: null;
|
|
35340
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
35341
|
+
error: null;
|
|
35342
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
35343
|
+
} | {
|
|
35344
|
+
/** ID of the action attempt. */
|
|
35345
|
+
action_attempt_id: string;
|
|
35346
|
+
status: 'success';
|
|
35347
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
35348
|
+
error: null;
|
|
35349
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
35350
|
+
result: {};
|
|
35351
|
+
} | {
|
|
35352
|
+
/** ID of the action attempt. */
|
|
35353
|
+
action_attempt_id: string;
|
|
35354
|
+
status: 'error';
|
|
35355
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
35356
|
+
result: null;
|
|
35357
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
35358
|
+
error: {
|
|
35359
|
+
type: string;
|
|
35360
|
+
message: string;
|
|
35361
|
+
};
|
|
35362
|
+
} | {
|
|
35363
|
+
/** ID of the action attempt. */
|
|
35364
|
+
action_attempt_id: string;
|
|
35365
|
+
status: 'pending';
|
|
35366
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
35367
|
+
result: null;
|
|
35368
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
35369
|
+
error: null;
|
|
35370
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
35371
|
+
} | {
|
|
35372
|
+
/** ID of the action attempt. */
|
|
35373
|
+
action_attempt_id: string;
|
|
35374
|
+
status: 'success';
|
|
35375
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
35376
|
+
error: null;
|
|
35377
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
35378
|
+
result: {};
|
|
35379
|
+
} | {
|
|
35380
|
+
/** ID of the action attempt. */
|
|
35381
|
+
action_attempt_id: string;
|
|
35382
|
+
status: 'error';
|
|
35383
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
35384
|
+
result: null;
|
|
35385
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
35386
|
+
error: {
|
|
35387
|
+
type: string;
|
|
35388
|
+
message: string;
|
|
35389
|
+
};
|
|
32511
35390
|
} | {
|
|
32512
35391
|
/** ID of the action attempt. */
|
|
32513
35392
|
action_attempt_id: string;
|
|
@@ -34240,6 +37119,62 @@ export interface Routes {
|
|
|
34240
37119
|
type: string;
|
|
34241
37120
|
message: string;
|
|
34242
37121
|
};
|
|
37122
|
+
} | {
|
|
37123
|
+
/** ID of the action attempt. */
|
|
37124
|
+
action_attempt_id: string;
|
|
37125
|
+
status: 'pending';
|
|
37126
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
37127
|
+
result: null;
|
|
37128
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
37129
|
+
error: null;
|
|
37130
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
37131
|
+
} | {
|
|
37132
|
+
/** ID of the action attempt. */
|
|
37133
|
+
action_attempt_id: string;
|
|
37134
|
+
status: 'success';
|
|
37135
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
37136
|
+
error: null;
|
|
37137
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
37138
|
+
result: {};
|
|
37139
|
+
} | {
|
|
37140
|
+
/** ID of the action attempt. */
|
|
37141
|
+
action_attempt_id: string;
|
|
37142
|
+
status: 'error';
|
|
37143
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
37144
|
+
result: null;
|
|
37145
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
37146
|
+
error: {
|
|
37147
|
+
type: string;
|
|
37148
|
+
message: string;
|
|
37149
|
+
};
|
|
37150
|
+
} | {
|
|
37151
|
+
/** ID of the action attempt. */
|
|
37152
|
+
action_attempt_id: string;
|
|
37153
|
+
status: 'pending';
|
|
37154
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
37155
|
+
result: null;
|
|
37156
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
37157
|
+
error: null;
|
|
37158
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
37159
|
+
} | {
|
|
37160
|
+
/** ID of the action attempt. */
|
|
37161
|
+
action_attempt_id: string;
|
|
37162
|
+
status: 'success';
|
|
37163
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
37164
|
+
error: null;
|
|
37165
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
37166
|
+
result: {};
|
|
37167
|
+
} | {
|
|
37168
|
+
/** ID of the action attempt. */
|
|
37169
|
+
action_attempt_id: string;
|
|
37170
|
+
status: 'error';
|
|
37171
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
37172
|
+
result: null;
|
|
37173
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
37174
|
+
error: {
|
|
37175
|
+
type: string;
|
|
37176
|
+
message: string;
|
|
37177
|
+
};
|
|
34243
37178
|
} | {
|
|
34244
37179
|
/** ID of the action attempt. */
|
|
34245
37180
|
action_attempt_id: string;
|
|
@@ -35213,6 +38148,62 @@ export interface Routes {
|
|
|
35213
38148
|
type: string;
|
|
35214
38149
|
message: string;
|
|
35215
38150
|
};
|
|
38151
|
+
} | {
|
|
38152
|
+
/** ID of the action attempt. */
|
|
38153
|
+
action_attempt_id: string;
|
|
38154
|
+
status: 'pending';
|
|
38155
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
38156
|
+
result: null;
|
|
38157
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
38158
|
+
error: null;
|
|
38159
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
38160
|
+
} | {
|
|
38161
|
+
/** ID of the action attempt. */
|
|
38162
|
+
action_attempt_id: string;
|
|
38163
|
+
status: 'success';
|
|
38164
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
38165
|
+
error: null;
|
|
38166
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
38167
|
+
result: {};
|
|
38168
|
+
} | {
|
|
38169
|
+
/** ID of the action attempt. */
|
|
38170
|
+
action_attempt_id: string;
|
|
38171
|
+
status: 'error';
|
|
38172
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
38173
|
+
result: null;
|
|
38174
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
38175
|
+
error: {
|
|
38176
|
+
type: string;
|
|
38177
|
+
message: string;
|
|
38178
|
+
};
|
|
38179
|
+
} | {
|
|
38180
|
+
/** ID of the action attempt. */
|
|
38181
|
+
action_attempt_id: string;
|
|
38182
|
+
status: 'pending';
|
|
38183
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
38184
|
+
result: null;
|
|
38185
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
38186
|
+
error: null;
|
|
38187
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
38188
|
+
} | {
|
|
38189
|
+
/** ID of the action attempt. */
|
|
38190
|
+
action_attempt_id: string;
|
|
38191
|
+
status: 'success';
|
|
38192
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
38193
|
+
error: null;
|
|
38194
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
38195
|
+
result: {};
|
|
38196
|
+
} | {
|
|
38197
|
+
/** ID of the action attempt. */
|
|
38198
|
+
action_attempt_id: string;
|
|
38199
|
+
status: 'error';
|
|
38200
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
38201
|
+
result: null;
|
|
38202
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
38203
|
+
error: {
|
|
38204
|
+
type: string;
|
|
38205
|
+
message: string;
|
|
38206
|
+
};
|
|
35216
38207
|
} | {
|
|
35217
38208
|
/** ID of the action attempt. */
|
|
35218
38209
|
action_attempt_id: string;
|
|
@@ -37621,6 +40612,62 @@ export interface Routes {
|
|
|
37621
40612
|
type: string;
|
|
37622
40613
|
message: string;
|
|
37623
40614
|
};
|
|
40615
|
+
} | {
|
|
40616
|
+
/** ID of the action attempt. */
|
|
40617
|
+
action_attempt_id: string;
|
|
40618
|
+
status: 'pending';
|
|
40619
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
40620
|
+
result: null;
|
|
40621
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
40622
|
+
error: null;
|
|
40623
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
40624
|
+
} | {
|
|
40625
|
+
/** ID of the action attempt. */
|
|
40626
|
+
action_attempt_id: string;
|
|
40627
|
+
status: 'success';
|
|
40628
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
40629
|
+
error: null;
|
|
40630
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
40631
|
+
result: {};
|
|
40632
|
+
} | {
|
|
40633
|
+
/** ID of the action attempt. */
|
|
40634
|
+
action_attempt_id: string;
|
|
40635
|
+
status: 'error';
|
|
40636
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
40637
|
+
result: null;
|
|
40638
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
40639
|
+
error: {
|
|
40640
|
+
type: string;
|
|
40641
|
+
message: string;
|
|
40642
|
+
};
|
|
40643
|
+
} | {
|
|
40644
|
+
/** ID of the action attempt. */
|
|
40645
|
+
action_attempt_id: string;
|
|
40646
|
+
status: 'pending';
|
|
40647
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
40648
|
+
result: null;
|
|
40649
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
40650
|
+
error: null;
|
|
40651
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
40652
|
+
} | {
|
|
40653
|
+
/** ID of the action attempt. */
|
|
40654
|
+
action_attempt_id: string;
|
|
40655
|
+
status: 'success';
|
|
40656
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
40657
|
+
error: null;
|
|
40658
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
40659
|
+
result: {};
|
|
40660
|
+
} | {
|
|
40661
|
+
/** ID of the action attempt. */
|
|
40662
|
+
action_attempt_id: string;
|
|
40663
|
+
status: 'error';
|
|
40664
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
40665
|
+
result: null;
|
|
40666
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
40667
|
+
error: {
|
|
40668
|
+
type: string;
|
|
40669
|
+
message: string;
|
|
40670
|
+
};
|
|
37624
40671
|
} | {
|
|
37625
40672
|
/** ID of the action attempt. */
|
|
37626
40673
|
action_attempt_id: string;
|
|
@@ -38776,6 +41823,62 @@ export interface Routes {
|
|
|
38776
41823
|
type: string;
|
|
38777
41824
|
message: string;
|
|
38778
41825
|
};
|
|
41826
|
+
} | {
|
|
41827
|
+
/** ID of the action attempt. */
|
|
41828
|
+
action_attempt_id: string;
|
|
41829
|
+
status: 'pending';
|
|
41830
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
41831
|
+
result: null;
|
|
41832
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
41833
|
+
error: null;
|
|
41834
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
41835
|
+
} | {
|
|
41836
|
+
/** ID of the action attempt. */
|
|
41837
|
+
action_attempt_id: string;
|
|
41838
|
+
status: 'success';
|
|
41839
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
41840
|
+
error: null;
|
|
41841
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
41842
|
+
result: {};
|
|
41843
|
+
} | {
|
|
41844
|
+
/** ID of the action attempt. */
|
|
41845
|
+
action_attempt_id: string;
|
|
41846
|
+
status: 'error';
|
|
41847
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
41848
|
+
result: null;
|
|
41849
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
41850
|
+
error: {
|
|
41851
|
+
type: string;
|
|
41852
|
+
message: string;
|
|
41853
|
+
};
|
|
41854
|
+
} | {
|
|
41855
|
+
/** ID of the action attempt. */
|
|
41856
|
+
action_attempt_id: string;
|
|
41857
|
+
status: 'pending';
|
|
41858
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
41859
|
+
result: null;
|
|
41860
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
41861
|
+
error: null;
|
|
41862
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
41863
|
+
} | {
|
|
41864
|
+
/** ID of the action attempt. */
|
|
41865
|
+
action_attempt_id: string;
|
|
41866
|
+
status: 'success';
|
|
41867
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
41868
|
+
error: null;
|
|
41869
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
41870
|
+
result: {};
|
|
41871
|
+
} | {
|
|
41872
|
+
/** ID of the action attempt. */
|
|
41873
|
+
action_attempt_id: string;
|
|
41874
|
+
status: 'error';
|
|
41875
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
41876
|
+
result: null;
|
|
41877
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
41878
|
+
error: {
|
|
41879
|
+
type: string;
|
|
41880
|
+
message: string;
|
|
41881
|
+
};
|
|
38779
41882
|
} | {
|
|
38780
41883
|
/** ID of the action attempt. */
|
|
38781
41884
|
action_attempt_id: string;
|
|
@@ -39768,6 +42871,62 @@ export interface Routes {
|
|
|
39768
42871
|
type: string;
|
|
39769
42872
|
message: string;
|
|
39770
42873
|
};
|
|
42874
|
+
} | {
|
|
42875
|
+
/** ID of the action attempt. */
|
|
42876
|
+
action_attempt_id: string;
|
|
42877
|
+
status: 'pending';
|
|
42878
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
42879
|
+
result: null;
|
|
42880
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
42881
|
+
error: null;
|
|
42882
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
42883
|
+
} | {
|
|
42884
|
+
/** ID of the action attempt. */
|
|
42885
|
+
action_attempt_id: string;
|
|
42886
|
+
status: 'success';
|
|
42887
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
42888
|
+
error: null;
|
|
42889
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
42890
|
+
result: {};
|
|
42891
|
+
} | {
|
|
42892
|
+
/** ID of the action attempt. */
|
|
42893
|
+
action_attempt_id: string;
|
|
42894
|
+
status: 'error';
|
|
42895
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
42896
|
+
result: null;
|
|
42897
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
42898
|
+
error: {
|
|
42899
|
+
type: string;
|
|
42900
|
+
message: string;
|
|
42901
|
+
};
|
|
42902
|
+
} | {
|
|
42903
|
+
/** ID of the action attempt. */
|
|
42904
|
+
action_attempt_id: string;
|
|
42905
|
+
status: 'pending';
|
|
42906
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
42907
|
+
result: null;
|
|
42908
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
42909
|
+
error: null;
|
|
42910
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
42911
|
+
} | {
|
|
42912
|
+
/** ID of the action attempt. */
|
|
42913
|
+
action_attempt_id: string;
|
|
42914
|
+
status: 'success';
|
|
42915
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
42916
|
+
error: null;
|
|
42917
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
42918
|
+
result: {};
|
|
42919
|
+
} | {
|
|
42920
|
+
/** ID of the action attempt. */
|
|
42921
|
+
action_attempt_id: string;
|
|
42922
|
+
status: 'error';
|
|
42923
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
42924
|
+
result: null;
|
|
42925
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
42926
|
+
error: {
|
|
42927
|
+
type: string;
|
|
42928
|
+
message: string;
|
|
42929
|
+
};
|
|
39771
42930
|
} | {
|
|
39772
42931
|
/** ID of the action attempt. */
|
|
39773
42932
|
action_attempt_id: string;
|
|
@@ -40109,12 +43268,14 @@ export interface Routes {
|
|
|
40109
43268
|
location_ids?: string[] | undefined;
|
|
40110
43269
|
/** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
|
|
40111
43270
|
location?: {
|
|
43271
|
+
/** Name of the location. */
|
|
43272
|
+
name?: string | undefined;
|
|
40112
43273
|
/** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to add to the location to which access is being granted. */
|
|
40113
43274
|
acs_entrance_ids?: string[];
|
|
40114
43275
|
/** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to add to the location to which access is being granted. */
|
|
40115
43276
|
device_ids?: string[];
|
|
40116
43277
|
} | undefined;
|
|
40117
|
-
|
|
43278
|
+
requested_access_methods: Array<{
|
|
40118
43279
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
40119
43280
|
mode: 'code' | 'card' | 'mobile_key';
|
|
40120
43281
|
}>;
|
|
@@ -40143,9 +43304,11 @@ export interface Routes {
|
|
|
40143
43304
|
mode: 'code' | 'card' | 'mobile_key';
|
|
40144
43305
|
/** Date and time at which the requested access method was added to this access grant. */
|
|
40145
43306
|
created_at: string;
|
|
40146
|
-
/** IDs of the
|
|
40147
|
-
|
|
43307
|
+
/** IDs of the access methods that were created for this requested access method. */
|
|
43308
|
+
created_access_method_ids: string[];
|
|
40148
43309
|
}>;
|
|
43310
|
+
/** IDs of the access methods that were created for this access grant. */
|
|
43311
|
+
access_method_ids: string[];
|
|
40149
43312
|
/** Display name of the access grant. */
|
|
40150
43313
|
display_name: string;
|
|
40151
43314
|
/** Date and time at which the access grant was created. */
|
|
@@ -40182,9 +43345,11 @@ export interface Routes {
|
|
|
40182
43345
|
mode: 'code' | 'card' | 'mobile_key';
|
|
40183
43346
|
/** Date and time at which the requested access method was added to this access grant. */
|
|
40184
43347
|
created_at: string;
|
|
40185
|
-
/** IDs of the
|
|
40186
|
-
|
|
43348
|
+
/** IDs of the access methods that were created for this requested access method. */
|
|
43349
|
+
created_access_method_ids: string[];
|
|
40187
43350
|
}>;
|
|
43351
|
+
/** IDs of the access methods that were created for this access grant. */
|
|
43352
|
+
access_method_ids: string[];
|
|
40188
43353
|
/** Display name of the access grant. */
|
|
40189
43354
|
display_name: string;
|
|
40190
43355
|
/** Date and time at which the access grant was created. */
|
|
@@ -40226,9 +43391,11 @@ export interface Routes {
|
|
|
40226
43391
|
mode: 'code' | 'card' | 'mobile_key';
|
|
40227
43392
|
/** Date and time at which the requested access method was added to this access grant. */
|
|
40228
43393
|
created_at: string;
|
|
40229
|
-
/** IDs of the
|
|
40230
|
-
|
|
43394
|
+
/** IDs of the access methods that were created for this requested access method. */
|
|
43395
|
+
created_access_method_ids: string[];
|
|
40231
43396
|
}>;
|
|
43397
|
+
/** IDs of the access methods that were created for this access grant. */
|
|
43398
|
+
access_method_ids: string[];
|
|
40232
43399
|
/** Display name of the access grant. */
|
|
40233
43400
|
display_name: string;
|
|
40234
43401
|
/** Date and time at which the access grant was created. */
|
|
@@ -40236,8 +43403,8 @@ export interface Routes {
|
|
|
40236
43403
|
}>;
|
|
40237
43404
|
};
|
|
40238
43405
|
};
|
|
40239
|
-
'/
|
|
40240
|
-
route: '/
|
|
43406
|
+
'/unstable_access_methods/list': {
|
|
43407
|
+
route: '/unstable_access_methods/list';
|
|
40241
43408
|
method: 'GET' | 'POST';
|
|
40242
43409
|
queryParams: {};
|
|
40243
43410
|
jsonBody: {};
|
|
@@ -40593,6 +43760,8 @@ export interface Routes {
|
|
|
40593
43760
|
commonParams: {
|
|
40594
43761
|
/** ID of the user identity for which you want to generate an instant key. */
|
|
40595
43762
|
user_identity_id: string;
|
|
43763
|
+
/** The maximum number of times the instant key can be used. Defaults to 1. */
|
|
43764
|
+
max_use_count?: number;
|
|
40596
43765
|
};
|
|
40597
43766
|
formData: {};
|
|
40598
43767
|
jsonResponse: {
|
|
@@ -42545,10 +45714,24 @@ export interface Routes {
|
|
|
42545
45714
|
* @deprecated use company_name */
|
|
42546
45715
|
connect_partner_name?: ((string | null) | null) | undefined;
|
|
42547
45716
|
is_sandbox?: boolean;
|
|
45717
|
+
/**
|
|
45718
|
+
* @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
|
|
42548
45719
|
webview_primary_button_color?: string | undefined;
|
|
45720
|
+
/**
|
|
45721
|
+
* @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead. */
|
|
42549
45722
|
webview_primary_button_text_color?: string | undefined;
|
|
45723
|
+
/**
|
|
45724
|
+
* @deprecated Use `connect_webview_customization.webview_logo_shape` instead. */
|
|
42550
45725
|
webview_logo_shape?: ('circle' | 'square') | undefined;
|
|
45726
|
+
/**
|
|
45727
|
+
* @deprecated Use `connect_webview_customization.webview_success_message` instead. */
|
|
42551
45728
|
webview_success_message?: string | undefined;
|
|
45729
|
+
connect_webview_customization?: {
|
|
45730
|
+
primary_button_color?: (string | null) | undefined;
|
|
45731
|
+
primary_button_text_color?: (string | null) | undefined;
|
|
45732
|
+
success_message?: (string | null) | undefined;
|
|
45733
|
+
logo_shape?: (('circle' | 'square') | null) | undefined;
|
|
45734
|
+
} | undefined;
|
|
42552
45735
|
};
|
|
42553
45736
|
commonParams: {};
|
|
42554
45737
|
formData: {};
|
|
@@ -42559,6 +45742,13 @@ export interface Routes {
|
|
|
42559
45742
|
name: string;
|
|
42560
45743
|
company_name: string;
|
|
42561
45744
|
is_sandbox: boolean;
|
|
45745
|
+
connect_webview_customization: {
|
|
45746
|
+
primary_button_color?: string | undefined;
|
|
45747
|
+
primary_button_text_color?: string | undefined;
|
|
45748
|
+
success_message?: string | undefined;
|
|
45749
|
+
logo_shape?: ('circle' | 'square') | undefined;
|
|
45750
|
+
inviter_logo_url?: string | undefined;
|
|
45751
|
+
};
|
|
42562
45752
|
/** True if a sandbox workspace has not been accessed in 14 days */
|
|
42563
45753
|
is_suspended: boolean;
|
|
42564
45754
|
/**
|
|
@@ -42581,6 +45771,13 @@ export interface Routes {
|
|
|
42581
45771
|
name: string;
|
|
42582
45772
|
company_name: string;
|
|
42583
45773
|
is_sandbox: boolean;
|
|
45774
|
+
connect_webview_customization: {
|
|
45775
|
+
primary_button_color?: string | undefined;
|
|
45776
|
+
primary_button_text_color?: string | undefined;
|
|
45777
|
+
success_message?: string | undefined;
|
|
45778
|
+
logo_shape?: ('circle' | 'square') | undefined;
|
|
45779
|
+
inviter_logo_url?: string | undefined;
|
|
45780
|
+
};
|
|
42584
45781
|
/** True if a sandbox workspace has not been accessed in 14 days */
|
|
42585
45782
|
is_suspended: boolean;
|
|
42586
45783
|
/**
|
|
@@ -42602,6 +45799,13 @@ export interface Routes {
|
|
|
42602
45799
|
name: string;
|
|
42603
45800
|
company_name: string;
|
|
42604
45801
|
is_sandbox: boolean;
|
|
45802
|
+
connect_webview_customization: {
|
|
45803
|
+
primary_button_color?: string | undefined;
|
|
45804
|
+
primary_button_text_color?: string | undefined;
|
|
45805
|
+
success_message?: string | undefined;
|
|
45806
|
+
logo_shape?: ('circle' | 'square') | undefined;
|
|
45807
|
+
inviter_logo_url?: string | undefined;
|
|
45808
|
+
};
|
|
42605
45809
|
/** True if a sandbox workspace has not been accessed in 14 days */
|
|
42606
45810
|
is_suspended: boolean;
|
|
42607
45811
|
/**
|
|
@@ -43363,6 +46567,62 @@ export interface Routes {
|
|
|
43363
46567
|
type: string;
|
|
43364
46568
|
message: string;
|
|
43365
46569
|
};
|
|
46570
|
+
} | {
|
|
46571
|
+
/** ID of the action attempt. */
|
|
46572
|
+
action_attempt_id: string;
|
|
46573
|
+
status: 'pending';
|
|
46574
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
46575
|
+
result: null;
|
|
46576
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
46577
|
+
error: null;
|
|
46578
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
46579
|
+
} | {
|
|
46580
|
+
/** ID of the action attempt. */
|
|
46581
|
+
action_attempt_id: string;
|
|
46582
|
+
status: 'success';
|
|
46583
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
46584
|
+
error: null;
|
|
46585
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
46586
|
+
result: {};
|
|
46587
|
+
} | {
|
|
46588
|
+
/** ID of the action attempt. */
|
|
46589
|
+
action_attempt_id: string;
|
|
46590
|
+
status: 'error';
|
|
46591
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
46592
|
+
result: null;
|
|
46593
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
46594
|
+
error: {
|
|
46595
|
+
type: string;
|
|
46596
|
+
message: string;
|
|
46597
|
+
};
|
|
46598
|
+
} | {
|
|
46599
|
+
/** ID of the action attempt. */
|
|
46600
|
+
action_attempt_id: string;
|
|
46601
|
+
status: 'pending';
|
|
46602
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
46603
|
+
result: null;
|
|
46604
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
46605
|
+
error: null;
|
|
46606
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
46607
|
+
} | {
|
|
46608
|
+
/** ID of the action attempt. */
|
|
46609
|
+
action_attempt_id: string;
|
|
46610
|
+
status: 'success';
|
|
46611
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
46612
|
+
error: null;
|
|
46613
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
46614
|
+
result: {};
|
|
46615
|
+
} | {
|
|
46616
|
+
/** ID of the action attempt. */
|
|
46617
|
+
action_attempt_id: string;
|
|
46618
|
+
status: 'error';
|
|
46619
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
46620
|
+
result: null;
|
|
46621
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
46622
|
+
error: {
|
|
46623
|
+
type: string;
|
|
46624
|
+
message: string;
|
|
46625
|
+
};
|
|
43366
46626
|
} | {
|
|
43367
46627
|
/** ID of the action attempt. */
|
|
43368
46628
|
action_attempt_id: string;
|
|
@@ -43570,6 +46830,25 @@ export interface Routes {
|
|
|
43570
46830
|
};
|
|
43571
46831
|
};
|
|
43572
46832
|
};
|
|
46833
|
+
'/workspaces/update': {
|
|
46834
|
+
route: '/workspaces/update';
|
|
46835
|
+
method: 'POST' | 'PATCH';
|
|
46836
|
+
queryParams: {};
|
|
46837
|
+
jsonBody: {
|
|
46838
|
+
name?: string | undefined;
|
|
46839
|
+
connect_partner_name?: string | undefined;
|
|
46840
|
+
connect_webview_customization?: {
|
|
46841
|
+
primary_button_color?: (string | null) | undefined;
|
|
46842
|
+
primary_button_text_color?: (string | null) | undefined;
|
|
46843
|
+
success_message?: (string | null) | undefined;
|
|
46844
|
+
logo_shape?: (('circle' | 'square') | null) | undefined;
|
|
46845
|
+
} | undefined;
|
|
46846
|
+
is_suspended?: boolean | undefined;
|
|
46847
|
+
};
|
|
46848
|
+
commonParams: {};
|
|
46849
|
+
formData: {};
|
|
46850
|
+
jsonResponse: {};
|
|
46851
|
+
};
|
|
43573
46852
|
}
|
|
43574
46853
|
export type RouteResponse<Path extends keyof Routes> = Routes[Path]['jsonResponse'];
|
|
43575
46854
|
export type RouteRequestBody<Path extends keyof Routes> = Routes[Path]['jsonBody'] & Routes[Path]['commonParams'];
|